Add targets and selectors for services (N-O) (#50608)

This commit is contained in:
tkdrob 2021-05-15 04:30:18 -04:00 committed by GitHub
parent 0eca26607d
commit bd443af6a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 508 additions and 57 deletions

View File

@ -1,19 +1,34 @@
# Describes the format for available ness alarm services # Describes the format for available ness alarm services
aux: aux:
name: Aux
description: Trigger an aux output. description: Trigger an aux output.
fields: fields:
output_id: output_id:
description: The aux output you wish to change. A number from 1-4. name: Output ID
description: The aux output you wish to change.
required: true
example: 1 example: 1
selector:
number:
min: 1
max: 4
state: state:
description: The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. name: State
description: The On/Off State. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E.
example: true example: true
default: true default: true
selector:
boolean:
panic: panic:
name: Panic
description: Trigger a panic description: Trigger a panic
fields: fields:
code: code:
name: Code
description: The user code to use to trigger the panic. description: The user code to use to trigger the panic.
required: true
example: 1234 example: 1234
selector:
text:

View File

@ -1,37 +1,71 @@
# Describes the format for available Nest services # Describes the format for available Nest services
set_away_mode: set_away_mode:
name: Set away mode
description: Set the away mode for a Nest structure. description: Set the away mode for a Nest structure.
fields: fields:
away_mode: away_mode:
description: New mode to set. Valid modes are "away" or "home". name: Away mode
description: New mode to set.
example: "away" example: "away"
required: true
selector:
select:
options:
- 'away'
- 'home'
structure: structure:
name: Structure
description: Name(s) of structure(s) to change. Defaults to all structures if not specified. description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment" example: "Apartment"
selector:
object:
set_eta: set_eta:
name: Set estimated time of arrival
description: Set or update the estimated time of arrival window for a Nest structure. description: Set or update the estimated time of arrival window for a Nest structure.
fields: fields:
eta: eta:
name: ETA
description: Estimated time of arrival from now. description: Estimated time of arrival from now.
example: "00:10:30" example: "00:10:30"
required: true
selector:
time:
eta_window: eta_window:
description: Estimated time of arrival window. Default is 1 minute. name: ETA window
description: Estimated time of arrival window.
example: "00:05" example: "00:05"
default: "00:01"
selector:
time:
trip_id: trip_id:
name: Trip ID
description: Unique ID for the trip. Default is auto-generated using a timestamp. description: Unique ID for the trip. Default is auto-generated using a timestamp.
example: "Leave Work" example: "Leave Work"
selector:
text:
structure: structure:
name: Structure
description: Name(s) of structure(s) to change. Defaults to all structures if not specified. description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment" example: "Apartment"
selector:
object:
cancel_eta: cancel_eta:
name: Cancel ETA
description: Cancel an existing estimated time of arrival window for a Nest structure. description: Cancel an existing estimated time of arrival window for a Nest structure.
fields: fields:
trip_id: trip_id:
name: Trip ID
description: Unique ID for the trip. description: Unique ID for the trip.
required: true
example: "Leave Work" example: "Leave Work"
selector:
text:
structure: structure:
name: Structure
description: Name(s) of structure(s) to change. Defaults to all structures if not specified. description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment" example: "Apartment"
selector:
object:

View File

@ -1,36 +1,69 @@
delete_sms: delete_sms:
name: Delete SMS
description: Delete messages from the modem inbox. description: Delete messages from the modem inbox.
fields: fields:
host: host:
name: Host
description: The modem that should have a message deleted. description: The modem that should have a message deleted.
example: 192.168.5.1 example: 192.168.5.1
selector:
text:
sms_id: sms_id:
name: SMS ID
description: Integer or list of integers with inbox IDs of messages to delete. description: Integer or list of integers with inbox IDs of messages to delete.
required: true
example: 7 example: 7
selector:
object:
set_option: set_option:
name: Set option
description: Set options on the modem. description: Set options on the modem.
fields: fields:
host: host:
name: Host
description: The modem to set options on. description: The modem to set options on.
example: 192.168.5.1 example: 192.168.5.1
selector:
text:
failover: failover:
description: Failover mode, auto/wire/mobile. name: Failover
description: Failover mode.
example: auto example: auto
selector:
select:
options:
- 'auto'
- 'mobile'
- 'wire'
autoconnect: autoconnect:
description: Auto-connect mode, never/home/always. name: Auto-connect
description: Auto-connect mode.
example: home example: home
selector:
select:
options:
- 'always'
- 'home'
- 'never'
connect_lte: connect_lte:
name: Connect LTE
description: Ask the modem to establish the LTE connection. description: Ask the modem to establish the LTE connection.
fields: fields:
host: host:
name: Host
description: The modem that should connect. description: The modem that should connect.
example: 192.168.5.1 example: 192.168.5.1
selector:
text:
disconnect_lte: disconnect_lte:
name: Disconnect LTE
description: Ask the modem to close the LTE connection. description: Ask the modem to close the LTE connection.
fields: fields:
host: host:
description: The modem that should disconnect. description: The modem that should disconnect.
example: 192.168.5.1 example: 192.168.5.1
selector:
text:

View File

@ -1,19 +1,38 @@
set_aircleaner_mode: set_aircleaner_mode:
name: Set air cleaner mode
description: "The air cleaner mode." description: "The air cleaner mode."
target:
entity:
integration: nexia
domain: climate
fields: fields:
entity_id:
description: "This setting will affect all zones connected to the thermostat."
example: climate.master_bedroom
aircleaner_mode: aircleaner_mode:
description: 'The air cleaner mode to set. Options include "auto", "quick", or "allergy".' name: Air cleaner mode
description: 'The air cleaner mode to set.'
required: true
example: allergy example: allergy
selector:
select:
options:
- 'allergy'
- 'auto'
- 'quick'
set_humidify_setpoint: set_humidify_setpoint:
name: Set humidify set point
description: "The humidification set point." description: "The humidification set point."
target:
entity:
integration: nexia
domain: climate
fields: fields:
entity_id:
description: "This setting will affect all zones connected to the thermostat."
example: climate.master_bedroom
humidity: humidity:
description: "The humidification setpoint as an int, range 35-65." name: Humidify
description: "The humidification setpoint."
required: true
example: 45 example: 45
selector:
number:
min: 35
max: 65
unit_of_measurement: '%'

View File

@ -1,20 +1,30 @@
# Describes the format for available services for nissan_leaf # Describes the format for available services for nissan_leaf
start_charge: start_charge:
name: Start charge
description: > description: >
Start the vehicle charging. It must be plugged in first! Start the vehicle charging. It must be plugged in first!
fields: fields:
vin: vin:
name: VIN
description: > description: >
The vehicle identification number (VIN) of the vehicle, 17 characters The vehicle identification number (VIN) of the vehicle, 17 characters
required: true
example: WBANXXXXXX1234567 example: WBANXXXXXX1234567
selector:
text:
update: update:
name: Update
description: > description: >
Fetch the last state of the vehicle of all your accounts, requesting Fetch the last state of the vehicle of all your accounts, requesting
an update from of the state from the car if possible. an update from of the state from the car if possible.
fields: fields:
vin: vin:
name: VIN
description: > description: >
The vehicle identification number (VIN) of the vehicle, 17 characters The vehicle identification number (VIN) of the vehicle, 17 characters
required: true
example: WBANXXXXXX1234567 example: WBANXXXXXX1234567
selector:
text:

View File

@ -7,12 +7,13 @@ notify:
message: message:
name: Message name: Message
description: Message body of the notification. description: Message body of the notification.
required: true
example: The garage door has been open for 10 minutes. example: The garage door has been open for 10 minutes.
selector: selector:
text: text:
title: title:
name: Title name: Title
description: Optional title for your notification. description: Title for your notification.
example: "Your Garage Door Friend" example: "Your Garage Door Friend"
selector: selector:
text: text:
@ -21,6 +22,8 @@ notify:
An array of targets to send the notification to. Optional depending on An array of targets to send the notification to. Optional depending on
the platform. the platform.
example: platform specific example: platform specific
selector:
object:
data: data:
name: Data name: Data
description: description:
@ -36,10 +39,15 @@ persistent_notification:
fields: fields:
message: message:
description: Message body of the notification. description: Message body of the notification.
required: true
example: The garage door has been open for 10 minutes. example: The garage door has been open for 10 minutes.
selector:
text:
title: title:
description: Optional title for your notification. description: Title for your notification.
example: "Your Garage Door Friend" example: "Your Garage Door Friend"
selector:
text:
apns_register: apns_register:
name: Register APNS device name: Register APNS device

View File

@ -1,9 +1,15 @@
lock_n_go: lock_n_go:
name: Lock 'n' go
description: "Nuki Lock 'n' Go" description: "Nuki Lock 'n' Go"
target:
entity:
integration: nuki
domain: lock
fields: fields:
entity_id:
description: Entity id of the Nuki lock.
example: "lock.front_door"
unlatch: unlatch:
name: unlatch
description: Whether to unlatch the lock. description: Whether to unlatch the lock.
example: false example: false
default: false
selector:
boolean:

View File

@ -1,21 +1,37 @@
# Describes the format for available nx584 services # Describes the format for available nx584 services
bypass_zone: bypass_zone:
name: Bypass zone
description: Bypass a zone. description: Bypass a zone.
target:
entity:
integration: nx584
domain: alarm_control_panel
fields: fields:
entity_id:
description: Name of the alarm control panel which state has to be updated.
example: "alarm_control_panel.downstairs"
zone: zone:
name: Zone
description: The number of the zone to be bypassed. description: The number of the zone to be bypassed.
required: true
example: "1" example: "1"
selector:
number:
min: 1
max: 255
unbypass_zone: unbypass_zone:
name: Un-bypass zone
description: Un-Bypass a zone. description: Un-Bypass a zone.
target:
entity:
integration: nx584
domain: alarm_control_panel
fields: fields:
entity_id:
description: Name of the alarm control panel which state has to be updated.
example: "alarm_control_panel.downstairs"
zone: zone:
name: Zone
description: The number of the zone to be un-bypassed. description: The number of the zone to be un-bypassed.
required: true
example: "1" example: "1"
selector:
number:
min: 1
max: 255

View File

@ -1,14 +1,24 @@
# Describes the format for available nzbget services # Describes the format for available nzbget services
pause: pause:
name: Pause
description: Pause download queue. description: Pause download queue.
resume: resume:
name: Resume
description: Resume download queue. description: Resume download queue.
set_speed: set_speed:
name: Set speed
description: Set download speed limit description: Set download speed limit
fields: fields:
speed: speed:
description: Speed limit in kB/s. 0 is unlimited. name: Speed
description: Speed limit. 0 is unlimited.
example: 1000 example: 1000
default: 1000
selector:
number:
min: 0
max: 1000000
unit_of_measurement: 'kB/s'

View File

@ -1,24 +1,47 @@
# Ombi services.yaml entries # Ombi services.yaml entries
submit_movie_request: submit_movie_request:
name: Sumbit movie request
description: Searches for a movie and requests the first result. description: Searches for a movie and requests the first result.
fields: fields:
name: name:
name: Name
description: Search parameter description: Search parameter
required: true
example: "beverly hills cop" example: "beverly hills cop"
selector:
text:
submit_tv_request: submit_tv_request:
name: Submit tv request
description: Searches for a TV show and requests the first result. description: Searches for a TV show and requests the first result.
fields: fields:
name: name:
name: Name
description: Search parameter description: Search parameter
required: true
example: "breaking bad" example: "breaking bad"
selector:
text:
season: season:
description: Which season(s) to request (first, latest or all) name: Season
description: Which season(s) to request.
example: "latest" example: "latest"
default: latest
selector:
select:
options:
- 'all'
- 'first'
- 'latest'
submit_music_request: submit_music_request:
name: Submit music request
description: Searches for a music album and requests the first result. description: Searches for a music album and requests the first result.
fields: fields:
name: name:
name: Name
description: Search parameter description: Search parameter
required: true
example: "nevermind" example: "nevermind"
selector:
text:

View File

@ -1,9 +1,17 @@
set_pump_speed: set_pump_speed:
name: Set pump speed
description: Set the run speed of a variable speed pump. description: Set the run speed of a variable speed pump.
target:
entity:
integration: omnilogic
domain: switch
fields: fields:
entity_id:
description: Target switch entity
example: switch.pool_pump
speed: speed:
name: Speed
description: Speed for the VSP between min and max speed. description: Speed for the VSP between min and max speed.
required: true
example: 85 example: 85
selector:
number:
min: 0
max: 100000

View File

@ -1,34 +1,85 @@
ptz: ptz:
name: PTZ
description: If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. description: If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.
target:
entity:
integration: onvif
domain: camera
fields: fields:
entity_id:
description: "String or list of strings that point at entity_ids of cameras. Else targets all."
example: "camera.living_room_camera"
tilt: tilt:
description: "Tilt direction. Allowed values: UP, DOWN" name: Tilt
description: "Tilt direction."
example: "UP" example: "UP"
selector:
select:
options:
- 'DOWN'
- 'UP'
pan: pan:
description: "Pan direction. Allowed values: RIGHT, LEFT" name: Pan
description: "Pan direction."
example: "RIGHT" example: "RIGHT"
selector:
select:
options:
- 'LEFT'
- 'RIGHT'
zoom: zoom:
description: "Zoom. Allowed values: ZOOM_IN, ZOOM_OUT" name: Zoom
description: "Zoom."
example: "ZOOM_IN" example: "ZOOM_IN"
selector:
select:
options:
- 'ZOOM_IN'
- 'ZOOM_OUT'
distance: distance:
description: "Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1" name: Distance
description: "Distance coefficient. Sets how much PTZ should be executed in one request."
default: 0.1 default: 0.1
example: 0.1 example: 0.1
selector:
number:
min: 0
max: 1
step: 0.01
speed: speed:
description: "Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1" name: Speed
description: "Speed coefficient. Sets how fast PTZ will be executed."
default: 0.5 default: 0.5
example: 0.5 example: 0.5
selector:
number:
min: 0
max: 1
step: 0.01
continuous_duration: continuous_duration:
name: Continuous duration
description: "Set ContinuousMove delay in seconds before stopping the move" description: "Set ContinuousMove delay in seconds before stopping the move"
default: 0.5 default: 0.5
example: 0.5 example: 0.5
selector:
number:
min: 0
max: 1
step: 0.01
preset: preset:
name: Preset
description: "PTZ preset profile token. Sets the preset profile token which is executed with GotoPreset" description: "PTZ preset profile token. Sets the preset profile token which is executed with GotoPreset"
example: "1" example: "1"
default: "0"
selector:
text:
move_mode: move_mode:
description: "PTZ moving mode. One of ContinuousMove, RelativeMove, AbsoluteMove, GotoPreset, or Stop" name: Move Mode
description: "PTZ moving mode."
default: "RelativeMove" default: "RelativeMove"
example: "ContinuousMove" example: "ContinuousMove"
selector:
select:
options:
- 'AbsoluteMove'
- 'ContinuousMove'
- 'GotoPreset'
- 'RelativeMove'
- 'Stop'

View File

@ -1,11 +1,19 @@
# Describes the format for available openhome services # Describes the format for available openhome services
invoke_pin: invoke_pin:
name: Invoke PIN
description: Invoke a pin on the specified device. description: Invoke a pin on the specified device.
target:
entity:
integration: openhome
domain: media_player
fields: fields:
entity_id:
description: The name of the openhome device to invoke the pin on
example: media_player.main_room
pin: pin:
name: PIN
description: Which pin to invoke description: Which pin to invoke
required: true
example: 4 example: 4
selector:
number:
min: 0
max: 1000

View File

@ -1,13 +1,19 @@
# Describes the format for available opentherm_gw services # Describes the format for available opentherm_gw services
reset_gateway: reset_gateway:
name: Reset gateway
description: Reset the OpenTherm Gateway. description: Reset the OpenTherm Gateway.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
set_central_heating_ovrd: set_central_heating_ovrd:
name: Set central heating override
description: > description: >
Set the central heating override option on the gateway. Set the central heating override option on the gateway.
When overriding the control setpoint (via a set_control_setpoint service call with a value other than 0), the gateway automatically enables the central heating override to start heating. When overriding the control setpoint (via a set_control_setpoint service call with a value other than 0), the gateway automatically enables the central heating override to start heating.
@ -16,49 +22,83 @@ set_central_heating_ovrd:
You will only need this if you are writing your own software thermostat. You will only need this if you are writing your own software thermostat.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
ch_override: ch_override:
name: Central heating override
description: > description: >
The desired boolean value for the central heating override. The desired boolean value for the central heating override.
required: true
example: "on" example: "on"
selector:
boolean:
set_clock: set_clock:
name: Set clock
description: Set the clock and day of the week on the connected thermostat. description: Set the clock and day of the week on the connected thermostat.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
date: date:
name: Date
description: Optional date from which the day of the week will be extracted. Defaults to today. description: Optional date from which the day of the week will be extracted. Defaults to today.
example: "2018-10-23" example: "2018-10-23"
selector:
text:
time: time:
name: Name
description: Optional time in 24h format which will be provided to the thermostat. Defaults to the current time. description: Optional time in 24h format which will be provided to the thermostat. Defaults to the current time.
example: "19:34" example: "19:34"
selector:
text:
set_control_setpoint: set_control_setpoint:
name: Set control set point
description: > description: >
Set the central heating control setpoint override on the gateway. Set the central heating control setpoint override on the gateway.
You will only need this if you are writing your own software thermostat. You will only need this if you are writing your own software thermostat.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
temperature: temperature:
name: Temperature
description: > description: >
The central heating setpoint to set on the gateway. The central heating setpoint to set on the gateway.
Values between 0 and 90 are accepted, but not all boilers support this range. Values between 0 and 90 are accepted, but not all boilers support this range.
A value of 0 disables the central heating setpoint override. A value of 0 disables the central heating setpoint override.
required: true
example: "37.5" example: "37.5"
selector:
number:
min: 0
max: 90
step: 0.1
unit_of_measurement: '°'
set_hot_water_ovrd: set_hot_water_ovrd:
name: Set hot water override
description: > description: >
Set the domestic hot water enable option on the gateway. Set the domestic hot water enable option on the gateway.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
dhw_override: dhw_override:
name: Domestic hot water override
description: > description: >
Control the domestic hot water enable option. If the boiler has Control the domestic hot water enable option. If the boiler has
been configured to let the room unit control when to keep a been configured to let the room unit control when to keep a
@ -66,88 +106,187 @@ set_hot_water_ovrd:
that. that.
Value should be 0 or 1 to enable the override in off or on Value should be 0 or 1 to enable the override in off or on
state, or "A" to disable the override. state, or "A" to disable the override.
required: true
example: "1" example: "1"
selector:
text:
set_hot_water_setpoint: set_hot_water_setpoint:
name: Set hot water set point
description: > description: >
Set the domestic hot water setpoint on the gateway. Set the domestic hot water setpoint on the gateway.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
temperature: temperature:
name: Temperature
description: > description: >
The domestic hot water setpoint to set on the gateway. Not all boilers support this feature. The domestic hot water setpoint to set on the gateway. Not all boilers support this feature.
Values between 0 and 90 are accepted, but not all boilers support this range. Values between 0 and 90 are accepted, but not all boilers support this range.
Check the values of the slave_dhw_min_setp and slave_dhw_max_setp sensors to see the supported range on your boiler. Check the values of the slave_dhw_min_setp and slave_dhw_max_setp sensors to see the supported range on your boiler.
example: "60" example: "60"
selector:
number:
min: 0
max: 90
step: 0.1
unit_of_measurement: '°'
set_gpio_mode: set_gpio_mode:
name: Set gpio mode
description: Change the function of the GPIO pins of the gateway. description: Change the function of the GPIO pins of the gateway.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
id: id:
description: The ID of the GPIO pin. Either "A" or "B". name: ID
description: The ID of the GPIO pin.
required: true
example: "B" example: "B"
selector:
select:
options:
- 'A'
- 'B'
mode: mode:
name: Mode
description: > description: >
Mode to set on the GPIO pin. Values 0 through 6 are accepted for both GPIOs, 7 is only accepted for GPIO "B". Mode to set on the GPIO pin. Values 0 through 6 are accepted for both GPIOs, 7 is only accepted for GPIO "B".
See https://www.home-assistant.io/integrations/opentherm_gw/#gpio-modes for an explanation of the values. See https://www.home-assistant.io/integrations/opentherm_gw/#gpio-modes for an explanation of the values.
required: true
example: "5" example: "5"
selector:
number:
min: 0
max: 7
set_led_mode: set_led_mode:
name: Set LED mode
description: Change the function of the LEDs of the gateway. description: Change the function of the LEDs of the gateway.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
id: id:
description: The ID of the LED. Possible values are "A" through "F". name: ID
description: The ID of the LED.
required: true
example: "C" example: "C"
selector:
select:
options:
- 'A'
- 'B'
- 'C'
- 'D'
- 'E'
- 'F'
mode: mode:
name: Mode
description: > description: >
The function to assign to the LED. One of "R", "X", "T", "B", "O", "F", "H", "W", "C", "E", "M" or "P". The function to assign to the LED. One of "R", "X", "T", "B", "O", "F", "H", "W", "C", "E", "M" or "P".
See https://www.home-assistant.io/integrations/opentherm_gw/#led-modes for an explanation of the values. See https://www.home-assistant.io/integrations/opentherm_gw/#led-modes for an explanation of the values.
required: true
example: "F" example: "F"
selector:
select:
options:
- 'B'
- 'C'
- 'E'
- 'F'
- 'H'
- 'M'
- 'O'
- 'P'
- 'R'
- 'T'
- 'W'
- 'X'
set_max_modulation: set_max_modulation:
name: Set max modulation
description: > description: >
Override the maximum relative modulation level. Override the maximum relative modulation level.
You will only need this if you are writing your own software thermostat. You will only need this if you are writing your own software thermostat.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
level: level:
name: Level
description: > description: >
The modulation level to provide to the gateway. The modulation level to provide to the gateway.
Values between 0 and 100 will set the modulation level.
Provide a value of -1 to clear the override and forward the value from the thermostat again. Provide a value of -1 to clear the override and forward the value from the thermostat again.
required: true
example: "42" example: "42"
selector:
number:
min: -1
max: 100
set_outside_temperature: set_outside_temperature:
name: Set outside temperature
description: > description: >
Provide an outside temperature to the thermostat. Provide an outside temperature to the thermostat.
If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect. If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
temperature: temperature:
name: Temperature
description: > description: >
The temperature to provide to the thermostat. The temperature to provide to the thermostat.
Values between -40.0 and 64.0 will be accepted, but not all thermostats can display the full range. Values between -40.0 and 64.0 will be accepted, but not all thermostats can display the full range.
Any value above 64.0 will clear a previously configured value (suggestion: 99) Any value above 64.0 will clear a previously configured value (suggestion: 99)
required: true
example: "-2.3" example: "-2.3"
selector:
number:
min: -40
max: 99
set_setback_temperature: set_setback_temperature:
name: Set setback temperature
description: Configure the setback temperature to be used with the GPIO away mode function. description: Configure the setback temperature to be used with the GPIO away mode function.
fields: fields:
gateway_id: gateway_id:
name: Gateway ID
description: The gateway_id of the OpenTherm Gateway. description: The gateway_id of the OpenTherm Gateway.
required: true
example: "opentherm_gateway" example: "opentherm_gateway"
selector:
text:
temperature: temperature:
name: Temperature
description: The setback temperature to configure on the gateway. Values between 0.0 and 30.0 are accepted. description: The setback temperature to configure on the gateway. Values between 0.0 and 30.0 are accepted.
required: true
example: "16.0" example: "16.0"
selector:
number:
min: 0
max: 30
step: 0.1

View File

@ -1,9 +1,12 @@
# Describes the format for available OpenUV services # Describes the format for available OpenUV services
update_data: update_data:
name: Update data
description: Request new data from OpenUV. Consumes two API calls. description: Request new data from OpenUV. Consumes two API calls.
update_uv_index_data: update_uv_index_data:
name: Update UV index data
description: Request new UV index data from OpenUV. description: Request new UV index data from OpenUV.
update_protection_data: update_protection_data:
name: Update protection data
description: Request new protection window data from OpenUV. description: Request new protection window data from OpenUV.

View File

@ -1,58 +1,126 @@
# Describes the format for available Z-Wave services # Describes the format for available Z-Wave services
add_node: add_node:
name: Add node
description: Add a new node to the Z-Wave network. description: Add a new node to the Z-Wave network.
fields: fields:
secure: secure:
name: Secure
description: Add the new node with secure communications. Secure network key must be set, this process will fallback to add_node (unsecure) for unsupported devices. Note that unsecure devices can't directly talk to secure devices. description: Add the new node with secure communications. Secure network key must be set, this process will fallback to add_node (unsecure) for unsupported devices. Note that unsecure devices can't directly talk to secure devices.
default: false
selector:
boolean:
instance_id: instance_id:
description: (Optional) The OZW Instance/Controller to use, defaults to 1. name: Instance ID
description: The OZW Instance/Controller to use.
default: 1
selector:
number:
min: 1
max: 255
remove_node: remove_node:
name: Remove node
description: Remove a node from the Z-Wave network. Will set the controller into exclusion mode. description: Remove a node from the Z-Wave network. Will set the controller into exclusion mode.
fields: fields:
instance_id: instance_id:
description: (Optional) The OZW Instance/Controller to use, defaults to 1. name: Instance ID
description: The OZW Instance/Controller to use.
default: 1
selector:
number:
min: 1
max: 255
cancel_command: cancel_command:
name: Cancel command
description: Cancel a pending add or remove node command. description: Cancel a pending add or remove node command.
fields: fields:
instance_id: instance_id:
description: (Optional) The OZW Instance/Controller to use, defaults to 1. name: Instance ID
description: The OZW Instance/Controller to use.
default: 1
selector:
number:
min: 1
max: 255
set_config_parameter: set_config_parameter:
name: Set config parameter
description: Set a config parameter to a node on the Z-Wave network. description: Set a config parameter to a node on the Z-Wave network.
fields: fields:
node_id: node_id:
description: Node id of the device to set config parameter to (integer). name: Node ID
description: Node id of the device to set config parameter to.
required: true
example: 10 example: 10
selector:
number:
min: 1
max: 255
parameter: parameter:
description: Parameter number to set (integer). name: Parameter
description: Parameter number to set.
required: true
example: 8 example: 8
selector:
number:
min: 1
max: 255
value: value:
name: Value
description: Value to set for parameter. (String value for list and bool parameters, integer for others). description: Value to set for parameter. (String value for list and bool parameters, integer for others).
required: true
example: 50268673 example: 50268673
selector:
text:
instance_id: instance_id:
description: (Optional) The OZW Instance/Controller to use, defaults to 1. name: Instance ID
description: The OZW Instance/Controller to use.
default: 1
selector:
number:
min: 1
max: 255
clear_usercode: clear_usercode:
name: Clear usercode
description: Clear a usercode from lock. description: Clear a usercode from lock.
target:
entity:
integration: ozw
domain: lock
fields: fields:
entity_id:
description: Lock entity_id.
example: lock.front_door_locked
code_slot: code_slot:
name: Code slot
description: Code slot to clear code from. description: Code slot to clear code from.
required: true
example: 1 example: 1
selector:
number:
min: 1
max: 255
set_usercode: set_usercode:
name: Set usercode
description: Set a usercode to lock. description: Set a usercode to lock.
target:
entity:
integration: ozw
domain: lock
fields: fields:
entity_id:
description: Lock entity_id.
example: lock.front_door_locked
code_slot: code_slot:
name: Code slot
description: Code slot to set the code. description: Code slot to set the code.
required: true
example: 1 example: 1
selector:
number:
min: 1
max: 255
usercode: usercode:
name: Usercode
description: Code to set. description: Code to set.
required: true
example: 1234 example: 1234
selector:
text: