core/homeassistant/components/rainmachine/services.yaml

244 lines
6.3 KiB
YAML

# Describes the format for available RainMachine services
disable_program:
name: Disable Program
description: Disable a program
target:
entity:
integration: rainmachine
domain: switch
disable_zone:
name: Disable Zone
description: Disable a zone
target:
entity:
integration: rainmachine
domain: switch
enable_program:
name: Enable Program
description: Enable a program
target:
entity:
integration: rainmachine
domain: switch
enable_zone:
name: Enable Zone
description: Enable a zone
target:
entity:
integration: rainmachine
domain: switch
pause_watering:
name: Pause All Watering
description: Pause all watering activities for a number of seconds
fields:
device_id:
name: Controller
description: The controller whose watering activities should be paused
required: true
selector:
device:
integration: rainmachine
seconds:
name: Duration
description: The amount of time (in seconds) to pause watering
required: true
selector:
number:
min: 1
max: 86400
unit_of_measurement: seconds
start_program:
name: Start Program
description: Start a program
target:
entity:
integration: rainmachine
domain: switch
start_zone:
name: Start Zone
description: Start a zone
target:
entity:
integration: rainmachine
domain: switch
fields:
zone_run_time:
name: Run Time
description: The amount of time (in seconds) to run the zone
default: 600
selector:
number:
min: 1
max: 86400
mode: box
stop_all:
name: Stop All Watering
description: Stop all watering activities
fields:
device_id:
name: Controller
description: The controller whose watering activities should be stopped
required: true
selector:
device:
integration: rainmachine
stop_program:
name: Stop Program
description: Stop a program
target:
entity:
integration: rainmachine
domain: switch
stop_zone:
name: Stop Zone
description: Stop a zone
target:
entity:
integration: rainmachine
domain: switch
unpause_watering:
name: Unpause All Watering
description: Unpause all paused watering activities
fields:
device_id:
name: Controller
description: The controller whose watering activities should be unpaused
required: true
selector:
device:
integration: rainmachine
push_weather_data:
name: Push Weather Data
description: >-
Push Weather Data from Home Assistant to the RainMachine device.
Local Weather Push service should be enabled from Settings > Weather > Developer tab for RainMachine to consider the values being sent.
Units must be sent in metric; no conversions are performed by the integraion.
See details of RainMachine API Here: https://rainmachine.docs.apiary.io/#reference/weather-services/parserdata/post
fields:
device_id:
name: Controller
description: The controller for the weather data to be pushed.
required: true
selector:
device:
integration: rainmachine
timestamp:
name: Timestamp
description: UNIX Timestamp for the Weather Data. If omitted, the RainMachine device's local time at the time of the call is used.
selector:
text:
mintemp:
name: Min Temp
description: Minimum Temperature (°C).
selector:
number:
min: -40
max: 40
step: 0.1
unit_of_measurement: '°C'
maxtemp:
name: Max Temp
description: Maximum Temperature (°C).
selector:
number:
min: -40
max: 40
step: 0.1
unit_of_measurement: '°C'
temperature:
name: Temperature
description: Current Temperature (°C).
selector:
number:
min: -40
max: 40
step: 0.1
unit_of_measurement: '°C'
wind:
name: Wind Speed
description: Wind Speed (m/s)
selector:
number:
min: 0
max: 65
unit_of_measurement: 'm/s'
solarrad:
name: Solar Radiation
description: Solar Radiation (MJ/m²/h)
selector:
number:
min: 0
max: 5
step: 0.1
unit_of_measurement: 'MJ/m²/h'
et:
name: Evapotranspiration
description: Evapotranspiration (mm)
selector:
number:
min: 0
max: 1000
unit_of_measurement: 'mm'
qpf:
name: Quantitative Precipitation Forecast
description: >-
Quantitative Precipitation Forecast (mm), or QPF. Note: QPF values shouldn't
be send as cumulative values but the measured/forecasted values for each hour or day.
The RainMachine Mixer will sum all QPF values in the current day to have the day total QPF.
selector:
number:
min: 0
max: 1000
unit_of_measurement: 'mm'
rain:
name: Measured Rainfall
description: >-
Measured Rainfail (mm). Note: RAIN values shouldn't be send as cumulative values but the
measured/forecasted values for each hour or day. The RainMachine Mixer will sum all RAIN values
in the current day to have the day total RAIN.
selector:
number:
min: 0
max: 1000
unit_of_measurement: 'mm'
minrh:
name: Min Relative Humidity
description: Min Relative Humidity (%RH)
selector:
number:
min: 0
max: 100
unit_of_measurement: '%'
maxrh:
name: Max Relative Humidity
description: Max Relative Humidity (%RH)
selector:
number:
min: 0
max: 100
unit_of_measurement: '%'
condition:
name: Weather Condition Code
description: Current weather condition code (WNUM).
selector:
text:
pressure:
name: Barametric Pressure
description: Barametric Pressure (kPa)
selector:
number:
min: 60
max: 110
unit_of_measurement: "kPa"
dewpoint:
name: Dew Point
description: Dew Point (°C).
selector:
number:
min: -40
max: 40
step: 0.1
unit_of_measurement: '°C'