zwave-js / zwave-js-ui / 39438556836

17%

push

github

feat(discovery): add option to enable Configuration CC entities by default (#4843)

Closes #4836

Configuration CC entities are always discovered with
`enabled_by_default: false`. Right now the only way to enable them is
the per-value `ccConfigEnableDiscovery` flag, one value at a time.

This adds an opt-in switch under Settings → Home Assistant: **Enable
Configuration CC entities** (`gateway.ccConfigEnabledByDefault`, off by
default).

```ts
enabled_by_default = valueConf?.ccConfigEnableDiscovery ?? !!config.ccConfigEnabledByDefault
```

- When the switch is off, nothing changes.
- The per-value flag still wins over the global setting, including when
it is explicitly `false`.
- Home Assistant only reads `enabled_by_default` when it first registers
an entity. The switch hint and the docs say this: to change entities
Home Assistant already has, remove them there and rediscover the node.

Changes:
- `api/lib/Gateway.ts`: new config field and the fallback shown above
- `src/views/Settings.vue`, `src/stores/base.js`: the new switch and its
default
- `src/components/dialogs/DialogGatewayValue.vue`: updated the per-value
hint
- `docs/usage/setup.md`, `docs/homeassistant/homeassistant-mqtt.md`:
documented the switch
- `test/lib/Gateway.test.ts`: tests for the default, the global switch,
and the per-value override in both directions

629 of 4568 branches covered (13.77%)

Branch coverage included in aggregate %.

1093 of 7044 relevant lines covered (15.52%)

2.29 hits per line