zigbee-herdsman 6.3.0 → 6.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/CHANGELOG.md +10 -1
  2. package/dist/adapter/ember/enums.d.ts +4 -4
  3. package/dist/adapter/ember/enums.js +5 -5
  4. package/dist/adapter/ember/ezsp/consts.d.ts +1 -1
  5. package/dist/adapter/ember/ezsp/consts.js +1 -1
  6. package/dist/adapter/ember/ezsp/enums.d.ts +5 -5
  7. package/dist/adapter/ember/ezsp/enums.js +5 -5
  8. package/dist/adapter/ember/ezsp/ezsp.d.ts +10 -10
  9. package/dist/adapter/ember/ezsp/ezsp.js +10 -10
  10. package/dist/adapter/ember/types.d.ts +10 -10
  11. package/dist/adapter/ezsp/driver/types/named.js +14 -14
  12. package/dist/adapter/ezsp/driver/types/struct.js +5 -5
  13. package/dist/adapter/z-stack/adapter/manager.d.ts +1 -1
  14. package/dist/adapter/z-stack/adapter/manager.js +1 -1
  15. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.d.ts +1 -1
  16. package/dist/adapter/z-stack/structs/entries/nwk-sec-material-descriptor-entry.js +1 -1
  17. package/dist/adapter/zigate/driver/messageType.js +2 -2
  18. package/dist/adapter/zoh/adapter/zohAdapter.js +2 -2
  19. package/dist/controller/model/device.js +1 -1
  20. package/dist/zspec/consts.d.ts +3 -3
  21. package/dist/zspec/consts.js +3 -3
  22. package/dist/zspec/enums.d.ts +2 -2
  23. package/dist/zspec/enums.js +2 -2
  24. package/dist/zspec/tstypes.d.ts +1 -1
  25. package/dist/zspec/utils.d.ts +1 -1
  26. package/dist/zspec/utils.js +1 -1
  27. package/dist/zspec/zcl/definition/cluster.d.ts.map +1 -1
  28. package/dist/zspec/zcl/definition/cluster.js +4 -147
  29. package/dist/zspec/zcl/definition/cluster.js.map +1 -1
  30. package/dist/zspec/zcl/definition/tstype.d.ts +1 -1
  31. package/dist/zspec/zcl/definition/tstype.d.ts.map +1 -1
  32. package/dist/zspec/zdo/definition/clusters.d.ts +3 -3
  33. package/dist/zspec/zdo/definition/clusters.js +3 -3
  34. package/dist/zspec/zdo/definition/consts.d.ts +2 -2
  35. package/dist/zspec/zdo/definition/consts.js +2 -2
  36. package/dist/zspec/zdo/definition/status.d.ts +1 -1
  37. package/dist/zspec/zdo/definition/status.js +1 -1
  38. package/dist/zspec/zdo/definition/tstypes.d.ts +4 -4
  39. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Changelog
2
2
 
3
+ ## [6.3.1](https://github.com/Koenkk/zigbee-herdsman/compare/v6.3.0...v6.3.1) (2025-10-18)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * Add missing parameters to `ssIasZone.initTestMode` command ([#1530](https://github.com/Koenkk/zigbee-herdsman/issues/1530)) ([36673a9](https://github.com/Koenkk/zigbee-herdsman/commit/36673a9741173153f9400df132ae22e83be94445))
9
+ * **ignore:** Rename `ZigBee` -> `Zigbee` ([#1527](https://github.com/Koenkk/zigbee-herdsman/issues/1527)) ([42c6f6c](https://github.com/Koenkk/zigbee-herdsman/commit/42c6f6cd0b4531831ecc987b434ef6a92398f654))
10
+ * Remove custom heiman clusters ([#1528](https://github.com/Koenkk/zigbee-herdsman/issues/1528)) ([a8789f7](https://github.com/Koenkk/zigbee-herdsman/commit/a8789f7bf2b23bd6e7775b4a127109f379e587c8))
11
+
3
12
  ## [6.3.0](https://github.com/Koenkk/zigbee-herdsman/compare/v6.2.0...v6.3.0) (2025-10-15)
4
13
 
5
14
 
@@ -417,7 +426,7 @@
417
426
 
418
427
  ### Features
419
428
 
420
- * Initial support for ZigBee on Host adapter ([#1308](https://github.com/Koenkk/zigbee-herdsman/issues/1308)) ([038085f](https://github.com/Koenkk/zigbee-herdsman/commit/038085fe9d9cb9644faf22d584711c339cfb2af3))
429
+ * Initial support for Zigbee on Host adapter ([#1308](https://github.com/Koenkk/zigbee-herdsman/issues/1308)) ([038085f](https://github.com/Koenkk/zigbee-herdsman/commit/038085fe9d9cb9644faf22d584711c339cfb2af3))
421
430
 
422
431
 
423
432
  ### Bug Fixes
@@ -962,7 +962,7 @@ export declare enum EmberJoinMethod {
962
962
  */
963
963
  MAC_ASSOCIATION = 0,
964
964
  /** For networks where the "permit joining" flag is never turned
965
- * on, devices will need to use a ZigBee NWK Rejoin. This value causes the
965
+ * on, devices will need to use a Zigbee NWK Rejoin. This value causes the
966
966
  * rejoin to be sent withOUT NWK security and the Trust Center will be
967
967
  * asked to send the NWK key to the device. The NWK key sent to the device
968
968
  * can be encrypted with the device's corresponding Trust Center link key.
@@ -1193,7 +1193,7 @@ export declare enum EmberInterpanMessageType {
1193
1193
  }
1194
1194
  /** This is the Current Security Bitmask that details the use of various security features. */
1195
1195
  export declare enum EmberCurrentSecurityBitmask {
1196
- /** This denotes that the device is running in a network with ZigBee
1196
+ /** This denotes that the device is running in a network with Zigbee
1197
1197
  * Standard Security. */
1198
1198
  STANDARD_SECURITY_MODE = 0,
1199
1199
  /** This denotes that the device is running in a network without
@@ -1249,7 +1249,7 @@ export declare enum SecManKeyType {
1249
1249
  APP_LINK = 4,
1250
1250
  /** This is the ZLL encryption key for use by algorithms that require it. */
1251
1251
  ZLL_ENCRYPTION_KEY = 5,
1252
- /** For ZLL, this is the pre-configured link key used during classical ZigBee commissioning. */
1252
+ /** For ZLL, this is the pre-configured link key used during classical Zigbee commissioning. */
1253
1253
  ZLL_PRECONFIGURED_KEY = 6,
1254
1254
  /** This is a Green Power Device (GPD) key used on a Proxy device. */
1255
1255
  GREEN_POWER_PROXY_TABLE_KEY = 7,
@@ -1435,7 +1435,7 @@ export declare enum EmberZllState {
1435
1435
  LINK_INITIATOR = 16,
1436
1436
  /** The device is requesting link priority. */
1437
1437
  LINK_PRIORITY_REQUEST = 32,
1438
- /** The device is a ZigBee 3.0 device. */
1438
+ /** The device is a Zigbee 3.0 device. */
1439
1439
  PROFILE_INTEROP = 128,
1440
1440
  /** The device is on a non-ZLL network. */
1441
1441
  NON_ZLL_NETWORK = 256,
@@ -974,7 +974,7 @@ var EmberLibraryStatus;
974
974
  EmberLibraryStatus[EmberLibraryStatus["LIBRARY_PRESENT_MASK"] = 128] = "LIBRARY_PRESENT_MASK";
975
975
  EmberLibraryStatus[EmberLibraryStatus["LIBRARY_IS_STUB"] = 0] = "LIBRARY_IS_STUB";
976
976
  EmberLibraryStatus[EmberLibraryStatus["LIBRARY_ERROR"] = 255] = "LIBRARY_ERROR";
977
- // The ZigBee Pro library uses the following to indicate additional functionality:
977
+ // The Zigbee Pro library uses the following to indicate additional functionality:
978
978
  /** no router capability */
979
979
  EmberLibraryStatus[EmberLibraryStatus["ZIGBEE_PRO_LIBRARY_END_DEVICE_ONLY"] = 0] = "ZIGBEE_PRO_LIBRARY_END_DEVICE_ONLY";
980
980
  EmberLibraryStatus[EmberLibraryStatus["ZIGBEE_PRO_LIBRARY_HAVE_ROUTER_CAPABILITY"] = 1] = "ZIGBEE_PRO_LIBRARY_HAVE_ROUTER_CAPABILITY";
@@ -1044,7 +1044,7 @@ var EmberJoinMethod;
1044
1044
  */
1045
1045
  EmberJoinMethod[EmberJoinMethod["MAC_ASSOCIATION"] = 0] = "MAC_ASSOCIATION";
1046
1046
  /** For networks where the "permit joining" flag is never turned
1047
- * on, devices will need to use a ZigBee NWK Rejoin. This value causes the
1047
+ * on, devices will need to use a Zigbee NWK Rejoin. This value causes the
1048
1048
  * rejoin to be sent withOUT NWK security and the Trust Center will be
1049
1049
  * asked to send the NWK key to the device. The NWK key sent to the device
1050
1050
  * can be encrypted with the device's corresponding Trust Center link key.
@@ -1294,7 +1294,7 @@ var EmberInterpanMessageType;
1294
1294
  var EmberCurrentSecurityBitmask;
1295
1295
  (function (EmberCurrentSecurityBitmask) {
1296
1296
  // These options are the same for Initial and Current Security state.
1297
- /** This denotes that the device is running in a network with ZigBee
1297
+ /** This denotes that the device is running in a network with Zigbee
1298
1298
  * Standard Security. */
1299
1299
  EmberCurrentSecurityBitmask[EmberCurrentSecurityBitmask["STANDARD_SECURITY_MODE"] = 0] = "STANDARD_SECURITY_MODE";
1300
1300
  /** This denotes that the device is running in a network without
@@ -1353,7 +1353,7 @@ var SecManKeyType;
1353
1353
  SecManKeyType[SecManKeyType["APP_LINK"] = 4] = "APP_LINK";
1354
1354
  /** This is the ZLL encryption key for use by algorithms that require it. */
1355
1355
  SecManKeyType[SecManKeyType["ZLL_ENCRYPTION_KEY"] = 5] = "ZLL_ENCRYPTION_KEY";
1356
- /** For ZLL, this is the pre-configured link key used during classical ZigBee commissioning. */
1356
+ /** For ZLL, this is the pre-configured link key used during classical Zigbee commissioning. */
1357
1357
  SecManKeyType[SecManKeyType["ZLL_PRECONFIGURED_KEY"] = 6] = "ZLL_PRECONFIGURED_KEY";
1358
1358
  /** This is a Green Power Device (GPD) key used on a Proxy device. */
1359
1359
  SecManKeyType[SecManKeyType["GREEN_POWER_PROXY_TABLE_KEY"] = 7] = "GREEN_POWER_PROXY_TABLE_KEY";
@@ -1553,7 +1553,7 @@ var EmberZllState;
1553
1553
  EmberZllState[EmberZllState["LINK_INITIATOR"] = 16] = "LINK_INITIATOR";
1554
1554
  /** The device is requesting link priority. */
1555
1555
  EmberZllState[EmberZllState["LINK_PRIORITY_REQUEST"] = 32] = "LINK_PRIORITY_REQUEST";
1556
- /** The device is a ZigBee 3.0 device. */
1556
+ /** The device is a Zigbee 3.0 device. */
1557
1557
  EmberZllState[EmberZllState["PROFILE_INTEROP"] = 128] = "PROFILE_INTEROP";
1558
1558
  /** The device is on a non-ZLL network. */
1559
1559
  EmberZllState[EmberZllState["NON_ZLL_NETWORK"] = 256] = "NON_ZLL_NETWORK";
@@ -104,7 +104,7 @@ export declare const EMBER_PRIVATE_KEY_SIZE = 21;
104
104
  export declare const EMBER_SMAC_SIZE = 16;
105
105
  /** Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms. */
106
106
  export declare const EMBER_SIGNATURE_SIZE = 42;
107
- /** The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification. */
107
+ /** The size of AES-128 MMO hash is 16-bytes. This is defined in the core. Zigbee specification. */
108
108
  export declare const EMBER_AES_HASH_BLOCK_SIZE = 16;
109
109
  /** Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes. */
110
110
  export declare const EMBER_CERTIFICATE_283K1_SIZE = 74;
@@ -116,7 +116,7 @@ exports.EMBER_PRIVATE_KEY_SIZE = 21;
116
116
  exports.EMBER_SMAC_SIZE = 16;
117
117
  /** Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms. */
118
118
  exports.EMBER_SIGNATURE_SIZE = 42;
119
- /** The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification. */
119
+ /** The size of AES-128 MMO hash is 16-bytes. This is defined in the core. Zigbee specification. */
120
120
  exports.EMBER_AES_HASH_BLOCK_SIZE = 16;
121
121
  /** Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes. */
122
122
  exports.EMBER_CERTIFICATE_283K1_SIZE = 74;
@@ -498,9 +498,9 @@ export declare enum EzspConfigId {
498
498
  PAN_ID_CONFLICT_REPORT_THRESHOLD = 34,
499
499
  /**
500
500
  * The timeout value in minutes for how long the Trust Center or a normal node
501
- * waits for the ZigBee Request Key to complete. On the Trust Center this
501
+ * waits for the Zigbee Request Key to complete. On the Trust Center this
502
502
  * controls whether or not the device buffers the request, waiting for a
503
- * matching pair of ZigBee Request Key. If the value is non-zero, the Trust
503
+ * matching pair of Zigbee Request Key. If the value is non-zero, the Trust
504
504
  * Center buffers and waits for that amount of time. If the value is zero, the
505
505
  * Trust Center does not buffer the request and immediately responds to the
506
506
  * request. Zero is the most compliant behavior.
@@ -532,7 +532,7 @@ export declare enum EzspConfigId {
532
532
  /**
533
533
  * Whether multicasts are sent to the RxOnWhenIdle=true address (0xFFFD) or
534
534
  * the sleepy broadcast address (0xFFFF). The RxOnWhenIdle=true address is the
535
- * ZigBee compliant destination for multicasts.
535
+ * Zigbee compliant destination for multicasts.
536
536
  */
537
537
  SEND_MULTICASTS_TO_SLEEPY_ADDRESS = 46,
538
538
  /** ZLL group address initial configuration. */
@@ -725,7 +725,7 @@ export declare enum EzspPolicyId {
725
725
  /** Controls whether the Trust Center will respond to application link key requests. */
726
726
  APP_KEY_REQUEST_POLICY = 6,
727
727
  /**
728
- * Controls whether ZigBee packets that appear invalid are automatically dropped by the stack.
728
+ * Controls whether Zigbee packets that appear invalid are automatically dropped by the stack.
729
729
  * A counter will be incremented when this occurs.
730
730
  */
731
731
  PACKET_VALIDATE_LIBRARY_POLICY = 7,
@@ -797,7 +797,7 @@ export declare enum EzspValueId {
797
797
  * If the NCP initiated a rejoin it will record this value internally for retrieval by ezspGetValue(REAL_REJOIN_REASON).
798
798
  */
799
799
  LAST_REJOIN_REASON = 19,
800
- /** The next ZigBee sequence number. */
800
+ /** The next Zigbee sequence number. */
801
801
  NEXT_ZIGBEE_SEQUENCE_NUMBER = 20,
802
802
  /** CCA energy detect threshold for radio. */
803
803
  CCA_THRESHOLD = 21,
@@ -545,9 +545,9 @@ var EzspConfigId;
545
545
  EzspConfigId[EzspConfigId["PAN_ID_CONFLICT_REPORT_THRESHOLD"] = 34] = "PAN_ID_CONFLICT_REPORT_THRESHOLD";
546
546
  /**
547
547
  * The timeout value in minutes for how long the Trust Center or a normal node
548
- * waits for the ZigBee Request Key to complete. On the Trust Center this
548
+ * waits for the Zigbee Request Key to complete. On the Trust Center this
549
549
  * controls whether or not the device buffers the request, waiting for a
550
- * matching pair of ZigBee Request Key. If the value is non-zero, the Trust
550
+ * matching pair of Zigbee Request Key. If the value is non-zero, the Trust
551
551
  * Center buffers and waits for that amount of time. If the value is zero, the
552
552
  * Trust Center does not buffer the request and immediately responds to the
553
553
  * request. Zero is the most compliant behavior.
@@ -583,7 +583,7 @@ var EzspConfigId;
583
583
  /**
584
584
  * Whether multicasts are sent to the RxOnWhenIdle=true address (0xFFFD) or
585
585
  * the sleepy broadcast address (0xFFFF). The RxOnWhenIdle=true address is the
586
- * ZigBee compliant destination for multicasts.
586
+ * Zigbee compliant destination for multicasts.
587
587
  */
588
588
  EzspConfigId[EzspConfigId["SEND_MULTICASTS_TO_SLEEPY_ADDRESS"] = 46] = "SEND_MULTICASTS_TO_SLEEPY_ADDRESS";
589
589
  /** ZLL group address initial configuration. */
@@ -787,7 +787,7 @@ var EzspPolicyId;
787
787
  /** Controls whether the Trust Center will respond to application link key requests. */
788
788
  EzspPolicyId[EzspPolicyId["APP_KEY_REQUEST_POLICY"] = 6] = "APP_KEY_REQUEST_POLICY";
789
789
  /**
790
- * Controls whether ZigBee packets that appear invalid are automatically dropped by the stack.
790
+ * Controls whether Zigbee packets that appear invalid are automatically dropped by the stack.
791
791
  * A counter will be incremented when this occurs.
792
792
  */
793
793
  EzspPolicyId[EzspPolicyId["PACKET_VALIDATE_LIBRARY_POLICY"] = 7] = "PACKET_VALIDATE_LIBRARY_POLICY";
@@ -861,7 +861,7 @@ var EzspValueId;
861
861
  * If the NCP initiated a rejoin it will record this value internally for retrieval by ezspGetValue(REAL_REJOIN_REASON).
862
862
  */
863
863
  EzspValueId[EzspValueId["LAST_REJOIN_REASON"] = 19] = "LAST_REJOIN_REASON";
864
- /** The next ZigBee sequence number. */
864
+ /** The next Zigbee sequence number. */
865
865
  EzspValueId[EzspValueId["NEXT_ZIGBEE_SEQUENCE_NUMBER"] = 20] = "NEXT_ZIGBEE_SEQUENCE_NUMBER";
866
866
  /** CCA energy detect threshold for radio. */
867
867
  EzspValueId[EzspValueId["CCA_THRESHOLD"] = 21] = "CCA_THRESHOLD";
@@ -164,7 +164,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
164
164
  * @param indexOrDestination uint16_t Depending on the type of addressing used, this is either the NodeId of the destination,
165
165
  * an index into the address table, or an index into the binding table.
166
166
  * Unused for multicast types.
167
- * This must be one of the three ZigBee broadcast addresses for broadcast.
167
+ * This must be one of the three Zigbee broadcast addresses for broadcast.
168
168
  * @param apsFrame [IN/OUT] EmberApsFrame * The APS frame which is to be added to the message.
169
169
  * Sequence set in OUT as returned by ezspSend${x} command
170
170
  * @param message uint8_t * Content of the message.
@@ -851,7 +851,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
851
851
  * Network Key. The stack will call ezspStackStatusHandler to indicate that the
852
852
  * network is down, then try to re-establish contact with the network by
853
853
  * performing an active scan, choosing a network with matching extended pan id,
854
- * and sending a ZigBee network rejoin request. A second call to the
854
+ * and sending a Zigbee network rejoin request. A second call to the
855
855
  * ezspStackStatusHandler callback indicates either the success or the failure
856
856
  * of the attempt. The process takes approximately 150 milliseconds per channel
857
857
  * to complete.
@@ -1452,7 +1452,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
1452
1452
  */
1453
1453
  ezspMaximumPayloadLength(): Promise<number>;
1454
1454
  /**
1455
- * Sends a unicast message as per the ZigBee specification.
1455
+ * Sends a unicast message as per the Zigbee specification.
1456
1456
  * The message will arrive at its destination only if there is a known route to the destination node.
1457
1457
  * Setting the ENABLE_ROUTE_DISCOVERY option will cause a route to be discovered if none is known.
1458
1458
  * Setting the FORCE_ROUTE_DISCOVERY option will force route discovery.
@@ -1480,10 +1480,10 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
1480
1480
  */
1481
1481
  ezspSendUnicast(type: EmberOutgoingMessageType, indexOrDestination: NodeId, apsFrame: EmberApsFrame, messageTag: number, messageContents: Buffer): Promise<[SLStatus, apsSequence: number]>;
1482
1482
  /**
1483
- * Sends a broadcast message as per the ZigBee specification.
1483
+ * Sends a broadcast message as per the Zigbee specification.
1484
1484
  * @param alias uint16_t (unused in v13-) The aliased source from which we send the broadcast.
1485
1485
  * This must be SL_ZIGBEE_NULL_NODE_ID if we do not need an aliased source
1486
- * @param destination The destination to which to send the broadcast. This must be one of the three ZigBee broadcast addresses.
1486
+ * @param destination The destination to which to send the broadcast. This must be one of the three Zigbee broadcast addresses.
1487
1487
  * @param nwkSequence uint8_t (unused in v13-) The alias nwk sequence number. This won't be used if there is no aliased source.
1488
1488
  * @param apsFrame EmberApsFrame * The APS frame for the message.
1489
1489
  * @param radius uint8_t The message will be delivered to all nodes within radius hops of the sender.
@@ -1568,7 +1568,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
1568
1568
  * that wishes to communicate with many nodes, for example, a gateway, central
1569
1569
  * monitor, or controller. A device using this function was referred to as an
1570
1570
  * 'aggregator' in EmberZNet 2.x and earlier, and is referred to as a
1571
- * 'concentrator' in the ZigBee specification and EmberZNet 3. This function
1571
+ * 'concentrator' in the Zigbee specification and EmberZNet 3. This function
1572
1572
  * enables large scale networks, because the other devices do not have to
1573
1573
  * individually perform bandwidth-intensive route discoveries. Instead, when a
1574
1574
  * remote node sends an APS unicast to a concentrator, its network layer
@@ -1578,7 +1578,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
1578
1578
  * in which the entire route is listed in the network layer header.) This allows
1579
1579
  * the concentrator to communicate with thousands of devices without requiring
1580
1580
  * large route tables on neighboring nodes. This function is only available in
1581
- * ZigBee Pro (stack profile 2), and cannot be called on end devices. Any router
1581
+ * Zigbee Pro (stack profile 2), and cannot be called on end devices. Any router
1582
1582
  * can be a concentrator (not just the coordinator), and there can be multiple
1583
1583
  * concentrators on a network. Note that a concentrator does not automatically
1584
1584
  * obtain routes to all network nodes after calling this function. Remote
@@ -2052,7 +2052,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
2052
2052
  * A function to request a Link Key from the Trust Center with another device on
2053
2053
  * the Network (which could be the Trust Center). A Link Key with the Trust
2054
2054
  * Center is possible but the requesting device cannot be the Trust Center. Link
2055
- * Keys are optional in ZigBee Standard Security and thus the stack cannot know
2055
+ * Keys are optional in Zigbee Standard Security and thus the stack cannot know
2056
2056
  * whether the other device supports them. If EMBER_REQUEST_KEY_TIMEOUT is
2057
2057
  * non-zero on the Trust Center and the partner device is not the Trust Center,
2058
2058
  * both devices must request keys with their partner device within the time
@@ -2503,7 +2503,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
2503
2503
  /**
2504
2504
  * Transmits the given bootload message to a neighboring node using a specific
2505
2505
  * 802.15.4 header that allows the EmberZNet stack as well as the bootloader to
2506
- * recognize the message, but will not interfere with other ZigBee stacks.
2506
+ * recognize the message, but will not interfere with other Zigbee stacks.
2507
2507
  * @param broadcast If true, the destination address and pan id are both set to the broadcast address.
2508
2508
  * @param destEui64 The EUI64 of the target node. Ignored if the broadcast field is set to true.
2509
2509
  * @param messageLength uint8_t The length of the messageContents parameter in bytes.
@@ -2800,7 +2800,7 @@ export declare class Ezsp extends EventEmitter<EmberEzspEventMap> {
2800
2800
  ezspDGpSentHandler(status: SLStatus, gpepHandle: number): void;
2801
2801
  /**
2802
2802
  * Callback
2803
- * A callback invoked by the ZigBee GP stack when a GPDF is received.
2803
+ * A callback invoked by the Zigbee GP stack when a GPDF is received.
2804
2804
  * @param status The status of the GPDF receive.
2805
2805
  * @param gpdLink uint8_t The gpdLink value of the received GPDF.
2806
2806
  * @param sequenceNumber uint8_t The GPDF sequence number.
@@ -903,7 +903,7 @@ class Ezsp extends node_events_1.default {
903
903
  * @param indexOrDestination uint16_t Depending on the type of addressing used, this is either the NodeId of the destination,
904
904
  * an index into the address table, or an index into the binding table.
905
905
  * Unused for multicast types.
906
- * This must be one of the three ZigBee broadcast addresses for broadcast.
906
+ * This must be one of the three Zigbee broadcast addresses for broadcast.
907
907
  * @param apsFrame [IN/OUT] EmberApsFrame * The APS frame which is to be added to the message.
908
908
  * Sequence set in OUT as returned by ezspSend${x} command
909
909
  * @param message uint8_t * Content of the message.
@@ -2407,7 +2407,7 @@ class Ezsp extends node_events_1.default {
2407
2407
  * Network Key. The stack will call ezspStackStatusHandler to indicate that the
2408
2408
  * network is down, then try to re-establish contact with the network by
2409
2409
  * performing an active scan, choosing a network with matching extended pan id,
2410
- * and sending a ZigBee network rejoin request. A second call to the
2410
+ * and sending a Zigbee network rejoin request. A second call to the
2411
2411
  * ezspStackStatusHandler callback indicates either the success or the failure
2412
2412
  * of the attempt. The process takes approximately 150 milliseconds per channel
2413
2413
  * to complete.
@@ -3772,7 +3772,7 @@ class Ezsp extends node_events_1.default {
3772
3772
  return apsLength;
3773
3773
  }
3774
3774
  /**
3775
- * Sends a unicast message as per the ZigBee specification.
3775
+ * Sends a unicast message as per the Zigbee specification.
3776
3776
  * The message will arrive at its destination only if there is a known route to the destination node.
3777
3777
  * Setting the ENABLE_ROUTE_DISCOVERY option will cause a route to be discovered if none is known.
3778
3778
  * Setting the FORCE_ROUTE_DISCOVERY option will force route discovery.
@@ -3819,10 +3819,10 @@ class Ezsp extends node_events_1.default {
3819
3819
  return [status, apsSequence];
3820
3820
  }
3821
3821
  /**
3822
- * Sends a broadcast message as per the ZigBee specification.
3822
+ * Sends a broadcast message as per the Zigbee specification.
3823
3823
  * @param alias uint16_t (unused in v13-) The aliased source from which we send the broadcast.
3824
3824
  * This must be SL_ZIGBEE_NULL_NODE_ID if we do not need an aliased source
3825
- * @param destination The destination to which to send the broadcast. This must be one of the three ZigBee broadcast addresses.
3825
+ * @param destination The destination to which to send the broadcast. This must be one of the three Zigbee broadcast addresses.
3826
3826
  * @param nwkSequence uint8_t (unused in v13-) The alias nwk sequence number. This won't be used if there is no aliased source.
3827
3827
  * @param apsFrame EmberApsFrame * The APS frame for the message.
3828
3828
  * @param radius uint8_t The message will be delivered to all nodes within radius hops of the sender.
@@ -3979,7 +3979,7 @@ class Ezsp extends node_events_1.default {
3979
3979
  * that wishes to communicate with many nodes, for example, a gateway, central
3980
3980
  * monitor, or controller. A device using this function was referred to as an
3981
3981
  * 'aggregator' in EmberZNet 2.x and earlier, and is referred to as a
3982
- * 'concentrator' in the ZigBee specification and EmberZNet 3. This function
3982
+ * 'concentrator' in the Zigbee specification and EmberZNet 3. This function
3983
3983
  * enables large scale networks, because the other devices do not have to
3984
3984
  * individually perform bandwidth-intensive route discoveries. Instead, when a
3985
3985
  * remote node sends an APS unicast to a concentrator, its network layer
@@ -3989,7 +3989,7 @@ class Ezsp extends node_events_1.default {
3989
3989
  * in which the entire route is listed in the network layer header.) This allows
3990
3990
  * the concentrator to communicate with thousands of devices without requiring
3991
3991
  * large route tables on neighboring nodes. This function is only available in
3992
- * ZigBee Pro (stack profile 2), and cannot be called on end devices. Any router
3992
+ * Zigbee Pro (stack profile 2), and cannot be called on end devices. Any router
3993
3993
  * can be a concentrator (not just the coordinator), and there can be multiple
3994
3994
  * concentrators on a network. Note that a concentrator does not automatically
3995
3995
  * obtain routes to all network nodes after calling this function. Remote
@@ -5055,7 +5055,7 @@ class Ezsp extends node_events_1.default {
5055
5055
  * A function to request a Link Key from the Trust Center with another device on
5056
5056
  * the Network (which could be the Trust Center). A Link Key with the Trust
5057
5057
  * Center is possible but the requesting device cannot be the Trust Center. Link
5058
- * Keys are optional in ZigBee Standard Security and thus the stack cannot know
5058
+ * Keys are optional in Zigbee Standard Security and thus the stack cannot know
5059
5059
  * whether the other device supports them. If EMBER_REQUEST_KEY_TIMEOUT is
5060
5060
  * non-zero on the Trust Center and the partner device is not the Trust Center,
5061
5061
  * both devices must request keys with their partner device within the time
@@ -6099,7 +6099,7 @@ class Ezsp extends node_events_1.default {
6099
6099
  /**
6100
6100
  * Transmits the given bootload message to a neighboring node using a specific
6101
6101
  * 802.15.4 header that allows the EmberZNet stack as well as the bootloader to
6102
- * recognize the message, but will not interfere with other ZigBee stacks.
6102
+ * recognize the message, but will not interfere with other Zigbee stacks.
6103
6103
  * @param broadcast If true, the destination address and pan id are both set to the broadcast address.
6104
6104
  * @param destEui64 The EUI64 of the target node. Ignored if the broadcast field is set to true.
6105
6105
  * @param messageLength uint8_t The length of the messageContents parameter in bytes.
@@ -6717,7 +6717,7 @@ class Ezsp extends node_events_1.default {
6717
6717
  }
6718
6718
  /**
6719
6719
  * Callback
6720
- * A callback invoked by the ZigBee GP stack when a GPDF is received.
6720
+ * A callback invoked by the Zigbee GP stack when a GPDF is received.
6721
6721
  * @param status The status of the GPDF receive.
6722
6722
  * @param gpdLink uint8_t The gpdLink value of the received GPDF.
6723
6723
  * @param sequenceNumber uint8_t The GPDF sequence number.
@@ -1,6 +1,6 @@
1
1
  import type { Eui64, ExtendedPanId, NodeId, PanId } from "../../zspec/tstypes";
2
2
  import type { EmberApsOption, EmberBindingType, EmberCurrentSecurityBitmask, EmberGpApplicationId, EmberGpProxyTableEntryStatus, EmberGpSinkTableEntryStatus, EmberGpSinkType, EmberJoinMethod, EmberKeyStructBitmask, EmberNetworkInitBitmask, EmberNodeType, EmberVersionType, EmberZllKeyIndex, EmberZllState, SecManDerivedKeyType, SecManFlag, SecManKeyType } from "./enums";
3
- /** 16-bit ZigBee multicast group identifier. uint16_t */
3
+ /** 16-bit Zigbee multicast group identifier. uint16_t */
4
4
  export type EmberMulticastId = number;
5
5
  /**
6
6
  * The percent of duty cycle for a limit.
@@ -48,7 +48,7 @@ export type EmberVersion = {
48
48
  patch: number;
49
49
  /**
50
50
  * Special version number
51
- * (used to indicate superficial changes that don't require re-certification of the stack as a ZigBee-Compliant Platform,
51
+ * (used to indicate superficial changes that don't require re-certification of the stack as a Zigbee-Compliant Platform,
52
52
  * such as changes that only affect installer packaging, documentation, or comments in the code)
53
53
  *
54
54
  * a.b.c.D
@@ -82,7 +82,7 @@ export type EmberNetworkParameters = {
82
82
  radioChannel: number;
83
83
  /**
84
84
  * Join method: The protocol messages used to establish an initial parent.
85
- * It is ignored when forming a ZigBee network, or when querying the stack for its network parameters.
85
+ * It is ignored when forming a Zigbee network, or when querying the stack for its network parameters.
86
86
  */
87
87
  joinMethod: EmberJoinMethod;
88
88
  /**
@@ -91,7 +91,7 @@ export type EmberNetworkParameters = {
91
91
  */
92
92
  nwkManagerId: NodeId;
93
93
  /**
94
- * An NWK Update ID. The value of the ZigBee nwkUpdateId known by the stack.
94
+ * An NWK Update ID. The value of the Zigbee nwkUpdateId known by the stack.
95
95
  * It is used to determine the newest instance of the network after a PAN
96
96
  * ID or channel change. This may only be set at joining when using
97
97
  * EMBER_USE_CONFIGURED_NWK_STATE as the join method.
@@ -298,7 +298,7 @@ export type EmberBindingTableEntry = {
298
298
  /** The index of the network the binding belongs to. uint8_t */
299
299
  networkIndex: number;
300
300
  };
301
- /** An in-memory representation of a ZigBee APS frame of an incoming or outgoing message. */
301
+ /** An in-memory representation of a Zigbee APS frame of an incoming or outgoing message. */
302
302
  export type EmberApsFrame = {
303
303
  /** The application profile ID that describes the format of the message. uint16_t */
304
304
  profileId: number;
@@ -497,7 +497,7 @@ export type EmberPrivateKeyData = {
497
497
  /** uint8_t[EMBER_PRIVATE_KEY_SIZE] */
498
498
  contents: Buffer;
499
499
  };
500
- /** Defines a ZigBee network and the associated parameters. */
500
+ /** Defines a Zigbee network and the associated parameters. */
501
501
  export type EmberZigbeeNetwork = {
502
502
  /** uint16_t */
503
503
  panId: PanId;
@@ -536,7 +536,7 @@ export type EmberZllNetwork = {
536
536
  /** uint8_t */
537
537
  rssiCorrection: number;
538
538
  };
539
- /** Describe the Initial Security features and requirements that will be used when forming or joining ZigBee Light Link networks. */
539
+ /** Describe the Initial Security features and requirements that will be used when forming or joining Zigbee Light Link networks. */
540
540
  export type EmberZllInitialSecurityState = {
541
541
  /** This bitmask is unused. All values are reserved for future use. uint32_t */
542
542
  bitmask: number;
@@ -544,7 +544,7 @@ export type EmberZllInitialSecurityState = {
544
544
  keyIndex: EmberZllKeyIndex;
545
545
  /** The encryption key for use by algorithms that require it. */
546
546
  encryptionKey: EmberKeyData;
547
- /** The pre-configured link key used during classical ZigBee commissioning. */
547
+ /** The pre-configured link key used during classical Zigbee commissioning. */
548
548
  preconfiguredKey: EmberKeyData;
549
549
  };
550
550
  /** Information discovered during a ZLL scan about the ZLL device's endpoint information. */
@@ -713,9 +713,9 @@ export type EmberTokenData = {
713
713
  data: Buffer;
714
714
  };
715
715
  /**
716
- * Endpoint information (a ZigBee Simple Descriptor).
716
+ * Endpoint information (a Zigbee Simple Descriptor).
717
717
  *
718
- * This is a ZigBee Simple Descriptor and contains information about an endpoint.
718
+ * This is a Zigbee Simple Descriptor and contains information about an endpoint.
719
719
  * This information is shared with other nodes in the network by the ZDO.
720
720
  */
721
721
  export type EmberEndpointDescription = {
@@ -241,9 +241,9 @@ class EzspConfigId extends basic.uint8_t {
241
241
  // network manager within one minute to trigger a PAN id change.
242
242
  static CONFIG_PAN_ID_CONFLICT_REPORT_THRESHOLD = 0x22;
243
243
  // The timeout value in minutes for how long the Trust Center or a normal
244
- // node waits for the ZigBee Request Key to complete. On the Trust Center
244
+ // node waits for the Zigbee Request Key to complete. On the Trust Center
245
245
  // this controls whether or not the device buffers the request, waiting for
246
- // a matching pair of ZigBee Request Key. If the value is non-zero, the
246
+ // a matching pair of Zigbee Request Key. If the value is non-zero, the
247
247
  // Trust Center buffers and waits for that amount of time. If the value is
248
248
  // zero, the Trust Center does not buffer the request and immediately
249
249
  // responds to the request. Zero is the most compliant behavior.
@@ -270,7 +270,7 @@ class EzspConfigId extends basic.uint8_t {
270
270
  static CONFIG_SUPPORTED_NETWORKS = 0x2d;
271
271
  // Whether multicasts are sent to the RxOnWhenIdle=true address (0xFFFD) or
272
272
  // the sleepy broadcast address (0xFFFF). The RxOnWhenIdle=true address is
273
- // the ZigBee compliant destination for multicasts.
273
+ // the Zigbee compliant destination for multicasts.
274
274
  static CONFIG_SEND_MULTICASTS_TO_SLEEPY_ADDRESS = 0x2e;
275
275
  // ZLL group address initial configuration.
276
276
  static CONFIG_ZLL_GROUP_ADDRESSES = 0x2f;
@@ -364,7 +364,7 @@ class EzspValueId extends basic.uint8_t {
364
364
  // initiated a rejoin it will record this value internally for retrieval by
365
365
  // ezspGetValue(VALUE_REAL_REJOIN_REASON).
366
366
  static VALUE_LAST_REJOIN_REASON = 0x13;
367
- // The next ZigBee sequence number.
367
+ // The next Zigbee sequence number.
368
368
  static VALUE_NEXT_ZIGBEE_SEQUENCE_NUMBER = 0x14;
369
369
  // CCA energy detect threshold for radio.
370
370
  static VALUE_CCA_THRESHOLD = 0x15;
@@ -478,7 +478,7 @@ class EzspPolicyId extends basic.uint8_t {
478
478
  // Controls whether the Trust Center will respond to application link key
479
479
  // requests.
480
480
  static APP_KEY_REQUEST_POLICY = 0x06;
481
- // Controls whether ZigBee packets that appear invalid are automatically
481
+ // Controls whether Zigbee packets that appear invalid are automatically
482
482
  // dropped by the stack. A counter will be incremented when this occurs.
483
483
  static PACKET_VALIDATE_LIBRARY_POLICY = 0x07;
484
484
  // Controls whether the stack will process ZLL messages.
@@ -947,8 +947,8 @@ class EmberStatus extends basic.uint8_t {
947
947
  // After moving, a mobile node's attempt to re-establish contact with the
948
948
  // network failed.
949
949
  static MOVE_FAILED = 0x96;
950
- // An attempt to join as a router failed due to a ZigBee versus ZigBee Pro
951
- // incompatibility. ZigBee devices joining ZigBee Pro networks (or vice
950
+ // An attempt to join as a router failed due to a Zigbee versus Zigbee Pro
951
+ // incompatibility. Zigbee devices joining Zigbee Pro networks (or vice
952
952
  // versa) must join as End Devices, not Routers.
953
953
  static CANNOT_JOIN_AS_ROUTER = 0x98;
954
954
  // The local node ID has changed. The application can obtain the new node ID
@@ -1023,10 +1023,10 @@ class EmberStatus extends basic.uint8_t {
1023
1023
  static KEY_NOT_AUTHORIZED = 0xbb;
1024
1024
  // The security data provided was not valid, or an integrity check failed.
1025
1025
  static SECURITY_DATA_INVALID = 0xbd;
1026
- // A ZigBee route error command frame was received indicating that a source
1026
+ // A Zigbee route error command frame was received indicating that a source
1027
1027
  // routed message from this node failed en route.
1028
1028
  static SOURCE_ROUTE_FAILURE = 0xa9;
1029
- // A ZigBee route error command frame was received indicating that a message
1029
+ // A Zigbee route error command frame was received indicating that a message
1030
1030
  // sent to this node along a many-to-one route failed en route. The route
1031
1031
  // error frame was delivered by an ad-hoc search for a functioning route.
1032
1032
  static MANY_TO_ONE_ROUTE_FAILURE = 0xaa;
@@ -1857,7 +1857,7 @@ exports.EmberJoinDecision = EmberJoinDecision;
1857
1857
  class EmberInitialSecurityBitmask extends basic.uint16_t {
1858
1858
  // This is the Initial Security Bitmask that controls the use of various
1859
1859
  // security features.
1860
- // This enables ZigBee Standard Security on the node.
1860
+ // This enables Zigbee Standard Security on the node.
1861
1861
  static STANDARD_SECURITY_MODE = 0x0000;
1862
1862
  // This enables Distributed Trust Center Mode for the device forming the
1863
1863
  // network. (Previously known as NO_TRUST_CENTER_MODE)
@@ -1918,10 +1918,10 @@ exports.EmberInitialSecurityBitmask = EmberInitialSecurityBitmask;
1918
1918
  class EmberCurrentSecurityBitmask extends basic.uint16_t {
1919
1919
  // This is the Current Security Bitmask that details the use of various
1920
1920
  // security features.
1921
- // This denotes that the device is running in a network with ZigBee Standard
1921
+ // This denotes that the device is running in a network with Zigbee Standard
1922
1922
  // Security.
1923
1923
  static STANDARD_SECURITY_MODE = 0x0000;
1924
- // This denotes that the device is running in a network with ZigBee High
1924
+ // This denotes that the device is running in a network with Zigbee High
1925
1925
  // Security.
1926
1926
  static HIGH_SECURITY_MODE = 0x0001;
1927
1927
  // This denotes that the device is running in a network without a
@@ -1937,7 +1937,7 @@ class EmberCurrentSecurityBitmask extends basic.uint16_t {
1937
1937
  }
1938
1938
  exports.EmberCurrentSecurityBitmask = EmberCurrentSecurityBitmask;
1939
1939
  class EmberKeyType extends basic.uint8_t {
1940
- // Describes the type of ZigBee security key.
1940
+ // Describes the type of Zigbee security key.
1941
1941
  // A shared key between the Trust Center and a device.
1942
1942
  static TRUST_CENTER_LINK_KEY = 0x01;
1943
1943
  // A shared secret used for deriving keys between the Trust Center and a
@@ -2109,7 +2109,7 @@ class EmberJoinMethod extends basic.uint8_t {
2109
2109
  // equivalent to a MAC association. This value should be used by default.
2110
2110
  static USE_MAC_ASSOCIATION = 0x0;
2111
2111
  // For those networks where the "permit joining" flag is never turned on,
2112
- // they will need to use a ZigBee NWK Rejoin. This value causes the rejoin
2112
+ // they will need to use a Zigbee NWK Rejoin. This value causes the rejoin
2113
2113
  // to be sent without NWK security and the Trust Center will be asked to
2114
2114
  // send the NWK key to the device. The NWK key sent to the device can be
2115
2115
  // encrypted with the device's corresponding Trust Center link key. That is
@@ -91,7 +91,7 @@ class EmberNetworkParameters extends EzspStruct {
91
91
  // This may only be set at joining when using USE_NWK_COMMISSIONING as
92
92
  // the join method.
93
93
  ["nwkManagerId", named.EmberNodeId],
94
- // NWK Update ID. The value of the ZigBee nwkUpdateId known by the
94
+ // NWK Update ID. The value of the Zigbee nwkUpdateId known by the
95
95
  // stack. This is used to determine the newest instance of the network
96
96
  // after a PAN ID or channel change. This may only be set at joining
97
97
  // when using USE_NWK_COMMISSIONING as the join method.
@@ -105,7 +105,7 @@ class EmberNetworkParameters extends EzspStruct {
105
105
  }
106
106
  exports.EmberNetworkParameters = EmberNetworkParameters;
107
107
  class EmberZigbeeNetwork extends EzspStruct {
108
- // The parameters of a ZigBee network.
108
+ // The parameters of a Zigbee network.
109
109
  static _fields = [
110
110
  // The 802.15.4 channel associated with the network.
111
111
  ["channel", basic.uint8_t],
@@ -135,7 +135,7 @@ class EmberApsFrame extends EzspStruct {
135
135
  destinationEndpoint;
136
136
  groupId;
137
137
  options;
138
- // ZigBee APS frame parameters.
138
+ // Zigbee APS frame parameters.
139
139
  static _fields = [
140
140
  // The application profile ID that describes the format of the message.
141
141
  ["profileId", basic.uint16_t],
@@ -463,7 +463,7 @@ exports.EmberZllSecurityAlgorithmData = EmberZllSecurityAlgorithmData;
463
463
  class EmberZllNetwork extends EzspStruct {
464
464
  // The parameters of a ZLL network.
465
465
  static _fields = [
466
- // The parameters of a ZigBee network.
466
+ // The parameters of a Zigbee network.
467
467
  ["zigbeeNetwork", EmberZigbeeNetwork],
468
468
  // Data associated with the ZLL security algorithm.
469
469
  ["securityAlgorithm", EmberZllSecurityAlgorithmData],
@@ -494,7 +494,7 @@ class EmberZllInitialSecurityState extends EzspStruct {
494
494
  ["keyIndex", named.EmberZllKeyIndex],
495
495
  // The encryption key for use by algorithms that require it.
496
496
  ["encryptionKey", EmberKeyData],
497
- // The pre-configured link key used during classical ZigBee
497
+ // The pre-configured link key used during classical Zigbee
498
498
  // commissioning.
499
499
  ["preconfiguredKey", EmberKeyData],
500
500
  ];
@@ -35,7 +35,7 @@ export declare class ZnpAdapterManager {
35
35
  */
36
36
  private beginRestore;
37
37
  /**
38
- * Internal method to perform new network commissioning. Network commissioning creates a new ZigBee
38
+ * Internal method to perform new network commissioning. Network commissioning creates a new Zigbee
39
39
  * network using the adapter.
40
40
  *
41
41
  * @param nwkOptions Options to configure the new network with.
@@ -304,7 +304,7 @@ class ZnpAdapterManager {
304
304
  await this.writeConfigurationFlag();
305
305
  }
306
306
  /**
307
- * Internal method to perform new network commissioning. Network commissioning creates a new ZigBee
307
+ * Internal method to perform new network commissioning. Network commissioning creates a new Zigbee
308
308
  * network using the adapter.
309
309
  *
310
310
  * @param nwkOptions Options to configure the new network with.
@@ -1,6 +1,6 @@
1
1
  import { Struct } from "../struct";
2
2
  /**
3
- * Create a ZigBee Device Security Manager Security Material struct. This structure stores a frame counter
3
+ * Create a Zigbee Device Security Manager Security Material struct. This structure stores a frame counter
4
4
  * associated with a particular Extended PAN ID used by device. Used in NV in table format:
5
5
  * - `ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE` - extended table (SimpleLink Z-Stack 3.x.0)
6
6
  * - `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START` through `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_END` (Z-Stack 3.0.x)