Activate new Sense hysteresis based switch action #326
Conversation
implement sense configuration
WalkthroughAdds Sense hysteresis support: new binary sensors, switches, and numeric bounds; refactors number entities to use typed key-based access; updates translations; bumps integration and dependency versions; and updates changelog and project version metadata. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor U as User
participant HA as Home Assistant
participant Ent as Plugwise Entities
participant Coord as Coordinator
participant Lib as plugwise-usb 0.45.0
participant Dev as Device
rect rgb(235,245,255)
note right of HA: Setup
HA->>Ent: Create entities for SENSE / SENSE_HYSTERESIS
Ent->>Coord: Subscribe for updates
Coord->>Lib: Poll / request data
Lib->>Dev: Read state
Dev-->>Lib: Hysteresis/config/state
Lib-->>Coord: Data snapshot
Coord-->>Ent: Update using entity_description.key
end
rect rgb(240,255,240)
note right of U: Control (set)
U->>Ent: Set number / toggle switch
Ent->>Ent: Cast value (int/float) per async_number_type
Ent->>Lib: Call async_* setter (hysteresis fn)
Lib->>Dev: Apply configuration
Dev-->>Lib: Ack/new state
Lib-->>Coord: Updated snapshot
Coord-->>Ent: Refresh state
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
bouwew: bump minor version number
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (9)
pyproject.toml (1)
3-3: Align project version with the feature release (0.56.0).Manifest and changelog indicate 0.56.0; keep versions consistent to avoid packaging/HACS confusion. This also reflects the prior reviewer’s note.
-version = "0.55.13" +version = "0.56.0"CHANGELOG.md (1)
3-7: v0.56.0 entry and backend link — good.Thanks for adding the 0.45.0 link; addresses the earlier request.
custom_components/plugwise_usb/translations/nl.json (1)
135-146: Shorten and standardize switch names.Current labels are wordy. Shorter names read better in UI and align with the previous “Shorten” feedback.
- "sense_humidity_enabled": { - "name": "Zet schakelen op luchtvochtigheid hysterese aan" - }, - "sense_humidity_direction": { - "name": "Schakel bij stijgende of dalende luchtvochtigheid" - }, - "sense_temperature_enabled": { - "name": "Zet schakelen op temperatuur hysterese aan" - }, - "sense_temperature_direction": { - "name": "Schakel bij stijgende of dalende temperatuur" - } + "sense_humidity_enabled": { + "name": "Schakelen op luchtvochtigheid (hysterese)" + }, + "sense_humidity_direction": { + "name": "Schakelrichting luchtvochtigheid" + }, + "sense_temperature_enabled": { + "name": "Schakelen op temperatuur (hysterese)" + }, + "sense_temperature_direction": { + "name": "Schakelrichting temperatuur" + }custom_components/plugwise_usb/number.py (2)
50-51: Fix indentation: stray tab before mode="box".HA/Black prefer 4-space indents; tabs may fail linting.
Apply:
- mode="box", + mode="box",
84-85: Fix indentation: stray tab before mode="box".Same issue as above.
- mode="box", + mode="box",custom_components/plugwise_usb/translations/en.json (3)
57-66: Shorten and standardize binary_sensor names (sentence case).Keeps UI concise and consistent.
- "sense_config_dirty": { - "name": "Sense hysteresis config changed" - }, - "humidity_hysteresis_state": { - "name": "Humidity Status" - }, - "temperature_hysteresis_state": { - "name": "Temperature Status" - } + "sense_config_dirty": { + "name": "Sense config changed" + }, + "humidity_hysteresis_state": { + "name": "Humidity status" + }, + "temperature_hysteresis_state": { + "name": "Temperature status" + }
134-146: Shorten switch names for readability.Names should be compact; intent remains clear.
- "sense_humidity_enabled": { - "name": "Enable humidity switching on hysteresis" - }, - "sense_humidity_direction": { - "name": "Switch on increasing or decreasing humidity" - }, - "sense_temperature_enabled": { - "name": "Enable temperature switching on hysteresis" - }, - "sense_temperature_direction": { - "name": "Switch on increasing or decreasing temperature" - } + "sense_humidity_enabled": { + "name": "Humidity hysteresis" + }, + "sense_humidity_direction": { + "name": "Humidity direction" + }, + "sense_temperature_enabled": { + "name": "Temperature hysteresis" + }, + "sense_temperature_direction": { + "name": "Temperature direction" + }
163-175: Shorten number names; align with unit display.Avoid “value” suffix; UI already shows units.
- "sense_humidity_upper_bound": { - "name": "Humidity upper boundary value" - }, - "sense_humidity_lower_bound": { - "name": "Humidity lower boundary value" - }, - "sense_temperature_upper_bound": { - "name": "Temperature upper boundary value" - }, - "sense_temperature_lower_bound": { - "name": "Temperature lower boundary value" - } + "sense_humidity_upper_bound": { + "name": "Humidity upper bound" + }, + "sense_humidity_lower_bound": { + "name": "Humidity lower bound" + }, + "sense_temperature_upper_bound": { + "name": "Temperature upper bound" + }, + "sense_temperature_lower_bound": { + "name": "Temperature lower bound" + }custom_components/plugwise_usb/strings.json (1)
134-146: Shorten switch labels; keep them scannable.
- Shorten “Enable … switching on hysteresis”.
- Shorten “Switch on increasing or decreasing …” per prior review.
- "sense_humidity_enabled": { - "name": "Enable humidity switching on hysteresis" - }, + "sense_humidity_enabled": { + "name": "Enable humidity hysteresis" + }, - "sense_humidity_direction": { - "name": "Switch on increasing or decreasing humidity" - }, + "sense_humidity_direction": { + "name": "Switch on humidity increase/decrease" + }, - "sense_temperature_enabled": { - "name": "Enable temperature switching on hysteresis" - }, + "sense_temperature_enabled": { + "name": "Enable temperature hysteresis" + }, - "sense_temperature_direction": { - "name": "Switch on increasing or decreasing temperature" - } + "sense_temperature_direction": { + "name": "Switch on temperature increase/decrease" + }
🧹 Nitpick comments (8)
custom_components/plugwise_usb/translations/nl.json (2)
57-66: Clarify hysteresis status entity names.Consider explicitly mentioning “hysterese” in the status labels for clarity.
- "humidity_hysteresis_state": { - "name": "Status Luchtvochtigheid" - }, - "temperature_hysteresis_state": { - "name": "Status Temperatuur" - } + "humidity_hysteresis_state": { + "name": "Hysterese-status luchtvochtigheid" + }, + "temperature_hysteresis_state": { + "name": "Hysterese-status temperatuur" + }
164-175: Prefer “bovengrens/ondergrens” over “hoge/lage schakelpunt”.These are more concise and idiomatic for set bounds.
- "sense_humidity_upper_bound": { - "name": "Hoge schakelpunt luchtvochtigheid" - }, - "sense_humidity_lower_bound": { - "name": "Lage schakelpunt luchtvochtigheid" - }, - "sense_temperature_upper_bound": { - "name": "Hoge schakelpunt temperatuur" - }, - "sense_temperature_lower_bound": { - "name": "Lage schakelpunt temperatuur" - } + "sense_humidity_upper_bound": { + "name": "Bovengrens luchtvochtigheid" + }, + "sense_humidity_lower_bound": { + "name": "Ondergrens luchtvochtigheid" + }, + "sense_temperature_upper_bound": { + "name": "Bovengrens temperatuur" + }, + "sense_temperature_lower_bound": { + "name": "Ondergrens temperatuur" + }custom_components/plugwise_usb/switch.py (2)
73-104: Hysteresis switches added — LGTM; consider a Select for “direction”.The four switches map cleanly to SENSE_HYSTERESIS. Optional: represent “direction” as a Select with values [rising, falling] for clearer UX; keep as switch if the API is strictly boolean.
73-104: Defensive read on coordinator data to avoid AttributeError.If backend/data shape drifts, getattr without a default can break updates. Consider a safe fallback (not in this hunk; shown for context).
# In _handle_coordinator_update(), prefer a safe default self._attr_is_on = bool( getattr(data, self.entity_description.api_attribute, False) )custom_components/plugwise_usb/number.py (2)
229-231: Guard against missing coordinator attributes to avoid AttributeError.Use a default in getattr and skip state write if absent.
- self._attr_native_value = getattr( - self.coordinator.data[self.entity_description.node_feature], - self.entity_description.key, - ) + value = getattr( + self.coordinator.data[self.entity_description.node_feature], + self.entity_description.key, + None, + ) + if value is None: + _LOGGER.debug( + "Key %s not present in %s data for %s", + self.entity_description.key, + self.entity_description.node_feature, + self._node_info.mac, + ) + return + self._attr_native_value = value
236-240: Optional: normalize to step before sending.To avoid float drift, consider rounding to native_step when async_number_type=="float".
- if self.entity_description.async_number_type == "float": - await self.async_number_fn(float(value)) + if self.entity_description.async_number_type == "float": + step = getattr(self.entity_description, "native_step", None) + v = float(value if step is None else round(value / step) * step) + await self.async_number_fn(v)custom_components/plugwise_usb/strings.json (2)
57-66: Tighten naming and casing for clarity/consistency.
- Prefer sentence case for “Status”.
- "humidity_hysteresis_state": { - "name": "Humidity Status" - }, + "humidity_hysteresis_state": { + "name": "Humidity status" + }, - "temperature_hysteresis_state": { - "name": "Temperature Status" - } + "temperature_hysteresis_state": { + "name": "Temperature status" + }
163-175: Use “threshold” instead of “boundary value”.Shorter and more familiar to users configuring hysteresis.
- "sense_humidity_upper_bound": { - "name": "Humidity upper boundary value" - }, + "sense_humidity_upper_bound": { + "name": "Humidity upper threshold" + }, - "sense_humidity_lower_bound": { - "name": "Humidity lower boundary value" - }, + "sense_humidity_lower_bound": { + "name": "Humidity lower threshold" + }, - "sense_temperature_upper_bound": { - "name": "Temperature upper boundary value" - }, + "sense_temperature_upper_bound": { + "name": "Temperature upper threshold" + }, - "sense_temperature_lower_bound": { - "name": "Temperature lower boundary value" - } + "sense_temperature_lower_bound": { + "name": "Temperature lower threshold" + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (9)
CHANGELOG.md(1 hunks)custom_components/plugwise_usb/binary_sensor.py(1 hunks)custom_components/plugwise_usb/manifest.json(1 hunks)custom_components/plugwise_usb/number.py(5 hunks)custom_components/plugwise_usb/strings.json(3 hunks)custom_components/plugwise_usb/switch.py(1 hunks)custom_components/plugwise_usb/translations/en.json(3 hunks)custom_components/plugwise_usb/translations/nl.json(3 hunks)pyproject.toml(1 hunks)
🔇 Additional comments (8)
custom_components/plugwise_usb/manifest.json (1)
12-13: Approve bump to plugwise-usb 0.45.0 and integration 0.56.0Verified that plugwise-usb 0.45.0 exports NodeFeature.SENSE_HYSTERESIS and provides the async setters set_hysteresis_humidity_enabled/direction and set_hysteresis_temperature_enabled/direction.
CHANGELOG.md (2)
8-9: v0.55.12 section — OK.
13-16: v0.55.11 section — OK.custom_components/plugwise_usb/binary_sensor.py (3)
64-72: Sense config-dirty binary sensor: looks correct and consistent.NodeFeature and attributes align with the new SENSE_HYSTERESIS feature. No blocking concerns.
74-78: Confirm value type and feature source for humidity_hysteresis_state.Please verify that:
- The coordinator data under NodeFeature.SENSE exposes attribute humidity_hysteresis_state.
- The attribute is strictly boolean (required by BinarySensor).
80-84: Confirm value type and feature source for temperature_hysteresis_state.Same as for humidity: ensure attribute exists under NodeFeature.SENSE and is boolean.
custom_components/plugwise_usb/number.py (2)
36-37: Good addition: explicit numeric type handling.async_number_type provides clear float/int casting and avoids API ambiguity.
97-148: Bounds sanity: are min/max ranges correct?
- Humidity lower bound min=1 excludes 0%; intentional?
- Temperature lower bound min=1 excludes <=0 °C; intended for hardware limits?
If 0 (or negatives) are valid, please relax native_min_value accordingly.
|
Summary by CodeRabbit
New Features
Chores
Documentation