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
@@ -4,7 +4,7 @@ exports.nwkSecMaterialDescriptorEntry = void 0;
4
4
  const struct_1 = require("../struct");
5
5
  const emptyExtendedPanId = Buffer.alloc(8, 0x00);
6
6
  /**
7
- * Create a ZigBee Device Security Manager Security Material struct. This structure stores a frame counter
7
+ * Create a Zigbee Device Security Manager Security Material struct. This structure stores a frame counter
8
8
  * associated with a particular Extended PAN ID used by device. Used in NV in table format:
9
9
  * - `ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE` - extended table (SimpleLink Z-Stack 3.x.0)
10
10
  * - `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START` through `ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_END` (Z-Stack 3.0.x)
@@ -37,7 +37,7 @@ exports.ZiGateMessage = {
37
37
  // 3 = Command failed
38
38
  // 4 = Busy (Node is carrying out a lengthy operation and is currently unable to handle the incoming command)
39
39
  // 5 = Stack already started (no new configuration accepted)
40
- // 128 – 244 = Failed (ZigBee event codes)
40
+ // 128 – 244 = Failed (Zigbee event codes)
41
41
  // Packet Type: The value of the initiating command request.
42
42
  { name: "sequence", parameterType: parameterType_1.default.UINT8 }, // <sequence number: uint8_t>
43
43
  { name: "packetType", parameterType: parameterType_1.default.UINT16 }, // <Packet Type: uint16_t>
@@ -170,7 +170,7 @@ exports.ZiGateMessage = {
170
170
  // Status:
171
171
  // 0 = Joined existing network
172
172
  // 1 = Formed new network
173
- // 128 – 244 = Failed (ZigBee event codes)
173
+ // 128 – 244 = Failed (Zigbee event codes)
174
174
  { name: "shortAddress", parameterType: parameterType_1.default.UINT16 }, // <short address: uint16_t>
175
175
  // {name: 'extendedAddress', parameterType: ParameterType.IEEEADDR}, // <extended address:uint64_t>
176
176
  // {name: 'channel', parameterType: ParameterType.UINT8}, // <channel: uint8_t>
@@ -274,7 +274,7 @@ class ZoHAdapter extends adapter_1.Adapter {
274
274
  }
275
275
  async getCoordinatorVersion() {
276
276
  return await Promise.resolve({
277
- type: "ZigBee on Host",
277
+ type: "Zigbee on Host",
278
278
  meta: {
279
279
  major: this.driver.protocolVersionMajor,
280
280
  minor: this.driver.protocolVersionMinor,
@@ -296,7 +296,7 @@ class ZoHAdapter extends adapter_1.Adapter {
296
296
  /* v8 ignore stop */
297
297
  /* v8 ignore start */
298
298
  async backup(_ieeeAddressesInDatabase) {
299
- return await Promise.reject(new Error("ZigBee on Host handles backup internally"));
299
+ return await Promise.reject(new Error("Zigbee on Host handles backup internally"));
300
300
  }
301
301
  /* v8 ignore stop */
302
302
  async getNetworkParameters() {
@@ -838,7 +838,7 @@ class Device extends entity_1.default {
838
838
  if (nodeDescriptor.serverMask.stackComplianceRevision < ZSpec.ZIGBEE_REVISION - 1) {
839
839
  // always 0 before revision 21 where field was added
840
840
  const rev = nodeDescriptor.serverMask.stackComplianceRevision < 21 ? "pre-21" : nodeDescriptor.serverMask.stackComplianceRevision;
841
- logger_1.logger.info(`Device '${this.ieeeAddr}' is only compliant to revision '${rev}' of the ZigBee specification (current revision: ${ZSpec.ZIGBEE_REVISION}).`, NS);
841
+ logger_1.logger.info(`Device '${this.ieeeAddr}' is only compliant to revision '${rev}' of the Zigbee specification (current revision: ${ZSpec.ZIGBEE_REVISION}).`, NS);
842
842
  }
843
843
  }
844
844
  async updateActiveEndpoints() {
@@ -1,7 +1,7 @@
1
1
  import type { ExtendedPanId } from "./tstypes";
2
2
  /** Current supported Zigbee revision: https://csa-iot.org/wp-content/uploads/2023/04/05-3474-23-csg-zigbee-specification-compressed.pdf */
3
3
  export declare const ZIGBEE_REVISION = 23;
4
- /** The network ID of the coordinator in a ZigBee network is 0x0000. */
4
+ /** The network ID of the coordinator in a Zigbee network is 0x0000. */
5
5
  export declare const COORDINATOR_ADDRESS = 0;
6
6
  /** Endpoint profile ID for Zigbee 3.0. "Home Automation" */
7
7
  export declare const HA_PROFILE_ID = 260;
@@ -9,7 +9,7 @@ export declare const HA_PROFILE_ID = 260;
9
9
  export declare const SE_PROFILE_ID = 265;
10
10
  /** Endpoint profile ID for Green Power */
11
11
  export declare const GP_PROFILE_ID = 41440;
12
- /** The touchlink (ZigBee Light Link/ZLL) Profile ID. */
12
+ /** The touchlink (Zigbee Light Link/ZLL) Profile ID. */
13
13
  export declare const TOUCHLINK_PROFILE_ID = 49246;
14
14
  /** The profile ID used to address all the public profiles. */
15
15
  export declare const WILDCARD_PROFILE_ID = 65535;
@@ -17,7 +17,7 @@ export declare const WILDCARD_PROFILE_ID = 65535;
17
17
  export declare const CUSTOM_SHELLY_PROFILE_ID = 49153;
18
18
  /** The default HA endpoint. */
19
19
  export declare const HA_ENDPOINT = 1;
20
- /** The GP endpoint, as defined in the ZigBee spec. */
20
+ /** The GP endpoint, as defined in the Zigbee spec. */
21
21
  export declare const GP_ENDPOINT = 242;
22
22
  export declare const GP_GROUP_ID = 2948;
23
23
  /** The maximum 802.15.4 channel number is 26. */
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.INSTALL_CODE_CRC_SIZE = exports.INSTALL_CODE_SIZES = exports.AES_MMO_128_BLOCK_SIZE = exports.DEFAULT_ENCRYPTION_KEY_SIZE = exports.EXTENDED_PAN_ID_SIZE = exports.PAN_ID_SIZE = exports.EUI64_SIZE = exports.PERMIT_JOIN_MAX_TIMEOUT = exports.PERMIT_JOIN_FOREVER = exports.INTEROPERABILITY_LINK_KEY = exports.NULL_BINDING = exports.NULL_NODE_ID = exports.INVALID_PAN_ID = exports.INVALID_CLUSTER_ID = exports.INVALID_PROFILE_ID = exports.BLANK_EXTENDED_PAN_ID = exports.BLANK_EUI64 = exports.PREFERRED_802_15_4_CHANNELS = exports.ALL_802_15_4_CHANNELS = exports.PREFERRED_802_15_4_CHANNELS_MASK = exports.ALL_802_15_4_CHANNELS_MASK = exports.NUM_802_15_4_CHANNELS = exports.MIN_802_15_4_CHANNEL_NUMBER = exports.MAX_802_15_4_CHANNEL_NUMBER = exports.GP_GROUP_ID = exports.GP_ENDPOINT = exports.HA_ENDPOINT = exports.CUSTOM_SHELLY_PROFILE_ID = exports.WILDCARD_PROFILE_ID = exports.TOUCHLINK_PROFILE_ID = exports.GP_PROFILE_ID = exports.SE_PROFILE_ID = exports.HA_PROFILE_ID = exports.COORDINATOR_ADDRESS = exports.ZIGBEE_REVISION = void 0;
4
4
  /** Current supported Zigbee revision: https://csa-iot.org/wp-content/uploads/2023/04/05-3474-23-csg-zigbee-specification-compressed.pdf */
5
5
  exports.ZIGBEE_REVISION = 23;
6
- /** The network ID of the coordinator in a ZigBee network is 0x0000. */
6
+ /** The network ID of the coordinator in a Zigbee network is 0x0000. */
7
7
  exports.COORDINATOR_ADDRESS = 0x0000;
8
8
  /** Endpoint profile ID for Zigbee 3.0. "Home Automation" */
9
9
  exports.HA_PROFILE_ID = 0x0104;
@@ -11,7 +11,7 @@ exports.HA_PROFILE_ID = 0x0104;
11
11
  exports.SE_PROFILE_ID = 0x0109;
12
12
  /** Endpoint profile ID for Green Power */
13
13
  exports.GP_PROFILE_ID = 0xa1e0;
14
- /** The touchlink (ZigBee Light Link/ZLL) Profile ID. */
14
+ /** The touchlink (Zigbee Light Link/ZLL) Profile ID. */
15
15
  exports.TOUCHLINK_PROFILE_ID = 0xc05e;
16
16
  /** The profile ID used to address all the public profiles. */
17
17
  exports.WILDCARD_PROFILE_ID = 0xffff;
@@ -19,7 +19,7 @@ exports.WILDCARD_PROFILE_ID = 0xffff;
19
19
  exports.CUSTOM_SHELLY_PROFILE_ID = 0xc001;
20
20
  /** The default HA endpoint. */
21
21
  exports.HA_ENDPOINT = 0x01;
22
- /** The GP endpoint, as defined in the ZigBee spec. */
22
+ /** The GP endpoint, as defined in the Zigbee spec. */
23
23
  exports.GP_ENDPOINT = 0xf2;
24
24
  exports.GP_GROUP_ID = 0x0b84;
25
25
  /** The maximum 802.15.4 channel number is 26. */
@@ -1,7 +1,7 @@
1
1
  /**
2
- * ZigBee Broadcast Addresses
2
+ * Zigbee Broadcast Addresses
3
3
  *
4
- * ZigBee specifies three different broadcast addresses that reach different collections of nodes.
4
+ * Zigbee specifies three different broadcast addresses that reach different collections of nodes.
5
5
  * Broadcasts are normally sent only to routers.
6
6
  * Broadcasts can also be forwarded to end devices, either all of them or only those that do not sleep.
7
7
  * Broadcasting to end devices is both significantly more resource-intensive and significantly less reliable than broadcasting to routers.
@@ -2,9 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.BroadcastAddress = void 0;
4
4
  /**
5
- * ZigBee Broadcast Addresses
5
+ * Zigbee Broadcast Addresses
6
6
  *
7
- * ZigBee specifies three different broadcast addresses that reach different collections of nodes.
7
+ * Zigbee specifies three different broadcast addresses that reach different collections of nodes.
8
8
  * Broadcasts are normally sent only to routers.
9
9
  * Broadcasts can also be forwarded to end devices, either all of them or only those that do not sleep.
10
10
  * Broadcasting to end devices is both significantly more resource-intensive and significantly less reliable than broadcasting to routers.
@@ -10,7 +10,7 @@ export type NodeId = number;
10
10
  export type PanId = number;
11
11
  /** PAN 64-bit ID (IEEE 802.15.4 long address). uint8[EXTENDED_PAN_ID_SIZE] */
12
12
  export type ExtendedPanId = number[];
13
- /** 16-bit ZigBee multicast group identifier. uint16 */
13
+ /** 16-bit Zigbee multicast group identifier. uint16 */
14
14
  export type MulticastId = number;
15
15
  /** Refer to the Zigbee application profile ID. uint16 */
16
16
  export type ProfileId = number;
@@ -45,7 +45,7 @@ export declare function crc16X25(data: number[] | Uint8Array | Buffer): number;
45
45
  *
46
46
  * Shortcut for `calcCRC(data, 16, 0x1021)`
47
47
  *
48
- * Used for XMODEM transfers, often involved in ZigBee environments
48
+ * Used for XMODEM transfers, often involved in Zigbee environments
49
49
  */
50
50
  export declare function crc16XMODEM(data: number[] | Uint8Array | Buffer): number;
51
51
  /**
@@ -137,7 +137,7 @@ function crc16X25(data) {
137
137
  *
138
138
  * Shortcut for `calcCRC(data, 16, 0x1021)`
139
139
  *
140
- * Used for XMODEM transfers, often involved in ZigBee environments
140
+ * Used for XMODEM transfers, often involved in Zigbee environments
141
141
  */
142
142
  function crc16XMODEM(data) {
143
143
  return calcCRC(data, 16, 0x1021);
@@ -1 +1 @@
1
- {"version":3,"file":"cluster.d.ts","sourceRoot":"","sources":["../../../../src/zspec/zcl/definition/cluster.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AAE7D,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAg8L/E,CAAC"}
1
+ {"version":3,"file":"cluster.d.ts","sourceRoot":"","sources":["../../../../src/zspec/zcl/definition/cluster.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AAE7D,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAizL/E,CAAC"}
@@ -3291,7 +3291,10 @@ exports.Clusters = {
3291
3291
  },
3292
3292
  initTestMode: {
3293
3293
  ID: 2,
3294
- parameters: [],
3294
+ parameters: [
3295
+ { name: "testModeDuration", type: enums_1.DataType.UINT8 },
3296
+ { name: "currentZoneSensitivityLevel", type: enums_1.DataType.UINT8 },
3297
+ ],
3295
3298
  },
3296
3299
  },
3297
3300
  commandsResponse: {
@@ -5368,74 +5371,6 @@ exports.Clusters = {
5368
5371
  commands: {},
5369
5372
  commandsResponse: {},
5370
5373
  },
5371
- heimanSpecificAirQuality: {
5372
- // from HS2AQ-3.0海曼智能空气质量检测仪API文档-V01
5373
- ID: 0xfc81,
5374
- manufacturerCode: manufacturerCode_1.ManufacturerCode.HEIMAN_TECHNOLOGY_CO_LTD,
5375
- attributes: {
5376
- language: { ID: 0xf000, type: enums_1.DataType.UINT8 },
5377
- unitOfMeasure: { ID: 0xf001, type: enums_1.DataType.UINT8 },
5378
- batteryState: { ID: 0xf002, type: enums_1.DataType.UINT8 }, // (0 is not charged, 1 is charging, 2 is fully charged)
5379
- pm10measuredValue: { ID: 0xf003, type: enums_1.DataType.UINT16 },
5380
- tvocMeasuredValue: { ID: 0xf004, type: enums_1.DataType.UINT16 },
5381
- aqiMeasuredValue: { ID: 0xf005, type: enums_1.DataType.UINT16 },
5382
- temperatureMeasuredMax: { ID: 0xf006, type: enums_1.DataType.INT16 },
5383
- temperatureMeasuredMin: { ID: 0xf007, type: enums_1.DataType.INT16 },
5384
- humidityMeasuredMax: { ID: 0xf008, type: enums_1.DataType.UINT16 },
5385
- humidityMeasuredMin: { ID: 0xf009, type: enums_1.DataType.UINT16 },
5386
- alarmEnable: { ID: 0xf00a, type: enums_1.DataType.UINT16 },
5387
- },
5388
- commands: {
5389
- setLanguage: {
5390
- ID: 0x011b,
5391
- parameters: [
5392
- // (1: English 0: Chinese)
5393
- { name: "languageCode", type: enums_1.DataType.UINT8 },
5394
- ],
5395
- },
5396
- setUnitOfTemperature: {
5397
- ID: 0x011c,
5398
- parameters: [
5399
- // (0: ℉ 1: ℃)
5400
- { name: "unitsCode", type: enums_1.DataType.UINT8 },
5401
- ],
5402
- },
5403
- getTime: {
5404
- ID: 0x011d,
5405
- parameters: [],
5406
- },
5407
- },
5408
- commandsResponse: {},
5409
- },
5410
- heimanSpecificScenes: {
5411
- // from HS2SS-3.0海曼智能情景开关API文档-V01
5412
- ID: 0xfc80,
5413
- manufacturerCode: manufacturerCode_1.ManufacturerCode.HEIMAN_TECHNOLOGY_CO_LTD,
5414
- attributes: {},
5415
- commands: {
5416
- cinema: {
5417
- ID: 0xf0,
5418
- parameters: [],
5419
- },
5420
- atHome: {
5421
- ID: 0xf1,
5422
- parameters: [],
5423
- },
5424
- sleep: {
5425
- ID: 0xf2,
5426
- parameters: [],
5427
- },
5428
- goOut: {
5429
- ID: 0xf3,
5430
- parameters: [],
5431
- },
5432
- repast: {
5433
- ID: 0xf4,
5434
- parameters: [],
5435
- },
5436
- },
5437
- commandsResponse: {},
5438
- },
5439
5374
  tradfriButton: {
5440
5375
  ID: 0xfc80,
5441
5376
  manufacturerCode: manufacturerCode_1.ManufacturerCode.IKEA_OF_SWEDEN,
@@ -5464,84 +5399,6 @@ exports.Clusters = {
5464
5399
  },
5465
5400
  commandsResponse: {},
5466
5401
  },
5467
- heimanSpecificInfraRedRemote: {
5468
- // from HS2IRC-3.0海曼智能红外转发控制器API-V01文档
5469
- ID: 0xfc82,
5470
- manufacturerCode: manufacturerCode_1.ManufacturerCode.HEIMAN_TECHNOLOGY_CO_LTD,
5471
- attributes: {},
5472
- commands: {
5473
- sendKey: {
5474
- ID: 0xf0,
5475
- parameters: [
5476
- { name: "id", type: enums_1.DataType.UINT8 },
5477
- { name: "keyCode", type: enums_1.DataType.UINT8 },
5478
- ],
5479
- },
5480
- studyKey: {
5481
- // Total we can have 30 keycode for each device ID (1..30).
5482
- ID: 0xf1,
5483
- // response: 0xf2,
5484
- parameters: [
5485
- { name: "id", type: enums_1.DataType.UINT8 },
5486
- { name: "keyCode", type: enums_1.DataType.UINT8 },
5487
- ],
5488
- },
5489
- deleteKey: {
5490
- ID: 0xf3,
5491
- parameters: [
5492
- // 1-15 - Delete specific ID, >= 16 - Delete All
5493
- { name: "id", type: enums_1.DataType.UINT8 },
5494
- // 1-30 - Delete specific keycode, >= 31 - Delete All keycodes for the ID
5495
- { name: "keyCode", type: enums_1.DataType.UINT8 },
5496
- ],
5497
- },
5498
- createId: {
5499
- // Total we can have 15 device IDs (1..15).
5500
- ID: 0xf4,
5501
- // response: 0xf5,
5502
- parameters: [{ name: "modelType", type: enums_1.DataType.UINT8 }],
5503
- },
5504
- getIdAndKeyCodeList: {
5505
- ID: 0xf6,
5506
- // response: 0xf7,
5507
- parameters: [],
5508
- },
5509
- },
5510
- commandsResponse: {
5511
- studyKeyRsp: {
5512
- ID: 0xf2,
5513
- parameters: [
5514
- { name: "id", type: enums_1.DataType.UINT8 },
5515
- { name: "keyCode", type: enums_1.DataType.UINT8 },
5516
- { name: "result", type: enums_1.DataType.UINT8 }, // 0 - success, 1 - fail
5517
- ],
5518
- },
5519
- createIdRsp: {
5520
- ID: 0xf5,
5521
- parameters: [
5522
- { name: "id", type: enums_1.DataType.UINT8 }, // 0xFF - create failed
5523
- { name: "modelType", type: enums_1.DataType.UINT8 },
5524
- ],
5525
- },
5526
- getIdAndKeyCodeListRsp: {
5527
- ID: 0xf7,
5528
- parameters: [
5529
- { name: "packetsTotal", type: enums_1.DataType.UINT8 },
5530
- { name: "packetNumber", type: enums_1.DataType.UINT8 },
5531
- { name: "packetLength", type: enums_1.DataType.UINT8 }, // Max length is 70 bytes
5532
- // HELP for learnedDevicesList data structure:
5533
- // struct structPacketPayload {
5534
- // uint8_t ID;
5535
- // uint8_t ModeType;
5536
- // uint8_t KeyNum;
5537
- // uint8_t KeyCode[KeyNum];
5538
- // } arayPacketPayload[CurentPacketLenght];
5539
- // }
5540
- { name: "learnedDevicesList", type: enums_1.BuffaloZclDataType.LIST_UINT8 },
5541
- ],
5542
- },
5543
- },
5544
- },
5545
5402
  schneiderSpecificPilotMode: {
5546
5403
  ID: 0xff23,
5547
5404
  manufacturerCode: manufacturerCode_1.ManufacturerCode.SCHNEIDER_ELECTRIC,