Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add targets and selectors for services (X-Z) (#50639) 

* Add targets and selectors for services (X-Z)

* Adjustments
pull/50683/head
tkdrob 2021-05-15 12:24:52 -04:00 committed by GitHub
parent d84962bada
commit 7b5fff357e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 802 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
homeassistant/components/xiaomi_aqara/services.yaml
View File

@ -1,39 +1,71 @@
add_device:
name: Add device
description:
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds.
A new device can be added afterwards by pressing the pairing button once.
fields:
gw_mac:
name: Gateway MAC
description: MAC address of the Xiaomi Aqara Gateway.
required: true
example: 34ce00880088
selector:
text:
play_ringtone:
name: play ringtone
description:
Play a specific ringtone. The version of the gateway firmware must
be 1.4.1_145 at least.
fields:
gw_mac:
name: Gateway MAC
description: MAC address of the Xiaomi Aqara Gateway.
required: true
example: 34ce00880088
selector:
text:
ringtone_id:
name: Ringtone ID
description: One of the allowed ringtone ids.
required: true
example: 8
selector:
text:
ringtone_vol:
name: Ringtone volume
description: The volume in percent.
example: 30
selector:
number:
min: 0
max: 100
remove_device:
name: Remove device
description:
Removes a specific device. The removal is required if a device shall
be paired with another gateway.
fields:
device_id:
name: Device ID
description: Hardware address of the device to remove.
required: true
example: 158d0000000000
selector:
text:
gw_mac:
name: Gateway MAC
description: MAC address of the Xiaomi Aqara Gateway.
required: true
example: 34ce00880088
selector:
text:
stop_ringtone:
name: Stop ringtone
description: Stops a playing ringtone immediately.
fields:
gw_mac:
name: Gateway MAC
description: MAC address of the Xiaomi Aqara Gateway.
required: true
example: 34ce00880088
selector:
text:

454
homeassistant/components/xiaomi_miio/services.yaml
View File

@ -1,365 +1,621 @@
fan_set_buzzer_on:
name: Fan set buzzer on
description: Turn the buzzer on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_buzzer_off:
name: Fan set buzzer off
description: Turn the buzzer off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_led_on:
name: Fan set LED on
description: Turn the led on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_led_off:
name: Fan set LED off
description: Turn the led off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_child_lock_on:
name: Fan set child lock on
description: Turn the child lock on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_child_lock_off:
name: Fan set child lock off
description: Turn the child lock off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_favorite_level:
name: Fan set favorite level
description: Set the favorite level.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
level:
description: Level, between 0 and 16.
example: 1
name: Level
description: Level.
required: true
selector:
number:
min: 0
max: 17
fan_set_fan_level:
name: Fan set level
description: Set the fan level.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
level:
description: Level, between 1 and 3.
example: 1
name: Level
description: Level.
selector:
number:
min: 1
max: 3
fan_set_led_brightness:
name: Fan set LED brightness
description: Set the led brightness.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
brightness:
description: Brightness (0 = Bright, 1 = Dim, 2 = Off)
example: 1
required: true
selector:
number:
min: 0
max: 2
fan_set_auto_detect_on:
name: Fan set auto detect on
description: Turn the auto detect on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_auto_detect_off:
name: Fan set auto detect off
description: Turn the auto detect off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_learn_mode_on:
name: Fan set learn mode on
description: Turn the learn mode on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_learn_mode_off:
name: Fan set learn mode off
description: Turn the learn mode off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_volume:
name: Fan set volume
description: Set the sound volume.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
volume:
description: Volume, between 0 and 100.
example: 50
description: Volume.
required: true
selector:
number:
min: 0
max: 100
fan_reset_filter:
name: Fan reset filter
description: Reset the filter lifetime and usage.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_extra_features:
name: Fan set extra features
description: Manipulates a storage register which advertises extra features. The Mi Home app evaluates the value. A feature called "turbo mode" is unlocked in the app on value 1.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
features:
name: Features
description: Integer, known values are 0 (default) and 1 (turbo mode).
example: 1
required: true
selector:
number:
min: 0
max: 1
fan_set_target_humidity:
name: Fan set target humidity
description: Set the target humidity.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
humidity:
description: Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80.
example: 50
name: Humidity
description: Target humidity.
required: true
selector:
number:
min: 30
max: 80
step: 10
unit_of_measurement: '%'
fan_set_dry_on:
name: Fan set dry on
description: Turn the dry mode on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_dry_off:
name: Fan set dry off
description: Turn the dry mode off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "fan.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: fan
fan_set_motor_speed:
name: Fan set motor speed
description: Set the target motor speed.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
selector:
entity:
integration: xiaomi_miio
domain: fan
motor_speed:
description: Set RPM of motor speed, between 200 and 2000.
example: 1100
name: Motor speed
description: Set motor speed.
required: true
selector:
number:
min: 200
max: 2000
unit_of_measurement: 'RPM'
light_set_scene:
name: Light set scene
description: Set a fixed scene.
fields:
entity_id:
description: Name of the light entity.
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
scene:
description: Number of the fixed scene, between 1 and 4.
example: 1
name: Scene
description: Number of the fixed scene.
required: true
selector:
number:
min: 1
max: 6
light_set_delayed_turn_off:
name: Light set delayed turn off
description: Delayed turn off.
fields:
entity_id:
description: Name of the light entity.
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
time_period:
name: Time period
description: Time period for the delayed turn off.
required: true
example: "5, '0:05', {'minutes': 5}"
selector:
object:
light_reminder_on:
name: Light reminder on
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
light_reminder_off:
name: Light reminder off
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
light_night_light_mode_on:
name: Night light mode on
description: Turn the eyecare mode on (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
light_night_light_mode_off:
name: Night light mode off
description: Turn the eyecare mode fan_set_dry_off (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
light_eyecare_mode_on:
name: Light eyecare mode on
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
light_eyecare_mode_off:
name: Light eyecare mode off
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
fields:
entity_id:
description: "Name of the entity to act on."
example: "light.xiaomi_miio"
selector:
entity:
integration: xiaomi_miio
domain: light
remote_learn_command:
name: Remote learn command
description: 'Learn an IR command, press "Call Service", point the remote at the IR device, and the learned command will be shown as a notification in Overview.'
target:
entity:
integration: xiaomi_miio
domain: remote
fields:
entity_id:
description: "Name of the entity to learn command from."
example: "remote.xiaomi_miio"
slot:
description: "Define the slot used to save the IR command (Value from 1 to 1000000)"
example: "1"
name: Slot
description: "Define the slot used to save the IR command."
default: 1
selector:
number:
min: 1
max: 1000000
timeout:
description: "Define the timeout in seconds, before which the command must be learned."
example: "30"
name: Timeout
description: "Define the timeout, before which the command must be learned."
default: 10
selector:
number:
min: 1
max: 3600
unit_of_measurement: seconds
remote_set_led_on:
name: Remote set LED on
description: 'Turn on blue LED.'
fields:
entity_id:
description: "Name of the entity to turn LED on."
example: "remote.xiaomi_miio"
target:
entity:
integration: xiaomi_miio
domain: remote
remote_set_led_off:
name: Remote set LED off
description: 'Turn off blue LED.'
fields:
entity_id:
description: "Name of the entity to turn LED off."
example: "remote.xiaomi_miio"
target:
entity:
integration: xiaomi_miio
domain: remote
switch_set_wifi_led_on:
name: Switch set Wi-fi LED on
description: Turn the wifi led on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "switch.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: switch
switch_set_wifi_led_off:
name: Switch set Wi-fi LED off
description: Turn the wifi led off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "switch.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: switch
switch_set_power_price:
name: Switch set power price
description: Set the power price.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "switch.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: switch
mode:
description: Power price, between 0 and 999.
example: 31
name: Mode
description: Power price.
required: true
selector:
number:
min: 0
max: 999
switch_set_power_mode:
name: Switch set power mode
description: Set the power mode.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: "switch.xiaomi_miio_device"
selector:
entity:
integration: xiaomi_miio
domain: switch
mode:
description: Power mode, valid values are 'normal' and 'green'.
example: "green"
name: Mode
description: Power mode.
required: true
selector:
select:
options:
- 'green'
- 'normal'
vacuum_remote_control_start:
name: Vacuum remote control start
description: Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`.
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
target:
entity:
integration: xiaomi_miio
domain: vacuum
vacuum_remote_control_stop:
name: Vacuum remote control stop
description: Stop remote control mode of the vacuum cleaner.
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
target:
entity:
integration: xiaomi_miio
domain: vacuum
vacuum_remote_control_move:
name: Vacuum remote control move
description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.
target:
entity:
integration: xiaomi_miio
domain: vacuum
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
velocity:
description: Speed, between -0.29 and 0.29.
example: "0.2"
name: Velocity
description: Speed.
selector:
number:
min: -0.29
max: 0.29
step: 0.01
rotation:
name: Rotation
description: Rotation, between -179 degrees and 179 degrees.
example: "90"
selector:
number:
min: -179
max: 179
unit_of_measurement: '°'
duration:
name: Duration
description: Duration of the movement.
example: "1500"
selector:
number:
min: 1
max: 86400
unit_of_measurement: seconds
vacuum_remote_control_move_step:
name: Vacuum remote control move step
description: Remote control the vacuum cleaner, only makes one move and then stops.
target:
entity:
integration: xiaomi_miio
domain: vacuum
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
velocity:
description: Speed, between -0.29 and 0.29.
example: "0.2"
name: Velocity
description: Speed.
selector:
number:
min: -0.29
max: 0.29
step: 0.01
rotation:
description: Rotation, between -179 degrees and 179 degrees.
example: "90"
name: Rotation
description: Rotation.
selector:
number:
min: -179
max: 179
unit_of_measurement: '°'
duration:
name: Duration
description: Duration of the movement.
example: "1500"
selector:
number:
min: 1
max: 86400
unit_of_measurement: seconds
vacuum_clean_zone:
name: Vacuum clean zone
description: Start the cleaning operation in the selected areas for the number of repeats indicated.
target:
entity:
integration: xiaomi_miio
domain: vacuum
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
zone:
name: Zone
description: Array of zones. Each zone is an array of 4 integer values.
example: "[[23510,25311,25110,26362]]"
selector:
object:
repeats:
description: Number of cleaning repeats for each zone between 1 and 3.
example: "1"
name: Repeats
description: Number of cleaning repeats for each zone.
selector:
number:
min: 1
max: 3
vacuum_goto:
name: Vacuum go to
description: Go to the specified coordinates.
target:
entity:
integration: xiaomi_miio
domain: vacuum
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
x_coord:
name: X coordinate
description: x-coordinate.
example: 27500
selector:
text:
y_coord:
name: Y coordinate
description: y-coordinate.
example: 32000
selector:
text:
vacuum_clean_segment:
name: Vacuum clean segment
description: Start cleaning of the specified segment(s).
target:
entity:
integration: xiaomi_miio
domain: vacuum
fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
segments:
name: Segments
description: Segments.
example: "[1,2]"
selector:
object:

31
homeassistant/components/yamaha/services.yaml
View File

@ -1,21 +1,36 @@
enable_output:
name: Enable output
description: Enable or disable an output port
target:
entity:
integration: yamaha
domain: media_player
fields:
entity_id:
description: Name(s) of entities to enable/disable port on.
example: "media_player.yamaha"
port:
name: Port
description: Name of port to enable/disable.
required: true
example: "hdmi1"
selector:
text:
enabled:
description: Boolean indicating if port should be enabled or not.
example: true
name: Enabled
description: Indicate if port should be enabled or not.
required: true
selector:
boolean:
select_scene:
name: Select scene
description: "Select a scene on the receiver"
target:
entity:
integration: yamaha
domain: media_player
fields:
entity_id:
description: Name(s) of entities to enable/disable port on.
example: "media_player.yamaha"
scene:
name: Scene
description: Name of the scene. Standard for RX-V437 is 'BD/DVD Movie Viewing', 'TV Viewing', 'NET Audio Listening' or 'Radio Listening'
required: true
example: "TV Viewing"
selector:
text:

180
homeassistant/components/yeelight/services.yaml
View File

@ -1,96 +1,194 @@
set_mode:
name: Set mode
description: Set a operation mode.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
mode:
description: Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'.
example: "moonlight"
name: Mode
description: Operation mode.
required: true
selector:
select:
options:
- 'color_flow'
- 'hsv'
- 'last'
- 'moonlight'
- 'normal'
- 'rgb'
set_color_scene:
name: Set color scene
description: Changes the light to the specified RGB color and brightness. If the light is off, it will be turned on.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
rgb_color:
name: RGB color
description: Color for the light in RGB-format.
example: "[255, 100, 100]"
selector:
object:
brightness:
description: The brightness value to set (1-100).
example: 50
name: Brightness
description: The brightness value to set.
selector:
number:
min: 0
max: 100
unit_of_measurement: "%"
set_hsv_scene:
name: Set HSV scene
description: Changes the light to the specified HSV color and brightness. If the light is off, it will be turned on.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
hs_color:
name: Hue/sat color
description: Color for the light in hue/sat format. Hue is 0-359 and Sat is 0-100.
example: "[300, 70]"
selector:
object:
brightness:
description: The brightness value to set (1-100).
example: 50
name: Brightness
description: The brightness value to set.
selector:
number:
min: 0
max: 100
unit_of_measurement: "%"
set_color_temp_scene:
name: Set color temperature scene
description: Changes the light to the specified color temperature. If the light is off, it will be turned on.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
kelvin:
name: Kelvin
description: Color temperature for the light in Kelvin.
example: 4000
selector:
number:
min: 1700
max: 6500
step: 100
unit_of_measurement: K
brightness:
description: The brightness value to set (1-100).
example: 50
name: Brightness
description: The brightness value to set.
selector:
number:
min: 0
max: 100
set_color_flow_scene:
name: Set color flow scene
description: starts a color flow. If the light is off, it will be turned on.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
count:
name: Count
description: The number of times to run this flow (0 to run forever).
example: 0
default: 0
selector:
number:
min: 0
max: 100
action:
description: The action to take after the flow stops. Can be 'recover', 'stay', 'off'. (default 'recover')
name: Action
description: The action to take after the flow stops.
example: "stay"
default: 'recover'
selector:
select:
options:
- 'off'
- 'recover'
- 'stay'
transitions:
name: Transitions
description: Array of transitions, for desired effect. Examples https://yeelight.readthedocs.io/en/stable/flow.html
example: '[{ "TemperatureTransition": [1900, 1000, 80] }, { "TemperatureTransition": [1900, 1000, 10] }]'
selector:
object:
set_auto_delay_off_scene:
name: Set auto delay off scene
description: Turns the light on to the specified brightness and sets a timer to turn it back off after the given number of minutes. If the light is off, Set a color scene, if light is off, it will be turned on.
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
minutes:
description: The minutes to wait before automatically turning the light off.
name: Minutes
description: The time to wait before automatically turning the light off.
example: 5
selector:
number:
min: 1
max: 60
unit_of_measurement: minutes
brightness:
description: The brightness value to set (1-100).
example: 50
name: Brightness
description: The brightness value to set.
selector:
number:
min: 0
max: 100
start_flow:
name: Start flow
description: Start a custom flow, using transitions from https://yeelight.readthedocs.io/en/stable/yeelight.html#flow-objects
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
count:
name: Count
description: The number of times to run this flow (0 to run forever).
example: 0
default: 0
selector:
number:
min: 0
max: 100
action:
description: The action to take after the flow stops. Can be 'recover', 'stay', 'off'. (default 'recover')
example: "stay"
name: Action
description: The action to take after the flow stops.
default: 'recover'
selector:
select:
options:
- 'off'
- 'recover'
- 'stay'
transitions:
name: Transitions
description: Array of transitions, for desired effect. Examples https://yeelight.readthedocs.io/en/stable/flow.html
example: '[{ "TemperatureTransition": [1900, 1000, 80] }, { "TemperatureTransition": [1900, 1000, 10] }]'
selector:
object:
set_music_mode:
name: Set music mode
description: Enable or disable music_mode
target:
entity:
integration: yeelight
domain: light
fields:
entity_id:
description: Name of the light entity.
example: "light.yeelight"
music_mode:
name: Music mode
description: Use true or false to enable / disable music_mode
example: true
required: true
selector:
boolean:

1
homeassistant/components/zone/services.yaml
View File

@ -1,2 +1,3 @@
reload:
name: Reload
description: Reload the YAML-based zone configuration.

5
homeassistant/components/zoneminder/services.yaml
View File

@ -1,6 +1,11 @@
set_run_state:
name: Set run state
description: Set the ZoneMinder run state
fields:
name:
name: Name
description: The string name of the ZoneMinder run state to set as active.
required: true
example: "Home"
selector:
text:

278
homeassistant/components/zwave/services.yaml
View File

@ -1,196 +1,410 @@
# Describes the format for available Z-Wave services
change_association:
name: Change association
description: Change an association in the Z-Wave network.
fields:
association:
name: Association
description: Specify add or remove association
required: true
example: add
selector:
text:
node_id:
name: Node ID
description: Node id of the node to set association for.
required: true
example: 10
selector:
number:
min: 1
max: 255
target_node_id:
name: Target node ID
description: Node id of the node to associate to.
required: true
example: 42
selector:
number:
min: 1
max: 255
group:
name: Group
description: Group number to set association for.
required: true
selector:
number:
min: 1
max: 5
instance:
description: (Optional) Instance of multichannel association. Defaults to 0.
name: Instance
description: Instance of multichannel association.
default: 0
selector:
number:
min: 0
max: 255
add_node:
name: Add node
description: Add a new (unsecure) node to the Z-Wave network. Refer to OZW_Log.txt for progress.
add_node_secure:
name: Add node secure
description: Add a new node to the Z-Wave network 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. Refer to OZW_Log.txt for progress.
cancel_command:
name: Cancel command
description: Cancel a running Z-Wave controller command. Use this to exit add_node, if you weren't going to use it but activated it.
heal_network:
name: Heal network
description: Start a Z-Wave network heal. This might take a while and will slow down the Z-Wave network greatly while it is being processed. Refer to OZW_Log.txt for progress.
fields:
return_routes:
description: Whether or not to update the return routes from the nodes to the controller. Defaults to False.
example: true
name: Return routes
description: Whether or not to update the return routes from the nodes to the controller.
default: false
selector:
boolean:
heal_node:
name: Heal node
description: Start a Z-Wave node heal. Refer to OZW_Log.txt for progress.
fields:
return_routes:
description: Whether or not to update the return routes from the node to the controller. Defaults to False.
example: true
name: Return routes
description: Whether or not to update the return routes from the node to the controller.
default: false
selector:
boolean:
remove_node:
name: Remove node
description: Remove a node from the Z-Wave network. Refer to OZW_Log.txt for progress.
remove_failed_node:
name: Remove failed node
description: This command will remove a failed node from the network. The node should be on the controller's failed nodes list, otherwise this command will fail. Refer to OZW_Log.txt for progress.
fields:
node_id:
description: Node id of the device to remove (integer).
example: 10
name: Node ID
description: Node id of the device to remove.
required: true
selector:
number:
min: 1
max: 255
replace_failed_node:
name: Replace failed node
description: Replace a failed node with another. If the node is not in the controller's failed nodes list, or the node responds, this command will fail. Refer to OZW_Log.txt for progress.
fields:
node_id:
description: Node id of the device to replace (integer).
example: 10
name: Node ID
description: Node id of the device to replace.
required: true
selector:
number:
min: 1
max: 255
set_config_parameter:
name: Set config parameter
description: Set a config parameter to a node on the Z-Wave network.
fields:
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
selector:
number:
min: 1
max: 255
parameter:
description: Parameter number to set (integer).
name: Parameter
description: Parameter number to set.
required: true
selector:
number:
min: 1
max: 255
value:
name: Value
description: Value to set for parameter. (String value for list and bool parameters, integer for others).
required: true
selector:
text:
size:
description: (Optional) Set the size of the parameter value. Only needed if no parameters are available.
name: Size
description: Set the size of the parameter value. Only needed if no parameters are available.
default: 2
selector:
number:
min: 1
max: 255
set_node_value:
name: Set node value
description: Set the value for a given value_id on a Z-Wave device.
fields:
node_id:
description: Node id of the device to set the value on (integer).
name: Node ID
description: Node id of the device to set the value on.
required: true
selector:
number:
min: 1
max: 255
value_id:
name: Value ID
description: Value id of the value to set (integer or string).
required: true
selector:
text:
value:
name: Value
description: Value to set (integer or string).
required: true
selector:
text:
refresh_node_value:
name: Refresh node value
description: Refresh the value for a given value_id on a Z-Wave device.
fields:
node_id:
description: Node id of the device to refresh value from (integer).
name: Node ID
description: Node id of the device to refresh value from.
required: true
selector:
number:
min: 1
max: 255
value_id:
name: Value ID
description: Value id of the value to refresh.
required: true
selector:
text:
set_poll_intensity:
name: Set poll intensity
description: Set the polling interval to a nodes value
fields:
node_id:
name: Node ID
description: ID of the node to set polling to.
required: true
example: 10
value_id:
name: Value ID
description: ID of the value to set polling to.
example: 72037594255792737
required: true
selector:
text:
poll_intensity:
name: Poll intensity
description: The intensity to poll, 0 = disabled, 1 = Every time through list, 2 = Every second time through list...
example: 2
required: true
selector:
number:
min: 0
max: 100
print_config_parameter:
name: Print configuration parameter
description: Prints a Z-Wave node config parameter value to log.
fields:
node_id:
description: Node id of the device to print the parameter from (integer).
name: Node ID
description: Node id of the device to print the parameter from.
required: true
selector:
number:
min: 1
max: 255
parameter:
description: Parameter number to print (integer).
name: Parameter
description: Parameter number to print.
required: true
selector:
number:
min: 1
max: 255
print_node:
name: Print node
description: Print all information about z-wave node.
fields:
node_id:
name: Node ID
description: Node id of the device to print.
required: true
selector:
number:
min: 1
max: 255
refresh_entity:
name: Refresh entity
description: Refresh zwave entity.
fields:
entity_id:
name: Entity
description: Name of the entity to refresh.
example: "light.leviton_vrmx11lz_multilevel_scene_switch_level_40"
required: true
selector:
entity:
integration: zwave
refresh_node:
name: Refresh node
description: Refresh zwave node.
fields:
node_id:
name: Node ID
description: ID of the node to refresh.
example: 10
required: true
selector:
number:
min: 1
max: 255
set_wakeup:
name: Set wakeup
description: Sets wake-up interval of a node.
fields:
node_id:
description: Node id of the device to set the wake-up interval for. (integer)
name: Node ID
description: Node id of the device to set the wake-up interval for.
required: true
selector:
number:
min: 1
max: 255
value:
description: Value of the interval to set. (integer)
name: Value
description: Value of the interval to set.
required: true
selector:
text:
start_network:
name: Start network
description: Start the Z-Wave network. This might take a while, depending on how big your Z-Wave network is.
stop_network:
name: Stop network
description: Stop the Z-Wave network, all updates into Home Assistant will stop.
soft_reset:
name: Soft reset
description: This will reset the controller without removing its data. Use carefully because not all controllers support this. Refer to your controller's manual.
test_network:
name: Test network
description: This will send test to nodes in the Z-Wave network. This will greatly slow down the Z-Wave network while it is being processed. Refer to OZW_Log.txt for progress.
test_node:
name: Test node
description: This will send test messages to a node in the Z-Wave network. This could bring back dead nodes.
fields:
node_id:
name: Node ID
description: ID of the node to send test messages to.
example: 10
required: true
selector:
number:
min: 1
max: 255
messages:
description: Optional. Amount of test messages to send.
example: 3
name: Messages
description: Amount of test messages to send.
default: 1
selector:
number:
min: 1
max: 100
rename_node:
name: Rename node
description: Set the name of a node. This will also affect the IDs of all entities in the node.
fields:
node_id:
name: Node ID
description: ID of the node to rename.
example: 10
required: true
selector:
number:
min: 1
max: 255
update_ids:
description: (optional) Rename the entity IDs for entities of this node.
example: true
name: Update IDs
description: Rename the entity IDs for entities of this node.
default: false
selector:
boolean:
name:
name: Name
description: New Name
required: true
example: "kitchen"
selector:
text:
rename_value:
name: Rename value
description: Set the name of a node value. This will affect the ID of the value entity. Value IDs can be queried from /api/zwave/values/{node_id}
fields:
node_id:
name: Node ID
description: ID of the node to rename.
example: 10
required: true
selector:
number:
min: 1
max: 255
value_id:
name: Value ID
description: ID of the value to rename.
example: 72037594255792737
required: true
selector:
text:
update_ids:
description: (optional) Update the entity ID for this value's entity.
example: true
name: Update IDs
description: Update the entity ID for this value's entity.
default: false
selector:
boolean:
name:
name: Name
description: New Name
example: "Luminosity"
required: true
selector:
text:
reset_node_meters:
name: Reset node meters
description: Resets the meter counters of a node.
fields:
node_id:
description: Node id of the device to reset meters for. (integer)
name: Node ID
description: Node id of the device to reset meters for.
required: true
selector:
number:
min: 1
max: 255
instance:
description: (Optional) Instance of association. Defaults to instance 1.
name: Instance
description: Instance of association.
default: 1
selector:
number:
min: 1
max: 100