Correct README against current entity/platform layout#390
Merged
Conversation
- Zones are documented as valve entities (BHyveZoneValve extends ValveEntity); rename the Zone Switch section to Zone Valve and point all zone-scoped service examples and the python script snippet at valve.*_zone instead of switch.*_zone. - Rewrite the Supported Entities list so valve, select and the smart watering switch appear, and so the switch/sensor/binary_sensor entries match what the integration actually creates. - Add short sections for the previously-undocumented entities: temperature sensor, signal strength sensor, fault binary_sensor, connectivity binary_sensor, smart watering switch, device mode select. - Document the station and next_start_* attributes exposed on zone valve entities. - Lowercase the program slot letters (a/b/c/e) to match the actual attribute keys (program_a, program_b, ...). Services are re-described with zone valve wording. Broken services (enable/disable_rain_delay, set_manual_preset_runtime, start_program on the valve domain) are left in the table at their intended behaviour and will be fixed in a separate PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sweeps the README for claims that no longer match the code after the zone-valve migration and other platform additions.
Structural
BHyveZoneValveextendsValveEntity, so zones surface asvalve.*entities, notswitch.*.Accuracy
valveandselect, remove zones fromswitch, and match what the integration actually creates.entity_idreferences in the services table from "zone switch entity" to "zone valve entity".switch.backyard_zonetovalve.backyard_zone.station,next_start_time,next_start_programsattributes to the zone attribute table.a/b/c/e) to match the actualprogram_*attribute keys.Out of scope
Several services are registered in `valve.py` but their methods don't exist on `BHyveZoneValve` (`enable_rain_delay`, `disable_rain_delay`, `set_manual_preset_runtime`, `start_program`). They'll log "Service not implemented" when called. The README still describes them as intended — fixing the registration is a separate code PR.
Test plan