From 9b476b2cdb1fb2cc183ff36d71cf307d1ed412f2 Mon Sep 17 00:00:00 2001 From: Seb Ruiz Date: Tue, 28 May 2024 09:04:44 +1000 Subject: [PATCH] chore: Update readme with warnings about manual_preset_runtime (#246) --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1909b0..3670468 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,12 @@ A **binary_sensor** that turns on if the detected temperature is over or under t ### Zone Switch -A **zone** `switch` entity is created for each zone of a `sprinkler_timer` device. This switch enables starting/stopping irrigation of a zone. Turning on the switch will enable watering of the zone for the amount of time indicated by the `manual_preset_runtime` attribute. This amount of time can be set using the `set_manual_preset_runtime` service or configured in the B-hyve app. +A **zone** `switch` entity is created for each zone of a `sprinkler_timer` device. This switch enables starting/stopping irrigation of a zone. Turning on the switch will enable watering of the zone for a "default" amount of time. + +This default is often indicated by the `manual_preset_runtime` attribute, and this can be set using the `set_manual_preset_runtime` service or configured in the B-hyve app. + +> [!NOTE] +> Some BHyve devices do not have the ability to set the default watering time, and it is recommended that you use the `bhyve.start_watering` service to start the watering zone with the desired number of minutes. The following attributes are set on zone switch entities: @@ -177,12 +182,15 @@ This integration provides the following services: | `bhyve.stop_watering` | `entity_id` - zone(s) entity to stop watering. This should be a reference to a zone switch entity | Stop watering a zone | | `bhyve.enable_rain_delay` | `entity_id` - device to enable a rain delay. This can reference either a zone or rain delay switch
`hours` - number of hours to enable a rain delay | Enable a rain delay for a device for a specified number of hours | | `bhyve.disable_rain_delay` | `entity_id` - device to enable a rain delay. This can reference either a zone or rain delay switch | Cancel a rain delay on a given device | -| `bhyve.set_manual_preset_runtime` | `entity_id` - zone(s) entity to set the preset runtime. This should be a reference to a zone switch entity
`minutes` - number of minutes to water for | Set the default time a switch is activated for when enabled. Support for this service appears to be patchy, and it has been difficult to identify under which conditions it works | +| `bhyve.set_manual_preset_runtime` | `entity_id` - zone(s) entity to set the preset runtime. This should be a reference to a zone switch entity
`minutes` - number of minutes to water for | Set the default time a switch is activated for when enabled. Support for this service appears to be patchy, and it has been difficult to identify the devices or under which conditions it works | | `bhyve.set_smart_watering_soil_moisture` | `entity_id` - zone(s) entity to set the moisture level for. This should be a reference to a zone switch entity
`percentage` - soil moisture level between 0 - 100 | Set Smart Watering soil moisture level for a zone | | `bhyve.start_program` | `entity_id` - program entity to start. This should be a reference to a program switch entity | Starts a pre-configured watering program. Watering programs cannot be created nor configured via this integration, and require the B-Hyve app to create or modify | ## Python Script +> [!CAUTION] +> These scripts are expermintal and not supported. YMMV and any support issues will be closed as won't fix. + Bundled in this repository is a [`python_script`](https://www.home-assistant.io/integrations/python_script) which calculates a device's next watering time and when a rain delay is scheduled to finish. _Note: HACS does not install the script automatically and they must be added manually to your HA instance._