zmk-protocol 0.0.2-alpha.3

A protocol to interact with ZMK firmware
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

// @generated
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Request {
    #[prost(oneof="request::RequestType", tags="1, 2")]
    pub request_type: ::core::option::Option<request::RequestType>,
}
/// Nested message and enum types in `Request`.
pub mod request {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum RequestType {
        #[prost(bool, tag="1")]
        ListAllBehaviors(bool),
        #[prost(message, tag="2")]
        GetBehaviorDetails(super::GetBehaviorDetailsRequest),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetBehaviorDetailsRequest {
    #[prost(uint32, tag="1")]
    pub behavior_id: u32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Response {
    #[prost(oneof="response::ResponseType", tags="1, 2")]
    pub response_type: ::core::option::Option<response::ResponseType>,
}
/// Nested message and enum types in `Response`.
pub mod response {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum ResponseType {
        #[prost(message, tag="1")]
        ListAllBehaviors(super::ListAllBehaviorsResponse),
        #[prost(message, tag="2")]
        GetBehaviorDetails(super::GetBehaviorDetailsResponse),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAllBehaviorsResponse {
    #[prost(uint32, repeated, tag="1")]
    pub behaviors: ::prost::alloc::vec::Vec<u32>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetBehaviorDetailsResponse {
    #[prost(uint32, tag="1")]
    pub id: u32,
    #[prost(string, tag="2")]
    pub display_name: ::prost::alloc::string::String,
    #[prost(message, repeated, tag="3")]
    pub metadata: ::prost::alloc::vec::Vec<BehaviorBindingParametersSet>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorBindingParametersSet {
    #[prost(message, repeated, tag="1")]
    pub param1: ::prost::alloc::vec::Vec<BehaviorParameterValueDescription>,
    #[prost(message, repeated, tag="2")]
    pub param2: ::prost::alloc::vec::Vec<BehaviorParameterValueDescription>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorParameterValueDescriptionRange {
    #[prost(int32, tag="1")]
    pub min: i32,
    #[prost(int32, tag="2")]
    pub max: i32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorParameterNil {
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorParameterLayerIndex {
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorParameterHidUsage {
    #[prost(uint32, tag="1")]
    pub keyboard_max: u32,
    #[prost(uint32, tag="2")]
    pub consumer_max: u32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BehaviorParameterValueDescription {
    #[prost(string, tag="1")]
    pub name: ::prost::alloc::string::String,
    #[prost(oneof="behavior_parameter_value_description::ValueType", tags="2, 3, 4, 5, 6")]
    pub value_type: ::core::option::Option<behavior_parameter_value_description::ValueType>,
}
/// Nested message and enum types in `BehaviorParameterValueDescription`.
pub mod behavior_parameter_value_description {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum ValueType {
        #[prost(message, tag="2")]
        Nil(super::BehaviorParameterNil),
        #[prost(uint32, tag="3")]
        Constant(u32),
        #[prost(message, tag="4")]
        Range(super::BehaviorParameterValueDescriptionRange),
        #[prost(message, tag="5")]
        HidUsage(super::BehaviorParameterHidUsage),
        #[prost(message, tag="6")]
        LayerIndex(super::BehaviorParameterLayerIndex),
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum BehaviorBindingParameterStandardDomain {
    Nil = 0,
    HidUsage = 1,
    /// HSV_VALUE = 3;
    LayerIndex = 2,
}
impl BehaviorBindingParameterStandardDomain {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            BehaviorBindingParameterStandardDomain::Nil => "NIL",
            BehaviorBindingParameterStandardDomain::HidUsage => "HID_USAGE",
            BehaviorBindingParameterStandardDomain::LayerIndex => "LAYER_INDEX",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "NIL" => Some(Self::Nil),
            "HID_USAGE" => Some(Self::HidUsage),
            "LAYER_INDEX" => Some(Self::LayerIndex),
            _ => None,
        }
    }
}
// @@protoc_insertion_point(module)