Skip to content

Commit

Permalink
Add to zone history docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebr
sebr committed Oct 29, 2021
1 parent b715bf9 commit c8ece2b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 27 deletions.
13 changes: 7 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ The following attributes are set on zone history sensor entities:
| `status` | `string` | The watering status. |
| `consumption_gallons` | `number` | The amount of water consumed, in gallons. |
| `consumption_litres` | `number` | The amount of water consumed, in litres. |
| `start_time` | `string` | The start time of the watering. |

## Switch Entities

Expand Down Expand Up @@ -132,12 +133,12 @@ A **program** `switch` entity is created for each program attached to each zone.

This integration provides the following services:

| Service | Parameters | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `bhyve.start_watering` | `entity_id` - zone(s) entity to start watering. This should be a reference to a zone switch entity <br/> `minutes` - number of minutes to water for | Start watering a zone for a specific number of minutes |
| `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 <br/> `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 |
| Service | Parameters | Description |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `bhyve.start_watering` | `entity_id` - zone(s) entity to start watering. This should be a reference to a zone switch entity <br/> `minutes` - number of minutes to water for | Start watering a zone for a specific number of minutes |
| `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 <br/> `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 |

## Python Script

Expand Down
28 changes: 7 additions & 21 deletions info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,6 @@ A **zone history** `sensor` entity is created for each zone. This reports the hi

The following attrinutes are set on zone history sensor entities:

budget
100
program
manual
program name
manual
run time
3
status
complete
consumption gallons
7
consumption litres
26.5

| Attribute | Type | Notes |
| --------------------- | -------- | ----------------------------------------------------------- |
| `budget` | `number` | The watering budget used. |
Expand All @@ -71,6 +56,7 @@ consumption litres
| `status` | `string` | The watering status. |
| `consumption_gallons` | `number` | The amount of water consumed, in gallons. |
| `consumption_litres` | `number` | The amount of water consumed, in litres. |
| `start_time` | `string` | The start time of the watering. |

## Switch Entities

Expand Down Expand Up @@ -138,12 +124,12 @@ A **program** `switch` entity is created for each program attached to each zone.

This integration provides the following services:

| Service | Parameters | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `bhyve.start_watering` | `entity_id` - zone(s) entity to start watering. This should be a reference to a zone switch entity <br/> `minutes` - number of minutes to water for | Start watering a zone for a specific number of minutes |
| `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 <br/> `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 |
| Service | Parameters | Description |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `bhyve.start_watering` | `entity_id` - zone(s) entity to start watering. This should be a reference to a zone switch entity <br/> `minutes` - number of minutes to water for | Start watering a zone for a specific number of minutes |
| `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 <br/> `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 |

## Python Script

Expand Down

0 comments on commit c8ece2b

Please sign in to comment.