You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Tighten frequency.type docs and document budget attribute
Drop the speculative even/odd type values that aren't verified against
the B-hyve API, list interval alongside days (which the user's payload
confirms), and add the program budget attribute to the Program Switch
attributes table.
|`frequency.type`|`string`| Type of configuration. `days` is the only known value. |
168
-
|`frequency.days`|`list[int]`| Configured days for watering. `0` is Sunday, `1` is Monday etc... |
167
+
|`frequency.type`|`string`| Type of schedule. Known values: `days`, `interval`. |
168
+
|`frequency.days`|`list[int]`| Configured days for watering (when `type` is `days`). `0` is Sunday, `1` is Monday etc... |
169
+
|`frequency.interval`|`int`| Number of days between watering (when `type` is `interval`). |
170
+
|`budget`|`int`| Watering budget as a percentage. Scales each zone's run time.<sup>†</sup> |
169
171
|`run_times`|`list[object]`| Configured watering run times.<sup>†</sup> |
170
172
|`run_times[].run_time`|`int`| Minutes of watering. |
171
173
|`run_times[].station`|`int`| Zone id to water. |
@@ -185,7 +187,7 @@ This integration provides the following services:
185
187
|`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 <br/> `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 |
186
188
|`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 <br/> `percentage` - soil moisture level between 0 - 100 | Set Smart Watering soil moisture level for a zone |
187
189
|`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 via this integration and must first be set up in the B-Hyve app |
188
-
|`bhyve.update_program`|`entity_id` - program switch to update <br/> `start_times` - _(optional)_ list of watering start times in `HH:MM` format <br/> `frequency` - _(optional)_ frequency configuration object (must include a `type`, e.g. `days`, `interval`, `even`, `odd`) <br/> `budget` - _(optional)_ watering budget as a percentage (0-200) | Update the configuration of an existing non-smart program. At least one of `start_times`, `frequency` or `budget` must be provided |
190
+
|`bhyve.update_program`|`entity_id` - program switch to update <br/> `start_times` - _(optional)_ list of watering start times in `HH:MM` format <br/> `frequency` - _(optional)_ frequency configuration object (must include a `type`, known values: `days`, `interval`) <br/> `budget` - _(optional)_ watering budget as a percentage (0-200) | Update the configuration of an existing non-smart program. At least one of `start_times`, `frequency` or `budget` must be provided |
189
191
190
192
### `bhyve.update_program` example
191
193
@@ -204,11 +206,10 @@ data:
204
206
budget: 75
205
207
```
206
208
207
-
The `frequency` object mirrors the B-Hyve API structure. Common `type` values:
209
+
The `frequency` object mirrors the B-Hyve API structure. Known `type` values:
208
210
209
-
- `days` with `days: [0-6]` (where 0 is Sunday) to water on specific weekdays
211
+
- `days` with `days: [0-6]` (where `0` is Sunday, `1` is Monday etc.) to water on specific weekdays
210
212
- `interval` with `interval: N` to water every N days
211
-
- `even`/ `odd` to water on even or odd calendar days
212
213
213
214
The `budget` is a percentage that scales each zone's run time. `100` means unchanged, `50` halves every run time, `200` doubles it. Valid range is 0–200.
0 commit comments