feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands #6921

AlCalzone · 2024-06-12T20:12:20Z

It has been found that the encoding of the Meter CC Reset command in version 6 was different from the specification. As a result, the MeterCCResetOptions type had to be changed, because all 4 fields are required to send a V6 command:

	type: number;
	scale: number;
	rateType: RateType;
	targetValue: number;

This also means the MeterCCAPI.reset(options) method signature has changed.

Further changes in this PR:

The reset values for single meters now refer to a combination of meter type/scale/rate type and are only created for accumulated scales, since others cannot be reset. This will leave some orphaned values that need a re-interview to be removed.
The reset value for all accumulated values now only refreshes accumulated values after the reset.
The MeterCCReport and MeterCCSupportedReport can now be sent via the MeterCCAPI
Implementations for the mock-server have been added for Meter CC.
The SET_VALUE_HOOKS mechanism is now used to update and verify value changes after a reset.

fixes: #6794

… for report commands (#6921)

… for report commands (#6921) fixes: #6794

### Breaking changes · [Migration guide](https://zwave-js.github.io/node-zwave-js/#/getting-started/migrating-to-v13) * Align Meter CC Reset v6 with specifications, add mocks, add API for report commands (#6921) * Convert all Z-Wave specific configs except devices and manufacturers into code, move from ConfigManager methods to utility functions (#6925, #6929) * Remove `ZWaveApplicationHost` dependency from `CommandClass.toLogEntry()` (#6927) * Removed some deprecated things (#6928) * Replace `Controller.isAssociationAllowed` with `Controller.checkAssociation` (#6935) * Fixed health checks for ZWLR nodes, throw when requesting neighbors (#6939) * The repo now uses Yarn 4 and Corepack to manage its dependencies (#6949)

### Breaking changes · [Migration guide](https://zwave-js.github.io/node-zwave-js/#/getting-started/migrating-to-v13) * Align Meter CC Reset v6 with specifications, add mocks, add API for report commands (#6921) * Convert all Z-Wave specific configs except devices and manufacturers into code, move from ConfigManager methods to utility functions (#6925, #6929) * Remove `ZWaveApplicationHost` dependency from `CommandClass.toLogEntry()` (#6927) * Removed some deprecated things (#6928) * Replace `Controller.isAssociationAllowed` with `Controller.checkAssociation` (#6935) * Fixed health checks for ZWLR nodes, throw when requesting neighbors (#6939) * The repo now uses Yarn 4 and Corepack to manage its dependencies (#6949) ### Changes under the hood * Upgrade to TypeScript 5.5 (#6919) * The root `tsconfig.json` is now set up in "solution-style", which should improve the goto references functionality. In addition, linting, testing and running locally no longer requires all modules to be compiled first. (#6748)

### Breaking changes · [Migration guide](https://zwave-js.github.io/node-zwave-js/#/getting-started/migrating-to-v13) * Align Meter CC Reset v6 with specifications, add mocks, add API for report commands (#6921) * Convert all Z-Wave specific configs except devices and manufacturers into code, move from ConfigManager methods to utility functions (#6925, #6929) * Remove `ZWaveApplicationHost` dependency from `CommandClass.toLogEntry()` (#6927) * Removed some deprecated things (#6928) * Replace `Controller.isAssociationAllowed` with `Controller.checkAssociation` (#6935) * Fixed health checks for ZWLR nodes, throw when requesting neighbors (#6939) * The repo now uses Yarn 4 and Corepack to manage its dependencies (#6949) * "Master Code" was renamed to "Admin Code" (#6995) ### Config file changes * Update Zooz ZEN30 to latest revisions (#6630) * Support MCO Home MH-S412 parameters properly (#6623) * Add Ring Flood Freeze Sensor (#6970) * Override user code count for Yale ZW2 locks to expose admin code (#6528) * Add GDZW7-ECO Ecolink 700 Series Garage Door Controller (#6572) * Correct label for Remote 3-Way Switch parameter on Zooz ZEN32 (#6871) * Add UltraPro 700 Series Z-Wave In-Wall Smart Dimmer (#6904) * Add Yale Assure 2 Biometric Deadbolt locks (#6972) * Add iDevices In-Wall Smart Dimmer (#5521) * Support Comet parameters properly (#6583) * Update label of Nortek GD00Z-6, -7, -8 (#6991) * Disable Supervision for Zooz ZSE11 (#6990) * Clarify parameters and units for Everspring AN158 (#6364) * Force-add support for Multilevel Switch CC to FGRM-222, remove Binary Switch CC (#6986) ### Changes under the hood * Upgrade to TypeScript 5.5 (#6919) * The root `tsconfig.json` is now set up in "solution-style", which should improve the goto references functionality. In addition, linting, testing and running locally no longer requires all modules to be compiled first. (#6748) * Fixed some minor issues found by code scanning (#6992) * Fixed an issue where `yarn codefind` was loading no source files (#6993) * Fixed an issue where `import(...)` types with absolute paths could appear in in CC docs (#6996)

### Breaking changes · [Migration guide](https://zwave-js.github.io/node-zwave-js/#/getting-started/migrating-to-v13) * Align Meter CC Reset v6 with specifications, add mocks, add API for report commands (#6921) * Convert all Z-Wave specific configs except devices and manufacturers into code, move from ConfigManager methods to utility functions (#6925, #6929) * Remove `ZWaveApplicationHost` dependency from `CommandClass.toLogEntry()` (#6927) * Removed some deprecated things (#6928) * Replace `Controller.isAssociationAllowed` with `Controller.checkAssociation` (#6935) * Fixed health checks for ZWLR nodes, throw when requesting neighbors (#6939) * The repo now uses Yarn 4 and Corepack to manage its dependencies (#6949) * "Master Code" was renamed to "Admin Code" (#6995) ### Features * `mock-server` now supports communication with endpoints (#7005) ### Config file changes * Update Zooz ZEN30 to latest revisions (#6630) * Support MCO Home MH-S412 parameters properly (#6623) * Add Ring Flood Freeze Sensor (#6970) * Override user code count for Yale ZW2 locks to expose admin code (#6528) * Add GDZW7-ECO Ecolink 700 Series Garage Door Controller (#6572) * Correct label for Remote 3-Way Switch parameter on Zooz ZEN32 (#6871) * Add UltraPro 700 Series Z-Wave In-Wall Smart Dimmer (#6904) * Add Yale Assure 2 Biometric Deadbolt locks (#6972) * Add iDevices In-Wall Smart Dimmer (#5521) * Support Comet parameters properly (#6583) * Update label of Nortek GD00Z-6, -7, -8 (#6991) * Disable Supervision for Zooz ZSE11 (#6990) * Clarify parameters and units for Everspring AN158 (#6364) * Force-add support for Multilevel Switch CC to FGRM-222, remove Binary Switch CC (#6986) ### Changes under the hood * Upgrade to TypeScript 5.5 (#6919) * The root `tsconfig.json` is now set up in "solution-style", which should improve the goto references functionality. In addition, linting, testing and running locally no longer requires all modules to be compiled first. (#6748) * Fixed some minor issues found by code scanning (#6992) * Fixed an issue where `yarn codefind` was loading no source files (#6993) * Fixed an issue where `import(...)` types with absolute paths could appear in in CC docs (#6996)

### Application compatibility Home Assistant users who manage `zwave-js-server` themselves, **must** install the following upgrades before upgrading to this driver version: * Home Assistant **TBD** or higher * `zwave-js-server` **1.37.0** ### Breaking changes · [Migration guide](https://zwave-js.github.io/node-zwave-js/#/getting-started/migrating-to-v13) * Align Meter CC Reset v6 with specifications, add mocks, add API for report commands (#6921) * Convert all Z-Wave specific configs except devices and manufacturers into code, move from ConfigManager methods to utility functions (#6925, #6929, #7023) * Remove `ZWaveApplicationHost` dependency from `CommandClass.toLogEntry()` (#6927) * Removed some deprecated things (#6928) * Replace `Controller.isAssociationAllowed` with `Controller.checkAssociation` (#6935) * Fixed health checks for ZWLR nodes, throw when requesting neighbors (#6939) * The repo now uses Yarn 4 and Corepack to manage its dependencies (#6949) * "Master Code" was renamed to "Admin Code" (#6995) ### Features * `mock-server` now supports communication with endpoints (#7005) ### Bugfixes * Reset aborted flags when starting link reliability or route health check (#7022) ### Config file changes * Update Zooz ZEN30 to latest revisions (#6630) * Support MCO Home MH-S412 parameters properly (#6623) * Add Ring Flood Freeze Sensor (#6970) * Override user code count for Yale ZW2 locks to expose admin code (#6528) * Add GDZW7-ECO Ecolink 700 Series Garage Door Controller (#6572) * Correct label for Remote 3-Way Switch parameter on Zooz ZEN32 (#6871) * Add UltraPro 700 Series Z-Wave In-Wall Smart Dimmer (#6904) * Add Yale Assure 2 Biometric Deadbolt locks (#6972) * Add iDevices In-Wall Smart Dimmer (#5521) * Support Comet parameters properly (#6583) * Update label of Nortek GD00Z-6, -7, -8 (#6991) * Disable Supervision for Zooz ZSE11 (#6990) * Clarify parameters and units for Everspring AN158 (#6364) * Force-add support for Multilevel Switch CC to FGRM-222, remove Binary Switch CC (#6986) * Add ZVIDAR Z-PI 800 Series PI Module (#7018) ### Changes under the hood * Upgrade to TypeScript 5.5 (#6919) * The root `tsconfig.json` is now set up in "solution-style", which should improve the goto references functionality. In addition, linting, testing and running locally no longer requires all modules to be compiled first. (#6748) * Fixed some minor issues found by code scanning (#6992) * Fixed an issue where `yarn codefind` was loading no source files (#6993) * Fixed an issue where `import(...)` types with absolute paths could appear in in CC docs (#6996)

AlCalzone added the breaking This is a breaking change label Jun 12, 2024

This was referenced Jun 12, 2024

Z-Wave JS: Certification requirements for Meter CC not fulfilled zwave-js/certification-backlog#17

Open

Z-Wave JS: meter_reset service call issues the reset command multiple times, does not refresh values home-assistant/core#116222

Open

AlCalzone changed the title ~~feat: align Meter CC Reset with specifications, add mocks, add API for report commands~~ feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands Jun 12, 2024

AlCalzone marked this pull request as draft June 12, 2024 20:14

AlCalzone added 3 commits June 14, 2024 13:57

fix: discrepancies of Meter CC from specifications

33c0f5a

feat: add mock implementation for Meter CC

87797aa

fix: test

bf47a52

AlCalzone force-pushed the fix-meter-cc branch from ea92e38 to bf47a52 Compare June 14, 2024 12:03

AlCalzone marked this pull request as ready for review June 14, 2024 12:09

fix: use SET_VALUE_HOOKS to update Meter values after reset

030fd4b

AlCalzone changed the base branch from master to v13 June 14, 2024 13:02

AlCalzone merged commit dd17a67 into v13 Jun 14, 2024
17 checks passed

AlCalzone deleted the fix-meter-cc branch June 14, 2024 18:56

AlCalzone linked an issue Jun 16, 2024 that may be closed by this pull request

Supervised Meter CC Reset does not update values #6794

Closed

AlCalzone added a commit that referenced this pull request Jun 17, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

6aad5ae

… for report commands (#6921)

AlCalzone added a commit that referenced this pull request Jun 17, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

68c7652

… for report commands (#6921)

AlCalzone added a commit that referenced this pull request Jun 21, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

d1e28b0

… for report commands (#6921)

AlCalzone added a commit that referenced this pull request Jun 24, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

5e1e57a

… for report commands (#6921)

AlCalzone added a commit that referenced this pull request Jul 5, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

4e2c47f

… for report commands (#6921)

AlCalzone added a commit that referenced this pull request Jul 5, 2024

feat: align Meter CC Reset v6 with specifications, add mocks, add API…

3b6eb15

… for report commands (#6921) fixes: #6794

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands #6921

feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands #6921

AlCalzone commented Jun 12, 2024 •

edited

Loading

feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands #6921

feat: align Meter CC Reset v6 with specifications, add mocks, add API for report commands #6921

Conversation

AlCalzone commented Jun 12, 2024 • edited Loading

AlCalzone commented Jun 12, 2024 •

edited

Loading