matterbridge-zigbee2mqtt 2.2.0 → 2.2.2

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 (19) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +8 -6
  3. package/dist/entity.d.ts +27 -12
  4. package/dist/entity.d.ts.map +1 -1
  5. package/dist/entity.js +318 -172
  6. package/dist/entity.js.map +1 -1
  7. package/dist/platform.d.ts +6 -7
  8. package/dist/platform.d.ts.map +1 -1
  9. package/dist/platform.js +49 -79
  10. package/dist/platform.js.map +1 -1
  11. package/dist/zigbee2mqtt.d.ts +3 -2
  12. package/dist/zigbee2mqtt.d.ts.map +1 -1
  13. package/dist/zigbee2mqtt.js +30 -21
  14. package/dist/zigbee2mqtt.js.map +1 -1
  15. package/matterbridge-zigbee2mqtt.schema.json +4 -7
  16. package/npm-shrinkwrap.json +309 -5901
  17. package/package.json +3 -57
  18. package/create-release.js +0 -81
  19. package/link-matterbridge-script.js +0 -1
package/CHANGELOG.md CHANGED
@@ -4,6 +4,44 @@ If you like this project and find it useful, please consider giving it a star on
4
4
 
5
5
  All notable changes to this project will be documented in this file.
6
6
 
7
+ ## [2.2.2] - 2024-11-26
8
+
9
+ ### Added
10
+
11
+ - [thermostat]: Added min_temperature_limit and max_temperature_limit converter to thermostats.
12
+ - [thermostat]: Added min_heat_setpoint_limit and max_heat_setpoint_limit converter to thermostats.
13
+ - [thermostat]: Added configuration for heat only and cool only thermostats.
14
+ - [matter]: Added tagList to child endpoints.
15
+
16
+ ### Changed
17
+
18
+ - [mqtt]: Username and password are passed like undefined unless set.
19
+ - [readme]: Updated install script.
20
+ - [readme]: Updated build script.
21
+ - [package]: Updated dependencies.
22
+ - [plugin]: Requires Matterbridge 1.6.2.
23
+
24
+ ### Fixed
25
+
26
+ - [thermostat]: Fixed the case when instead of current_heating_setpoint the property is occupied_heating_setpoint.
27
+ - [thermostat]: Fixed the case when instead of current_cooling_setpoint the property is occupied_cooling_setpoint.
28
+
29
+ <a href="https://www.buymeacoffee.com/luligugithub">
30
+ <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
31
+ </a>
32
+
33
+ ## [2.2.1] - 2024-10-11
34
+
35
+ ### Fixed
36
+
37
+ - [entity]: Fixed propertyMap.
38
+ - [entity]: Fixed energy kWh.
39
+ - [entity]: Fixed log.
40
+
41
+ <a href="https://www.buymeacoffee.com/luligugithub">
42
+ <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
43
+ </a>
44
+
7
45
  ## [2.2.0] - 2024-10-10
8
46
 
9
47
  ### Added
package/README.md CHANGED
@@ -28,13 +28,13 @@ Follow these steps to install or update Matterbridge if it is not already instal
28
28
  on Windows:
29
29
 
30
30
  ```
31
- npm install -g matterbridge
31
+ npm install -g matterbridge --omit=dev
32
32
  ```
33
33
 
34
34
  on Linux (you need the necessary permissions):
35
35
 
36
36
  ```
37
- sudo npm install -g matterbridge
37
+ sudo npm install -g matterbridge --omit=dev
38
38
  ```
39
39
 
40
40
  See the complete guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
@@ -57,7 +57,7 @@ On windows:
57
57
 
58
58
  ```
59
59
  cd $HOME\Matterbridge
60
- npm install -g matterbridge-zigbee2mqtt
60
+ npm install -g matterbridge-zigbee2mqtt --omit=dev
61
61
  matterbridge -add matterbridge-zigbee2mqtt
62
62
  ```
63
63
 
@@ -65,7 +65,7 @@ On linux:
65
65
 
66
66
  ```
67
67
  cd ~/Matterbridge
68
- sudo npm install -g matterbridge-zigbee2mqtt
68
+ sudo npm install -g matterbridge-zigbee2mqtt --omit=dev
69
69
  matterbridge -add matterbridge-zigbee2mqtt
70
70
  ```
71
71
 
@@ -83,7 +83,8 @@ On windows:
83
83
  cd $HOME\Matterbridge
84
84
  git clone https://github.com/Luligu/matterbridge-zigbee2mqtt
85
85
  cd matterbridge-zigbee2mqtt
86
- npm install
86
+ npm ci
87
+ npm run dev:link
87
88
  npm run build
88
89
  matterbridge -add .\
89
90
  ```
@@ -94,7 +95,8 @@ On linux:
94
95
  cd ~/Matterbridge
95
96
  git clone https://github.com/Luligu/matterbridge-zigbee2mqtt
96
97
  cd matterbridge-zigbee2mqtt
97
- npm install
98
+ npm ci
99
+ npm run dev:link
98
100
  npm run build
99
101
  matterbridge -add ./
100
102
  ```
package/dist/entity.d.ts CHANGED
@@ -4,9 +4,9 @@
4
4
  * @file entity.ts
5
5
  * @author Luca Liguori
6
6
  * @date 2023-12-29
7
- * @version 3.0.1
7
+ * @version 3.1.0
8
8
  *
9
- * Copyright 2023, 2024 Luca Liguori.
9
+ * Copyright 2023, 2024, 2025 Luca Liguori.
10
10
  *
11
11
  * Licensed under the Apache License, Version 2.0 (the "License");
12
12
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
20
20
  * See the License for the specific language governing permissions and
21
21
  * limitations under the License. *
22
22
  */
23
- import { DeviceTypeDefinition, MatterbridgeDevice, ClusterId, Endpoint, AtLeastOne } from 'matterbridge';
23
+ import { DeviceTypeDefinition, MatterbridgeDevice, ClusterId, Endpoint, AtLeastOne, EndpointOptions } from 'matterbridge';
24
24
  import { AnsiLogger } from 'matterbridge/logger';
25
25
  import EventEmitter from 'events';
26
26
  import { ZigbeePlatform } from './platform.js';
@@ -38,7 +38,7 @@ export declare class ZigbeeEntity extends EventEmitter {
38
38
  actions: string[];
39
39
  protected en: string;
40
40
  protected ien: string;
41
- bridgedDevice: BridgedBaseDevice | undefined;
41
+ bridgedDevice: MatterbridgeDevice | undefined;
42
42
  eidn: string;
43
43
  private lastPayload;
44
44
  private lastSeen;
@@ -48,10 +48,32 @@ export declare class ZigbeeEntity extends EventEmitter {
48
48
  name: string;
49
49
  type: string;
50
50
  endpoint: string;
51
+ values?: string;
52
+ value_min?: number;
53
+ value_max?: number;
54
+ unit?: string;
51
55
  action?: string;
52
56
  }>;
57
+ colorTimeout: NodeJS.Timeout | undefined;
58
+ thermostatTimeout: NodeJS.Timeout | undefined;
59
+ protected hasEndpoints: boolean;
60
+ isRouter: boolean;
61
+ protected noUpdate: boolean;
62
+ createDevice(definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, includeServerList?: ClusterId[], options?: EndpointOptions, debug?: boolean): MatterbridgeDevice;
63
+ configure(): void;
64
+ /**
65
+ * Retrieves the value of the specified attribute from the given endpoint and cluster.
66
+ *
67
+ * @param {ClusterId} clusterId - The ID of the cluster to retrieve the attribute from.
68
+ * @param {string} event - The name of the event to trigger.
69
+ * @param {Record<string, any>} payload - The payload of the event to trigger.
70
+ * @param {AnsiLogger} [log] - Optional logger for error and info messages.
71
+ * @param {Endpoint} [endpoint] - Optional the child endpoint to retrieve the attribute from.
72
+ */
73
+ triggerEvent(clusterId: ClusterId, event: string, payload: Record<string, any>, log?: AnsiLogger, endpoint?: Endpoint): void;
53
74
  constructor(platform: ZigbeePlatform, entity: BridgeDevice | BridgeGroup);
54
- protected updateAttributeIfChanged(rootEndpoint: Endpoint, endpointName: string | undefined, clusterId: number, attributeName: string, value: PayloadValue, lookup?: string[]): void;
75
+ destroy(): void;
76
+ protected updateAttributeIfChanged(deviceEndpoint: Endpoint, childEndpointName: string | undefined, clusterId: number, attributeName: string, value: PayloadValue, lookup?: string[]): void;
55
77
  protected publishCommand(command: string, entityName: string, payload: Payload): void;
56
78
  }
57
79
  export declare class ZigbeeGroup extends ZigbeeEntity {
@@ -71,11 +93,4 @@ export declare const z2ms: ZigbeeToMatter[];
71
93
  export declare class ZigbeeDevice extends ZigbeeEntity {
72
94
  constructor(platform: ZigbeePlatform, device: BridgeDevice);
73
95
  }
74
- export declare class BridgedBaseDevice extends MatterbridgeDevice {
75
- hasEndpoints: boolean;
76
- isRouter: boolean;
77
- noUpdate: boolean;
78
- constructor(entity: ZigbeeEntity, definition: AtLeastOne<DeviceTypeDefinition>, includeServerList?: ClusterId[], includeClientList?: ClusterId[]);
79
- configure(): void;
80
- }
81
96
  //# sourceMappingURL=entity.d.ts.map
package/dist/entity.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAEL,oBAAoB,EACpB,kBAAkB,EAiBlB,SAAS,EAMT,QAAQ,EACR,UAAU,EAoBX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAiG,MAAM,qBAAqB,CAAC;AAIhJ,OAAO,YAAY,MAAM,QAAQ,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE1D,qBAAa,YAAa,SAAQ,YAAY;IACrC,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,SAAM;IACnB,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,UAAU,SAAM;IAChB,QAAQ,UAAS;IACjB,OAAO,UAAS;IAChB,OAAO,EAAE,MAAM,EAAE,CAAM;IAC9B,SAAS,CAAC,EAAE,SAAM;IAClB,SAAS,CAAC,GAAG,SAAM;IACZ,aAAa,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,IAAI,SAAW;IACtB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,QAAQ,CAAK;IACrB,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,CAAM;IACxC,SAAS,CAAC,UAAU,UAAS;IAC7B,SAAS,CAAC,WAAW;cAA2B,MAAM;cAAQ,MAAM;kBAAY,MAAM;iBAAW,MAAM;OAAM;gBAEjG,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,GAAG,WAAW;IA4JxE,SAAS,CAAC,wBAAwB,CAAC,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAyCpL,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAQ/E;AAED,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW;CAoRzD;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAGD,eAAO,MAAM,IAAI,EAAE,cAAc,EAmDhC,CAAC;AAEF,qBAAa,YAAa,SAAQ,YAAY;gBAChC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY;CA8Z3D;AAED,qBAAa,iBAAkB,SAAQ,kBAAkB;IAChD,YAAY,UAAS;IACrB,QAAQ,UAAS;IACjB,QAAQ,UAAS;gBAGZ,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,GAAE,SAAS,EAAO,EAAE,iBAAiB,CAAC,EAAE,SAAS,EAAE;IAwBpJ,SAAS;CAYV"}
1
+ {"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAEL,oBAAoB,EACpB,kBAAkB,EAiBlB,SAAS,EAMT,QAAQ,EACR,UAAU,EAmBV,eAAe,EAGhB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAiG,MAAM,qBAAqB,CAAC;AAIhJ,OAAO,YAAY,MAAM,QAAQ,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE1D,qBAAa,YAAa,SAAQ,YAAY;IACrC,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,SAAM;IACnB,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,UAAU,SAAM;IAChB,QAAQ,UAAS;IACjB,OAAO,UAAS;IAChB,OAAO,EAAE,MAAM,EAAE,CAAM;IAC9B,SAAS,CAAC,EAAE,SAAM;IAClB,SAAS,CAAC,GAAG,SAAM;IAEZ,aAAa,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC9C,IAAI,SAAW;IACtB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,QAAQ,CAAK;IACrB,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,CAAM;IACxC,SAAS,CAAC,UAAU,UAAS;IAC7B,SAAS,CAAC,WAAW;cAA2B,MAAM;cAAQ,MAAM;kBAAY,MAAM;iBAAW,MAAM;oBAAc,MAAM;oBAAc,MAAM;eAAS,MAAM;iBAAW,MAAM;OAAM;IAErL,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAa;IACrD,iBAAiB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAa;IAE1D,SAAS,CAAC,YAAY,UAAS;IACxB,QAAQ,UAAS;IACxB,SAAS,CAAC,QAAQ,UAAS;IAG3B,YAAY,CAAC,UAAU,EAAE,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,GAAE,SAAS,EAAO,EAAE,OAAO,CAAC,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,OAAO;IAyBjK,SAAS;IAkBT;;;;;;;;OAQG;IAEH,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,QAAQ;gBA0BzG,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,GAAG,WAAW;IAuKxE,OAAO;IAOP,SAAS,CAAC,wBAAwB,CAAC,cAAc,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IA+C3L,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAQ/E;AAED,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW;CAmRzD;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAGD,eAAO,MAAM,IAAI,EAAE,cAAc,EAyDhC,CAAC;AAEF,qBAAa,YAAa,SAAQ,YAAY;gBAChC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY;CA8e3D"}