zwave-js / zwave-js-ui / 32738887050

16%

push

github

feat(mqtt): discover Window Covering CC as HA cover entities (#4794)

Closes #4782

## Problem

`Window Covering` (CC 0x6A) had no case in the discovery `switch
(cmdClass)` in `api/lib/Gateway.ts`, so it fell through to `default:
return` and no entity was ever published. Devices that implement it
instead of `Multilevel Switch` — e.g. the Fibaro FGR-224 from the issue
— showed up in Home Assistant without any cover.

The values themselves were already published on their normal MQTT
topics; only the discovery config was missing.

## Change

A `case CommandClasses['Window Covering']` next to the Multilevel Switch
branch. For each **positioned** parameter it publishes a
`cover_position` entity:

- `position_topic` → `currentValue` (0-99)
- `command_topic` / `set_position_topic` → `targetValue`
- `object_id` gets the parameter name appended, so a node exposing more
than one parameter (shutter + slats) gets one cover each:
`cover.<node>_position_outbound_bottom`

Even-numbered parameters are skipped. zwave-js creates metadata for them
but never queries a position (`refreshValues` filters to `param % 2 !=
0`) and `setValue` on their `targetValue` throws, so there is nothing to
map onto an HA cover.

### Stop payload

`parsePayload` already intercepted the HA stop payload for covers and
wrote `property: 'Up'`. That property only exists on `Multilevel
Switch`; on Window Covering it would throw `throwUnsupportedProperty`.
It now picks `levelChangeUp` for this CC, which zwave-js turns into
`stopLevelChange(parameter)` when written with `false`.

## Not included

`levelChangeUp` / `levelChangeDown` are not exposed as separate HA
entities — open/close go through `targetValue` (99/0), same as the
FGR-223 behaviour the reporter compared against. Happy to add button
entities for them in a follow-up if wanted.

## Tests

Three cases added to `test/lib/Gateway.test.ts` covering the stop
routing per CC and that position payloads pass through untouched. Full
suite: 208 p... (continued)

519 of 4543 branches covered (11.42%)

Branch coverage included in aggregate %.

1 of 9 new or added lines in 1 file covered. (11.11%)

956 of 7011 relevant lines covered (13.64%)

2.09 hits per line