Skip to main content

zigbee_ezsp/
ids.rs

1//! EZSP frame ids and the ids of configuration values, policies, decisions,
2//! values and manufacturing tokens, as Silicon Labs documents them (UG100
3//! and the EmberZNet `ezsp-enum.h`).
4
5/// Frame ids (commands, their responses, and callbacks).
6pub mod frame {
7    #![allow(missing_docs)]
8    pub const VERSION: u16 = 0x0000;
9    pub const ADD_ENDPOINT: u16 = 0x0002;
10    pub const NOP: u16 = 0x0005;
11    pub const NO_CALLBACKS: u16 = 0x0007;
12    pub const GET_MFG_TOKEN: u16 = 0x000B;
13    pub const SET_MFG_TOKEN: u16 = 0x000C;
14    pub const STACK_TOKEN_CHANGED_HANDLER: u16 = 0x000D;
15    pub const SET_CONCENTRATOR: u16 = 0x0010;
16    pub const SET_MANUFACTURER_CODE: u16 = 0x0015;
17    pub const NETWORK_INIT: u16 = 0x0017;
18    pub const NETWORK_STATE: u16 = 0x0018;
19    pub const STACK_STATUS_HANDLER: u16 = 0x0019;
20    pub const START_SCAN: u16 = 0x001A;
21    pub const NETWORK_FOUND_HANDLER: u16 = 0x001B;
22    pub const SCAN_COMPLETE_HANDLER: u16 = 0x001C;
23    pub const FORM_NETWORK: u16 = 0x001E;
24    pub const LEAVE_NETWORK: u16 = 0x0020;
25    pub const PERMIT_JOINING: u16 = 0x0022;
26    pub const CHILD_JOIN_HANDLER: u16 = 0x0023;
27    pub const TRUST_CENTER_JOIN_HANDLER: u16 = 0x0024;
28    pub const GET_EUI64: u16 = 0x0026;
29    pub const GET_NODE_ID: u16 = 0x0027;
30    pub const GET_NETWORK_PARAMETERS: u16 = 0x0028;
31    pub const SEND_UNICAST: u16 = 0x0034;
32    pub const SEND_BROADCAST: u16 = 0x0036;
33    pub const MESSAGE_SENT_HANDLER: u16 = 0x003F;
34    pub const INCOMING_MESSAGE_HANDLER: u16 = 0x0045;
35    pub const ENERGY_SCAN_RESULT_HANDLER: u16 = 0x0048;
36    pub const GET_CONFIGURATION_VALUE: u16 = 0x0052;
37    pub const SET_CONFIGURATION_VALUE: u16 = 0x0053;
38    pub const SET_POLICY: u16 = 0x0055;
39    pub const INVALID_COMMAND: u16 = 0x0058;
40    pub const INCOMING_ROUTE_RECORD_HANDLER: u16 = 0x0059;
41    pub const SET_SOURCE_ROUTE_DISCOVERY_MODE: u16 = 0x005A;
42    pub const LOOKUP_EUI64_BY_NODE_ID: u16 = 0x0061;
43    pub const SET_INITIAL_SECURITY_STATE: u16 = 0x0068;
44    /// Before protocol 13 only.
45    pub const GET_KEY: u16 = 0x006A;
46    pub const CLEAR_TRANSIENT_LINK_KEYS: u16 = 0x006B;
47    /// Before protocol 13 only.
48    pub const GET_KEY_TABLE_ENTRY: u16 = 0x0071;
49    /// Before protocol 13 only.
50    pub const SET_KEY_TABLE_ENTRY: u16 = 0x0072;
51    pub const ERASE_KEY_TABLE_ENTRY: u16 = 0x0076;
52    pub const ID_CONFLICT_HANDLER: u16 = 0x007C;
53    pub const INCOMING_MANY_TO_ONE_ROUTE_REQUEST_HANDLER: u16 = 0x007D;
54    pub const INCOMING_ROUTE_ERROR_HANDLER: u16 = 0x0080;
55    pub const ECHO: u16 = 0x0081;
56    pub const SET_RADIO_POWER: u16 = 0x0099;
57    pub const ZIGBEE_KEY_ESTABLISHMENT_HANDLER: u16 = 0x009B;
58    pub const GET_VALUE: u16 = 0x00AA;
59    pub const SET_VALUE: u16 = 0x00AB;
60    /// Before protocol 13 only.
61    pub const ADD_TRANSIENT_LINK_KEY: u16 = 0x00AF;
62    pub const CLEAR_KEY_TABLE: u16 = 0x00B1;
63    pub const INCOMING_NETWORK_STATUS_HANDLER: u16 = 0x00C4;
64    pub const IMPORT_LINK_KEY: u16 = 0x010E;
65    pub const EXPORT_LINK_KEY_BY_INDEX: u16 = 0x010F;
66    pub const IMPORT_TRANSIENT_KEY: u16 = 0x0111;
67    pub const EXPORT_KEY: u16 = 0x0114;
68    pub const GET_NETWORK_KEY_INFO: u16 = 0x0116;
69}
70
71/// Configuration ids (`setConfigurationValue`), set before the network starts.
72pub mod config {
73    #![allow(missing_docs)]
74    pub const PACKET_BUFFER_HEAP_SIZE: u8 = 0x01;
75    pub const NEIGHBOR_TABLE_SIZE: u8 = 0x02;
76    pub const APS_UNICAST_MESSAGE_COUNT: u8 = 0x03;
77    pub const BINDING_TABLE_SIZE: u8 = 0x04;
78    pub const ADDRESS_TABLE_SIZE: u8 = 0x05;
79    pub const MULTICAST_TABLE_SIZE: u8 = 0x06;
80    pub const ROUTE_TABLE_SIZE: u8 = 0x07;
81    pub const DISCOVERY_TABLE_SIZE: u8 = 0x08;
82    pub const STACK_PROFILE: u8 = 0x0C;
83    pub const SECURITY_LEVEL: u8 = 0x0D;
84    pub const MAX_HOPS: u8 = 0x10;
85    pub const MAX_END_DEVICE_CHILDREN: u8 = 0x11;
86    pub const INDIRECT_TRANSMISSION_TIMEOUT: u8 = 0x12;
87    pub const END_DEVICE_POLL_TIMEOUT: u8 = 0x13;
88    pub const TRUST_CENTER_ADDRESS_CACHE_SIZE: u8 = 0x19;
89    pub const SOURCE_ROUTE_TABLE_SIZE: u8 = 0x1A;
90    pub const KEY_TABLE_SIZE: u8 = 0x1E;
91    pub const SUPPORTED_NETWORKS: u8 = 0x2D;
92    pub const TRANSIENT_KEY_TIMEOUT_S: u8 = 0x36;
93}
94
95/// Policy ids (`setPolicy`).
96pub mod policy {
97    #![allow(missing_docs)]
98    pub const TRUST_CENTER: u8 = 0x00;
99    pub const BINDING_MODIFICATION: u8 = 0x01;
100    pub const UNICAST_REPLIES: u8 = 0x02;
101    pub const POLL_HANDLER: u8 = 0x03;
102    pub const MESSAGE_CONTENTS_IN_CALLBACK: u8 = 0x04;
103    pub const TC_KEY_REQUEST: u8 = 0x05;
104    pub const APP_KEY_REQUEST: u8 = 0x06;
105}
106
107/// Decision ids for the policies above.
108pub mod decision {
109    #![allow(missing_docs)]
110    pub const CHECK_BINDING_MODIFICATIONS_ARE_VALID_ENDPOINT_CLUSTERS: u8 = 0x12;
111    pub const HOST_WILL_NOT_SUPPLY_REPLY: u8 = 0x20;
112    pub const MESSAGE_TAG_ONLY_IN_CALLBACK: u8 = 0x40;
113    pub const DENY_TC_KEY_REQUESTS: u8 = 0x50;
114    pub const ALLOW_TC_KEY_REQUESTS_AND_SEND_CURRENT_KEY: u8 = 0x51;
115    pub const ALLOW_TC_KEY_REQUEST_AND_GENERATE_NEW_KEY: u8 = 0x52;
116    pub const DENY_APP_KEY_REQUESTS: u8 = 0x60;
117    pub const ALLOW_APP_KEY_REQUESTS: u8 = 0x61;
118}
119
120/// Bits of the trust center policy decision.
121pub mod tc_decision {
122    #![allow(missing_docs)]
123    pub const ALLOW_JOINS: u8 = 0x01;
124    pub const ALLOW_UNSECURED_REJOINS: u8 = 0x02;
125    pub const SEND_KEY_IN_CLEAR: u8 = 0x04;
126    pub const IGNORE_UNSECURED_REJOINS: u8 = 0x08;
127    pub const JOINS_USE_INSTALL_CODE_KEY: u8 = 0x10;
128    pub const DEFER_JOINS: u8 = 0x20;
129}
130
131/// Value ids (`getValue` / `setValue`).
132pub mod value {
133    #![allow(missing_docs)]
134    pub const STACK_TOKEN_WRITING: u8 = 0x07;
135    pub const EXTENDED_SECURITY_BITMASK: u8 = 0x0A;
136    pub const VERSION_INFO: u8 = 0x11;
137    pub const NWK_FRAME_COUNTER: u8 = 0x23;
138    pub const APS_FRAME_COUNTER: u8 = 0x24;
139}
140
141/// Manufacturing token ids (`getMfgToken` / `setMfgToken`).
142pub mod mfg_token {
143    #![allow(missing_docs)]
144    pub const STRING: u8 = 0x01;
145    pub const BOARD_NAME: u8 = 0x02;
146    pub const MANUF_ID: u8 = 0x03;
147    pub const CUSTOM_EUI_64: u8 = 0x0C;
148}
149
150/// Bits of `EmberInitialSecurityState.bitmask`.
151pub mod security {
152    #![allow(missing_docs)]
153    pub const TRUST_CENTER_GLOBAL_LINK_KEY: u16 = 0x0004;
154    pub const TRUST_CENTER_USES_HASHED_LINK_KEY: u16 = 0x0084;
155    pub const HAVE_PRECONFIGURED_KEY: u16 = 0x0100;
156    pub const HAVE_NETWORK_KEY: u16 = 0x0200;
157    pub const REQUIRE_ENCRYPTED_KEY: u16 = 0x0800;
158    pub const NO_FRAME_COUNTER_RESET: u16 = 0x1000;
159}
160
161/// Bits of the extended security bitmask (`EXTENDED_SECURITY_BITMASK` value).
162pub mod ext_security {
163    #![allow(missing_docs)]
164    pub const JOINER_GLOBAL_LINK_KEY: u16 = 0x0010;
165    pub const NWK_LEAVE_REQUEST_NOT_ALLOWED: u16 = 0x0100;
166}
167
168/// `EmberNetworkStatus`.
169pub mod network_status {
170    #![allow(missing_docs)]
171    pub const NO_NETWORK: u8 = 0;
172    pub const JOINING_NETWORK: u8 = 1;
173    pub const JOINED_NETWORK: u8 = 2;
174    pub const JOINED_NETWORK_NO_PARENT: u8 = 3;
175    pub const LEAVING_NETWORK: u8 = 6;
176}
177
178/// `EmberNodeType`.
179pub mod node_type {
180    #![allow(missing_docs)]
181    pub const UNKNOWN: u8 = 0;
182    pub const COORDINATOR: u8 = 1;
183    pub const ROUTER: u8 = 2;
184    pub const END_DEVICE: u8 = 3;
185    pub const SLEEPY_END_DEVICE: u8 = 4;
186}
187
188/// `EmberOutgoingMessageType`.
189pub mod outgoing {
190    #![allow(missing_docs)]
191    pub const DIRECT: u8 = 0;
192    pub const VIA_ADDRESS_TABLE: u8 = 1;
193    pub const VIA_BINDING: u8 = 2;
194    pub const MULTICAST: u8 = 3;
195    pub const BROADCAST: u8 = 6;
196}
197
198/// `EmberIncomingMessageType`.
199pub mod incoming {
200    #![allow(missing_docs)]
201    pub const UNICAST: u8 = 0;
202    pub const UNICAST_REPLY: u8 = 1;
203    pub const MULTICAST: u8 = 2;
204    pub const MULTICAST_LOOPBACK: u8 = 3;
205    pub const BROADCAST: u8 = 4;
206    pub const BROADCAST_LOOPBACK: u8 = 5;
207}
208
209/// `EmberApsOption` bits.
210pub mod aps_option {
211    #![allow(missing_docs)]
212    pub const NONE: u16 = 0x0000;
213    pub const ENCRYPTION: u16 = 0x0020;
214    pub const RETRY: u16 = 0x0040;
215    pub const ENABLE_ROUTE_DISCOVERY: u16 = 0x0100;
216    pub const FORCE_ROUTE_DISCOVERY: u16 = 0x0200;
217    pub const SOURCE_EUI64: u16 = 0x0400;
218    pub const DESTINATION_EUI64: u16 = 0x0800;
219    pub const ENABLE_ADDRESS_DISCOVERY: u16 = 0x1000;
220    pub const ZDO_RESPONSE_REQUIRED: u16 = 0x4000;
221}
222
223/// `EmberDeviceUpdate`, the status in `trustCenterJoinHandler`.
224pub mod device_update {
225    #![allow(missing_docs)]
226    pub const SECURED_REJOIN: u8 = 0;
227    pub const UNSECURED_JOIN: u8 = 1;
228    pub const DEVICE_LEFT: u8 = 2;
229    pub const UNSECURED_REJOIN: u8 = 3;
230}
231
232/// `EmberJoinDecision`.
233pub mod join_decision {
234    #![allow(missing_docs)]
235    pub const USE_PRECONFIGURED_KEY: u8 = 0;
236    pub const SEND_KEY_IN_THE_CLEAR: u8 = 1;
237    pub const DENY_JOIN: u8 = 2;
238    pub const NO_ACTION: u8 = 3;
239    pub const ALLOW_REJOINS_ONLY: u8 = 4;
240}
241
242/// `EmberKeyStatus`, from `zigbeeKeyEstablishmentHandler`.
243pub mod key_status {
244    #![allow(missing_docs)]
245    pub const TRUST_CENTER_LINK_KEY_ESTABLISHED: u8 = 0x03;
246    pub const TC_RESPONDED_TO_KEY_REQUEST: u8 = 0x06;
247    pub const TC_FAILED_TO_SEND_TC_KEY: u8 = 0x13;
248    pub const VERIFY_LINK_KEY_SUCCESS: u8 = 0x65;
249}
250
251/// `sl_zb_sec_man_key_type_t`.
252pub mod key_type {
253    #![allow(missing_docs)]
254    pub const NONE: u8 = 0;
255    pub const NETWORK: u8 = 1;
256    pub const TC_LINK: u8 = 2;
257    pub const APP_LINK: u8 = 4;
258}
259
260/// `EmberKeyType`, for `getKey` (protocol versions before 13).
261pub mod ember_key_type {
262    #![allow(missing_docs)]
263    pub const TRUST_CENTER_LINK: u8 = 1;
264    pub const CURRENT_NETWORK: u8 = 3;
265    pub const NEXT_NETWORK: u8 = 4;
266    pub const APPLICATION_LINK: u8 = 5;
267}
268
269/// `EmberKeyStructBitmask`: which fields of a [`crate::types::KeyStruct`]
270/// are valid.
271pub mod key_struct {
272    #![allow(missing_docs)]
273    pub const HAS_SEQUENCE_NUMBER: u16 = 0x0001;
274    pub const HAS_OUTGOING_FRAME_COUNTER: u16 = 0x0002;
275    pub const HAS_INCOMING_FRAME_COUNTER: u16 = 0x0004;
276    pub const HAS_PARTNER_EUI64: u16 = 0x0008;
277}
278
279/// `EmberNetworkInitBitmask`.
280pub mod network_init {
281    #![allow(missing_docs)]
282    pub const PARENT_INFO_IN_TOKEN: u16 = 0x0001;
283    pub const END_DEVICE_REJOIN_ON_REBOOT: u16 = 0x0002;
284}
285
286/// Scan types for `startScan`.
287pub mod scan_type {
288    #![allow(missing_docs)]
289    pub const ENERGY: u8 = 0;
290    pub const ACTIVE: u8 = 1;
291}
292
293/// The concentrator types for `setConcentrator`.
294pub mod concentrator {
295    #![allow(missing_docs)]
296    pub const LOW_RAM: u16 = 0xFFF8;
297    pub const HIGH_RAM: u16 = 0xFFF9;
298}
299
300/// The stack type the `version` command reports for a Zigbee mesh stack.
301pub const STACK_TYPE_MESH: u8 = 0x02;
302/// Zigbee PRO stack profile.
303pub const STACK_PROFILE_ZIGBEE_PRO: u16 = 0x02;
304/// Security level 5 (Zigbee 3.0).
305pub const SECURITY_LEVEL_Z3: u16 = 0x05;