Skip to content

Commit

Permalink
Add service names
Browse files Browse the repository at this point in the history
  • Loading branch information
rgc99 committed Sep 12, 2023
1 parent 7d14dac commit dd0b1a5
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions custom_components/irrigation_unlimited/services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ enable:
description: Enable the controller or zone.
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -14,6 +15,7 @@ enable:
domain: binary_sensor

sequence_id:
name: Sequence Id
description: Id of the sequence to enable (entity_id should be the controller).
example: 1
required: false
Expand All @@ -24,6 +26,7 @@ enable:
mode: box

zones:
name: Zones
description: Id(s) of the zone
example: 1
required: false
Expand All @@ -38,6 +41,7 @@ disable:
description: Disable the controller or zone
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -47,6 +51,7 @@ disable:
domain: binary_sensor

sequence_id:
name: Sequence Id
description: Id of the sequence to disable (entity_id should be the controller).
example: 1
required: false
Expand All @@ -57,6 +62,7 @@ disable:
mode: box

zones:
name: Zones
description: Id(s) of the zone
example: 1
required: false
Expand All @@ -71,6 +77,7 @@ toggle:
description: Toggle the enable/disable status of controller or zone.
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -80,6 +87,7 @@ toggle:
domain: binary_sensor

sequence_id:
name: Sequence Id
description: Id of the sequence to toggle (entity_id should be the controller).
example: 1
required: false
Expand All @@ -90,6 +98,7 @@ toggle:
mode: box

zones:
name: Zones
description: Id(s) of the zone
example: 1
required: false
Expand All @@ -104,6 +113,7 @@ suspend:
description: Suspend the controller or zone
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -113,6 +123,7 @@ suspend:
domain: binary_sensor

sequence_id:
name: Sequence Id
description: Id of the sequence to suspend (entity_id should be the controller).
example: 1
required: false
Expand All @@ -123,6 +134,7 @@ suspend:
mode: box

zones:
name: Zones
description: Id(s) of the zone
example: 1
required: false
Expand All @@ -133,20 +145,23 @@ suspend:
mode: box

for:
name: For
description: The amount of time to suspend
example: "01:00"
required: false
selector:
duration:

until:
name: Until
description: The date and time to restart
example: "2023-01-01 10:00"
required: false
selector:
datetime:

reset:
name: Reset
description: Cancel any suspension
example: ""
required: false
Expand All @@ -156,6 +171,7 @@ cancel:
description: Cancel the current run.
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -169,6 +185,7 @@ adjust_time:
description: Adjust the run times.
fields:
entity_id:
name: Entity Id
description: Name of the Irrigation Unlimited entity.
example: "binary_sensor.irrigation_unlimited_c1_z1"
required: true
Expand All @@ -178,6 +195,7 @@ adjust_time:
domain: binary_sensor

sequence_id:
name: Sequence Id
description: Id of the sequence to adjust (entity_id should be the controller).
example: 1
required: false
Expand All @@ -188,6 +206,7 @@ adjust_time:
mode: box

zones:
name: Zones
description: Id of the zone
example: 1
required: false
Expand All @@ -198,11 +217,13 @@ adjust_time:
mode: box

reset:
name: Reset
description: Revert to original schedule
example: ""
required: false

percentage:
name: Percentage
description: Adjust the run time by a percentage.
example: "150"
required: false
Expand All @@ -213,34 +234,39 @@ adjust_time:
unit_of_measurement: "%"

actual:
name: Actual
description: Set a new run time.
example: "00:15"
required: false
selector:
duration:

increase:
name: Increase
description: Increase the run time.
example: "00:02"
required: false
selector:
duration:

decrease:
name: Descrease
description: Decrease the run time.
example: "00:02"
required: false
selector:
duration:

minimum:
name: Minimum
description: Minimum run time.
example: "00:01"
required: false
selector:
duration:

maximum:
name: Maximum
description: Maximum run time.
example: "01:00"
required: false
Expand All @@ -261,13 +287,15 @@ manual_run:
domain: binary_sensor

time:
name: Time
description: The amount of time to run.
example: "00:10"
required: false
selector:
duration:

sequence_id:
name: Sequence Id
description: Id of the sequence to run.
example: 1
required: false
Expand All @@ -286,18 +314,21 @@ load_schedule:
description: Load a schedule.
fields:
schedule_id:
name: Schedule Id
description: Id of the schedule
example: schedule_1
required: true
selector:
text:
time:
name: Time
description: Time of day
example: '06:30'
required: false
selector:
time:
anchor:
name: Anchor
description: Start or finish at the specified time
example: start
required: false
Expand All @@ -307,18 +338,21 @@ load_schedule:
- start
- finish
duration:
name: Duration
description: The length of time to run
example: '00:10:00'
required: false
selector:
duration:
name:
name: Name
description: Friendly name of the schedule
example: Sunrise
required: false
selector:
text:
weekday:
name: Weekday
description: Days of week to run
example: mon
required: false
Expand All @@ -334,6 +368,7 @@ load_schedule:
- sat
- sun
month:
name: Month
description: Months to run
example: jan
required: false
Expand All @@ -354,12 +389,14 @@ load_schedule:
- nov
- dec
day:
name: Day
description: Day of month to run
example: 1
required: false
selector:
object:
enabled:
name: Enabled
description: Enable/disable this schedule
example: true
required: false
Expand Down

0 comments on commit dd0b1a5

Please sign in to comment.