mirror of
https://github.com/home-assistant/core
synced 2024-07-21 10:44:07 +00:00
Add yamllint (in pre-commit and CI) (#33676)
* Add yamllint (in pre-commit and CI) * Fix linting for all YAML files * Bump and add it to requirements * Fix gen_requirements for pre-commit, remove 'v' from version
This commit is contained in:
parent
7653dc947a
commit
24840b54ac
2
.github/lock.yml
vendored
2
.github/lock.yml
vendored
|
@ -24,4 +24,4 @@ only: pulls
|
||||||
|
|
||||||
# Optionally, specify configuration settings just for `issues` or `pulls`
|
# Optionally, specify configuration settings just for `issues` or `pulls`
|
||||||
issues:
|
issues:
|
||||||
daysUntilLock: 30
|
daysUntilLock: 30
|
||||||
|
|
|
@ -46,6 +46,10 @@ repos:
|
||||||
- --branch=dev
|
- --branch=dev
|
||||||
- --branch=master
|
- --branch=master
|
||||||
- --branch=rc
|
- --branch=rc
|
||||||
|
- repo: https://github.com/adrienverge/yamllint.git
|
||||||
|
rev: v1.21.0
|
||||||
|
hooks:
|
||||||
|
- id: yamllint
|
||||||
- repo: local
|
- repo: local
|
||||||
hooks:
|
hooks:
|
||||||
# Run mypy through our wrapper script in order to get the possible
|
# Run mypy through our wrapper script in order to get the possible
|
||||||
|
|
61
.yamllint
Normal file
61
.yamllint
Normal file
|
@ -0,0 +1,61 @@
|
||||||
|
ignore: |
|
||||||
|
azure-*.yml
|
||||||
|
rules:
|
||||||
|
braces:
|
||||||
|
level: error
|
||||||
|
min-spaces-inside: 0
|
||||||
|
max-spaces-inside: 1
|
||||||
|
min-spaces-inside-empty: -1
|
||||||
|
max-spaces-inside-empty: -1
|
||||||
|
brackets:
|
||||||
|
level: error
|
||||||
|
min-spaces-inside: 0
|
||||||
|
max-spaces-inside: 0
|
||||||
|
min-spaces-inside-empty: -1
|
||||||
|
max-spaces-inside-empty: -1
|
||||||
|
colons:
|
||||||
|
level: error
|
||||||
|
max-spaces-before: 0
|
||||||
|
max-spaces-after: 1
|
||||||
|
commas:
|
||||||
|
level: error
|
||||||
|
max-spaces-before: 0
|
||||||
|
min-spaces-after: 1
|
||||||
|
max-spaces-after: 1
|
||||||
|
comments:
|
||||||
|
level: error
|
||||||
|
require-starting-space: true
|
||||||
|
min-spaces-from-content: 2
|
||||||
|
comments-indentation:
|
||||||
|
level: error
|
||||||
|
document-end:
|
||||||
|
level: error
|
||||||
|
present: false
|
||||||
|
document-start:
|
||||||
|
level: error
|
||||||
|
present: false
|
||||||
|
empty-lines:
|
||||||
|
level: error
|
||||||
|
max: 1
|
||||||
|
max-start: 0
|
||||||
|
max-end: 1
|
||||||
|
hyphens:
|
||||||
|
level: error
|
||||||
|
max-spaces-after: 1
|
||||||
|
indentation:
|
||||||
|
level: error
|
||||||
|
spaces: 2
|
||||||
|
indent-sequences: true
|
||||||
|
check-multi-line-strings: false
|
||||||
|
key-duplicates:
|
||||||
|
level: error
|
||||||
|
line-length: disable
|
||||||
|
new-line-at-end-of-file:
|
||||||
|
level: error
|
||||||
|
new-lines:
|
||||||
|
level: error
|
||||||
|
type: unix
|
||||||
|
trailing-spaces:
|
||||||
|
level: error
|
||||||
|
truthy:
|
||||||
|
level: error
|
|
@ -64,6 +64,10 @@ stages:
|
||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
pre-commit run check-json --all-files
|
pre-commit run check-json --all-files
|
||||||
displayName: 'Run check-json'
|
displayName: 'Run check-json'
|
||||||
|
- script: |
|
||||||
|
. venv/bin/activate
|
||||||
|
pre-commit run yamllint --all-files
|
||||||
|
displayName: 'Run yamllint'
|
||||||
- job: 'Validate'
|
- job: 'Validate'
|
||||||
pool:
|
pool:
|
||||||
vmImage: 'ubuntu-latest'
|
vmImage: 'ubuntu-latest'
|
||||||
|
|
|
@ -12,8 +12,8 @@ coverage:
|
||||||
default:
|
default:
|
||||||
url: "secret:TgWDUM4Jw0w7wMJxuxNF/yhSOHglIo1fGwInJnRLEVPy2P2aLimkoK1mtKCowH5TFw+baUXVXT3eAqefbdvIuM8BjRR4aRji95C6CYyD0QHy4N8i7nn1SQkWDPpS8IthYTg07rUDF7s5guurkKv2RrgoCdnnqjAMSzHoExMOF7xUmblMdhBTWJgBpWEhASJy85w/xxjlsE1xoTkzeJu9Q67pTXtRcn+5kb5/vIzPSYg="
|
url: "secret:TgWDUM4Jw0w7wMJxuxNF/yhSOHglIo1fGwInJnRLEVPy2P2aLimkoK1mtKCowH5TFw+baUXVXT3eAqefbdvIuM8BjRR4aRji95C6CYyD0QHy4N8i7nn1SQkWDPpS8IthYTg07rUDF7s5guurkKv2RrgoCdnnqjAMSzHoExMOF7xUmblMdhBTWJgBpWEhASJy85w/xxjlsE1xoTkzeJu9Q67pTXtRcn+5kb5/vIzPSYg="
|
||||||
comment:
|
comment:
|
||||||
require_changes: yes
|
require_changes: true
|
||||||
layout: reach
|
layout: reach
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
- !dev
|
- !dev
|
||||||
|
|
|
@ -1,13 +1,21 @@
|
||||||
capture_image:
|
capture_image:
|
||||||
description: Request a new image capture from a camera device.
|
description: Request a new image capture from a camera device.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the camera to request an image., example: camera.downstairs_motion_camera}
|
entity_id:
|
||||||
|
description: Entity id of the camera to request an image.
|
||||||
|
example: camera.downstairs_motion_camera
|
||||||
change_setting:
|
change_setting:
|
||||||
description: Change an Abode system setting.
|
description: Change an Abode system setting.
|
||||||
fields:
|
fields:
|
||||||
setting: {description: Setting to change., example: beeper_mute}
|
setting:
|
||||||
value: {description: Value of the setting., example: '1'}
|
description: Setting to change.
|
||||||
|
example: beeper_mute
|
||||||
|
value:
|
||||||
|
description: Value of the setting.
|
||||||
|
example: "1"
|
||||||
trigger_automation:
|
trigger_automation:
|
||||||
description: Trigger an Abode automation.
|
description: Trigger an Abode automation.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the automation to trigger., example: switch.my_automation}
|
entity_id:
|
||||||
|
description: Entity id of the automation to trigger.
|
||||||
|
example: switch.my_automation
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Describes the format for available arlo services
|
# Describes the format for available arlo services
|
||||||
|
|
||||||
update:
|
update:
|
||||||
description: Update the state for all cameras and the base station.
|
description: Update the state for all cameras and the base station.
|
||||||
|
|
|
@ -1,35 +1,34 @@
|
||||||
# Describes the format for available automation services
|
# Describes the format for available automation services
|
||||||
|
|
||||||
turn_on:
|
turn_on:
|
||||||
description: Enable an automation.
|
description: Enable an automation.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the automation to turn on.
|
description: Name of the automation to turn on.
|
||||||
example: 'automation.notify_home'
|
example: "automation.notify_home"
|
||||||
|
|
||||||
turn_off:
|
turn_off:
|
||||||
description: Disable an automation.
|
description: Disable an automation.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the automation to turn off.
|
description: Name of the automation to turn off.
|
||||||
example: 'automation.notify_home'
|
example: "automation.notify_home"
|
||||||
|
|
||||||
toggle:
|
toggle:
|
||||||
description: Toggle an automation.
|
description: Toggle an automation.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the automation to toggle on/off.
|
description: Name of the automation to toggle on/off.
|
||||||
example: 'automation.notify_home'
|
example: "automation.notify_home"
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
description: Trigger the action of an automation.
|
description: Trigger the action of an automation.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the automation to trigger.
|
description: Name of the automation to trigger.
|
||||||
example: 'automation.notify_home'
|
example: "automation.notify_home"
|
||||||
skip_condition:
|
skip_condition:
|
||||||
description: Whether or not the condition will be skipped (defaults to True).
|
description: Whether or not the condition will be skipped (defaults to True).
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
reload:
|
reload:
|
||||||
description: Reload the automation configuration.
|
description: Reload the automation configuration.
|
||||||
|
|
|
@ -1,21 +1,21 @@
|
||||||
# Describes the format for available Blink services
|
# Describes the format for available Blink services
|
||||||
|
|
||||||
blink_update:
|
blink_update:
|
||||||
description: Force a refresh.
|
description: Force a refresh.
|
||||||
|
|
||||||
trigger_camera:
|
trigger_camera:
|
||||||
description: Request named camera to take new image.
|
description: Request named camera to take new image.
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: Name of camera to take new image.
|
description: Name of camera to take new image.
|
||||||
example: 'Living Room'
|
example: "Living Room"
|
||||||
|
|
||||||
save_video:
|
save_video:
|
||||||
description: Save last recorded video clip to local file.
|
description: Save last recorded video clip to local file.
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: Name of camera to grab video from.
|
description: Name of camera to grab video from.
|
||||||
example: 'Living Room'
|
example: "Living Room"
|
||||||
filename:
|
filename:
|
||||||
description: Filename to writable path (directory may need to be included in whitelist_dirs in config)
|
description: Filename to writable path (directory may need to be included in whitelist_dirs in config)
|
||||||
example: '/tmp/video.mp4'
|
example: "/tmp/video.mp4"
|
||||||
|
|
|
@ -3,28 +3,28 @@ join:
|
||||||
fields:
|
fields:
|
||||||
master:
|
master:
|
||||||
description: Entity ID of the player that should become the master of the group.
|
description: Entity ID of the player that should become the master of the group.
|
||||||
example: 'media_player.bluesound_livingroom'
|
example: "media_player.bluesound_livingroom"
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities that will coordinate the grouping. Platform dependent.
|
description: Name(s) of entities that will coordinate the grouping. Platform dependent.
|
||||||
example: 'media_player.bluesound_livingroom'
|
example: "media_player.bluesound_livingroom"
|
||||||
|
|
||||||
unjoin:
|
unjoin:
|
||||||
description: Unjoin the player from a group.
|
description: Unjoin the player from a group.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities that will be unjoined from their group. Platform dependent.
|
description: Name(s) of entities that will be unjoined from their group. Platform dependent.
|
||||||
example: 'media_player.bluesound_livingroom'
|
example: "media_player.bluesound_livingroom"
|
||||||
|
|
||||||
set_sleep_timer:
|
set_sleep_timer:
|
||||||
description: "Set a Bluesound timer. It will increase timer in steps: 15, 30, 45, 60, 90, 0"
|
description: "Set a Bluesound timer. It will increase timer in steps: 15, 30, 45, 60, 90, 0"
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities that will have a timer set.
|
description: Name(s) of entities that will have a timer set.
|
||||||
example: 'media_player.bluesound_livingroom'
|
example: "media_player.bluesound_livingroom"
|
||||||
|
|
||||||
clear_sleep_timer:
|
clear_sleep_timer:
|
||||||
description: Clear a Bluesound timer.
|
description: Clear a Bluesound timer.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities that will have the timer cleared.
|
description: Name(s) of entities that will have the timer cleared.
|
||||||
example: 'media_player.bluesound_livingroom'
|
example: "media_player.bluesound_livingroom"
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
update:
|
update:
|
||||||
description: Trigger manual tracker update
|
description: Trigger manual tracker update
|
||||||
|
|
|
@ -1,10 +1,7 @@
|
||||||
# Describes the format for available component services
|
# Describes the format for available component services
|
||||||
|
|
||||||
process:
|
process:
|
||||||
description: Launch a conversation from a transcribed text.
|
description: Launch a conversation from a transcribed text.
|
||||||
fields:
|
fields:
|
||||||
text:
|
text:
|
||||||
description: Transcribed text
|
description: Transcribed text
|
||||||
example: Turn all lights on
|
example: Turn all lights on
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
randomize_device_tracker_data:
|
randomize_device_tracker_data:
|
||||||
description: Demonstrates using a device tracker to see where devices are located
|
description: Demonstrates using a device tracker to see where devices are located
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
download_file:
|
download_file:
|
||||||
description: Downloads a file to the download location.
|
description: Downloads a file to the download location.
|
||||||
fields:
|
fields:
|
||||||
url:
|
url:
|
||||||
description: The URL of the file to download.
|
description: The URL of the file to download.
|
||||||
example: 'http://example.org/myfile'
|
example: "http://example.org/myfile"
|
||||||
subdir:
|
subdir:
|
||||||
description: Download into subdirectory.
|
description: Download into subdirectory.
|
||||||
example: 'download_dir'
|
example: "download_dir"
|
||||||
filename:
|
filename:
|
||||||
description: Determine the filename.
|
description: Determine the filename.
|
||||||
example: 'my_file_name'
|
example: "my_file_name"
|
||||||
overwrite:
|
overwrite:
|
||||||
description: Whether to overwrite the file or not.
|
description: Whether to overwrite the file or not.
|
||||||
example: 'false'
|
example: "false"
|
||||||
|
|
|
@ -5,7 +5,7 @@ set_night_mode:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to enable/disable night mode
|
description: Name(s) of the entities to enable/disable night mode
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
night_mode:
|
night_mode:
|
||||||
description: Night mode status
|
description: Night mode status
|
||||||
example: true
|
example: true
|
||||||
|
@ -15,7 +15,7 @@ set_auto_mode:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to enable/disable auto mode
|
description: Name(s) of the entities to enable/disable auto mode
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
auto_mode:
|
auto_mode:
|
||||||
description: Auto mode status
|
description: Auto mode status
|
||||||
example: true
|
example: true
|
||||||
|
@ -25,7 +25,7 @@ set_angle:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities for which to set the angle
|
description: Name(s) of the entities for which to set the angle
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
angle_low:
|
angle_low:
|
||||||
description: The angle at which the oscillation should start
|
description: The angle at which the oscillation should start
|
||||||
example: 1
|
example: 1
|
||||||
|
@ -38,7 +38,7 @@ flow_direction_front:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set frontal flow direction for
|
description: Name(s) of the entities to set frontal flow direction for
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
flow_direction_front:
|
flow_direction_front:
|
||||||
description: Frontal flow direction
|
description: Frontal flow direction
|
||||||
example: true
|
example: true
|
||||||
|
@ -48,7 +48,7 @@ set_timer:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set the sleep timer for
|
description: Name(s) of the entities to set the sleep timer for
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
timer:
|
timer:
|
||||||
description: The value in minutes to set the timer to, 0 to disable it
|
description: The value in minutes to set the timer to, 0 to disable it
|
||||||
example: 30
|
example: 30
|
||||||
|
@ -58,7 +58,7 @@ set_speed:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set the speed for
|
description: Name(s) of the entities to set the speed for
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
dyson_speed:
|
dyson_speed:
|
||||||
description: Speed
|
description: Speed
|
||||||
example: 1
|
example: 1
|
||||||
|
|
|
@ -3,4 +3,4 @@ write:
|
||||||
fields:
|
fields:
|
||||||
call:
|
call:
|
||||||
description: Property name and value to set
|
description: Property name and value to set
|
||||||
example: '{"name": "Hc1MaxFlowTempDesired", "value": 21}'
|
example: '{"name": "Hc1MaxFlowTempDesired", "value": 21}'
|
||||||
|
|
|
@ -3,7 +3,7 @@ add_vacation:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to change.
|
description: Name(s) of entities to change.
|
||||||
example: 'water_heater.econet'
|
example: "water_heater.econet"
|
||||||
start_date:
|
start_date:
|
||||||
description: The timestamp of when the vacation should start. (Optional, defaults to now)
|
description: The timestamp of when the vacation should start. (Optional, defaults to now)
|
||||||
example: 1513186320
|
example: 1513186320
|
||||||
|
@ -16,4 +16,4 @@ delete_vacation:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to change.
|
description: Name(s) of entities to change.
|
||||||
example: 'water_heater.econet'
|
example: "water_heater.econet"
|
||||||
|
|
|
@ -1,55 +1,54 @@
|
||||||
# Describes the format for available fan services
|
# Describes the format for available fan services
|
||||||
|
|
||||||
set_speed:
|
set_speed:
|
||||||
description: Sets fan speed.
|
description: Sets fan speed.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set
|
description: Name(s) of the entities to set
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
speed:
|
speed:
|
||||||
description: Speed setting
|
description: Speed setting
|
||||||
example: 'low'
|
example: "low"
|
||||||
|
|
||||||
turn_on:
|
turn_on:
|
||||||
description: Turns fan on.
|
description: Turns fan on.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Names(s) of the entities to turn on
|
description: Names(s) of the entities to turn on
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
speed:
|
speed:
|
||||||
description: Speed setting
|
description: Speed setting
|
||||||
example: 'high'
|
example: "high"
|
||||||
|
|
||||||
turn_off:
|
turn_off:
|
||||||
description: Turns fan off.
|
description: Turns fan off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Names(s) of the entities to turn off
|
description: Names(s) of the entities to turn off
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
|
|
||||||
oscillate:
|
oscillate:
|
||||||
description: Oscillates the fan.
|
description: Oscillates the fan.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to oscillate
|
description: Name(s) of the entities to oscillate
|
||||||
example: 'fan.desk_fan'
|
example: "fan.desk_fan"
|
||||||
oscillating:
|
oscillating:
|
||||||
description: Flag to turn on/off oscillation
|
description: Flag to turn on/off oscillation
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
toggle:
|
toggle:
|
||||||
description: Toggle the fan on/off.
|
description: Toggle the fan on/off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to toggle
|
description: Name(s) of the entities to toggle
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
|
|
||||||
set_direction:
|
set_direction:
|
||||||
description: Set the fan rotation.
|
description: Set the fan rotation.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set
|
description: Name(s) of the entities to set
|
||||||
example: 'fan.living_room'
|
example: "fan.living_room"
|
||||||
direction:
|
direction:
|
||||||
description: The direction to rotate. Either 'forward' or 'reverse'
|
description: The direction to rotate. Either 'forward' or 'reverse'
|
||||||
example: 'forward'
|
example: "forward"
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
speedtest:
|
speedtest:
|
||||||
description: Immediately take a speedest with Fast.com
|
description: Immediately take a speedest with Fast.com
|
||||||
|
|
|
@ -1,15 +1,18 @@
|
||||||
restart:
|
restart:
|
||||||
description: Send a restart command to a ffmpeg based sensor.
|
description: Send a restart command to a ffmpeg based sensor.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Name(s) of entities that will restart. Platform dependent.,
|
entity_id:
|
||||||
example: binary_sensor.ffmpeg_noise}
|
description: Name(s) of entities that will restart. Platform dependent.
|
||||||
|
example: binary_sensor.ffmpeg_noise
|
||||||
start:
|
start:
|
||||||
description: Send a start command to a ffmpeg based sensor.
|
description: Send a start command to a ffmpeg based sensor.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Name(s) of entities that will start. Platform dependent.,
|
entity_id:
|
||||||
example: binary_sensor.ffmpeg_noise}
|
description: Name(s) of entities that will start. Platform dependent.
|
||||||
|
example: binary_sensor.ffmpeg_noise
|
||||||
stop:
|
stop:
|
||||||
description: Send a stop command to a ffmpeg based sensor.
|
description: Send a stop command to a ffmpeg based sensor.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Name(s) of entities that will stop. Platform dependent.,
|
entity_id:
|
||||||
example: binary_sensor.ffmpeg_noise}
|
description: Name(s) of entities that will stop. Platform dependent.
|
||||||
|
example: binary_sensor.ffmpeg_noise
|
||||||
|
|
|
@ -1,29 +1,45 @@
|
||||||
checkin:
|
checkin:
|
||||||
description: Check a user into a Foursquare venue.
|
description: Check a user into a Foursquare venue.
|
||||||
fields:
|
fields:
|
||||||
alt: {description: 'Altitude of the user''s location, in meters. [Optional]',
|
alt:
|
||||||
example: 0}
|
description: Altitude of the user's location, in meters. [Optional]
|
||||||
altAcc: {description: 'Vertical accuracy of the user''s location, in meters.',
|
example: 0
|
||||||
example: 1}
|
altAcc:
|
||||||
broadcast: {description: 'Who to broadcast this check-in to. Accepts a comma-delimited
|
description: Vertical accuracy of the user's location, in meters.
|
||||||
|
example: 1
|
||||||
|
broadcast:
|
||||||
|
description: >-
|
||||||
|
Who to broadcast this check-in to. Accepts a comma-delimited
|
||||||
list of values: private (off the grid) or public (share with friends), facebook
|
list of values: private (off the grid) or public (share with friends), facebook
|
||||||
share on facebook, twitter share on twitter, followers share with followers
|
share on facebook, twitter share on twitter, followers share with followers
|
||||||
(celebrity mode users only), If no valid value is found, the default is public.
|
(celebrity mode users only), If no valid value is found, the default is public.
|
||||||
[Optional]', example: 'public,twitter'}
|
[Optional]
|
||||||
eventId: {description: 'The event the user is checking in to. [Optional]', example: UHR8THISVNT}
|
example: "public,twitter"
|
||||||
ll: {description: 'Latitude and longitude of the user''s location. Only specify
|
eventId:
|
||||||
|
description: The event the user is checking in to. [Optional]
|
||||||
|
example: UHR8THISVNT
|
||||||
|
ll:
|
||||||
|
description: >-
|
||||||
|
Latitude and longitude of the user's location. Only specify
|
||||||
this field if you have a GPS or other device reported location for the user
|
this field if you have a GPS or other device reported location for the user
|
||||||
at the time of check-in. [Optional]', example: '33.7,44.2'}
|
at the time of check-in. [Optional]
|
||||||
llAcc: {description: 'Accuracy of the user''s latitude and longitude, in meters.
|
example: "33.7,44.2"
|
||||||
[Optional]', example: 1}
|
llAcc:
|
||||||
mentions: {description: 'Mentions in your check-in. This parameter is a semicolon-delimited
|
description: Accuracy of the user's latitude and longitude, in meters. [Optional]
|
||||||
|
example: 1
|
||||||
|
mentions:
|
||||||
|
description: >-
|
||||||
|
Mentions in your check-in. This parameter is a semicolon-delimited
|
||||||
list of mentions. A single mention is of the form "start,end,userid", where
|
list of mentions. A single mention is of the form "start,end,userid", where
|
||||||
start is the index of the first character in the shout representing the mention,
|
start is the index of the first character in the shout representing the mention,
|
||||||
end is the index of the first character in the shout after the mention, and
|
end is the index of the first character in the shout after the mention, and
|
||||||
userid is the userid of the user being mentioned. If userid is prefixed with
|
userid is the userid of the user being mentioned. If userid is prefixed with
|
||||||
"fbu-", this indicates a Facebook userid that is being mention. Character
|
"fbu-", this indicates a Facebook userid that is being mention. Character
|
||||||
indices in shouts are 0-based. [Optional]', example: '5,10,HZXXY3Y;15,20,GZYYZ3Z;25,30,fbu-GZXY13Y'}
|
indices in shouts are 0-based. [Optional]
|
||||||
shout: {description: 'A message about your check-in. The maximum length of this
|
example: "5,10,HZXXY3Y;15,20,GZYYZ3Z;25,30,fbu-GZXY13Y"
|
||||||
field is 140 characters. [Optional]', example: There are crayons! Crayons!}
|
shout:
|
||||||
venueId: {description: 'The Foursquare venue where the user is checking in. [Required]',
|
description: A message about your check-in. The maximum length of this field is 140 characters. [Optional]
|
||||||
example: IHR8THISVNU}
|
example: There are crayons! Crayons!
|
||||||
|
venueId:
|
||||||
|
description: The Foursquare venue where the user is checking in. [Required]
|
||||||
|
example: IHR8THISVNU
|
||||||
|
|
|
@ -7,25 +7,25 @@ add_event:
|
||||||
fields:
|
fields:
|
||||||
calendar_id:
|
calendar_id:
|
||||||
description: The id of the calendar you want.
|
description: The id of the calendar you want.
|
||||||
example: 'Your email'
|
example: "Your email"
|
||||||
summary:
|
summary:
|
||||||
description: Acts as the title of the event.
|
description: Acts as the title of the event.
|
||||||
example: 'Bowling'
|
example: "Bowling"
|
||||||
description:
|
description:
|
||||||
description: The description of the event. Optional.
|
description: The description of the event. Optional.
|
||||||
example: 'Birthday bowling'
|
example: "Birthday bowling"
|
||||||
start_date_time:
|
start_date_time:
|
||||||
description: The date and time the event should start.
|
description: The date and time the event should start.
|
||||||
example: '2019-03-22 20:00:00'
|
example: "2019-03-22 20:00:00"
|
||||||
end_date_time:
|
end_date_time:
|
||||||
description: The date and time the event should end.
|
description: The date and time the event should end.
|
||||||
example: '2019-03-22 22:00:00'
|
example: "2019-03-22 22:00:00"
|
||||||
start_date:
|
start_date:
|
||||||
description: The date the whole day event should start.
|
description: The date the whole day event should start.
|
||||||
example: '2019-03-10'
|
example: "2019-03-10"
|
||||||
end_date:
|
end_date:
|
||||||
description: The date the whole day event should end.
|
description: The date the whole day event should end.
|
||||||
example: '2019-03-11'
|
example: "2019-03-11"
|
||||||
in:
|
in:
|
||||||
description: Days or weeks that you want to create the event in.
|
description: Days or weeks that you want to create the event in.
|
||||||
example: '"days": 2 or "weeks": 2'
|
example: '"days": 2 or "weeks": 2'
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
# Describes the format for available group services
|
# Describes the format for available group services
|
||||||
|
|
||||||
reload:
|
reload:
|
||||||
description: Reload group configuration.
|
description: Reload group configuration.
|
||||||
|
|
||||||
|
@ -23,7 +22,7 @@ set:
|
||||||
example: domain.entity_id1, domain.entity_id2
|
example: domain.entity_id1, domain.entity_id2
|
||||||
all:
|
all:
|
||||||
description: Enable this option if the group should only turn on when all entities are on.
|
description: Enable this option if the group should only turn on when all entities are on.
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
remove:
|
remove:
|
||||||
description: Remove a user group.
|
description: Remove a user group.
|
||||||
|
|
|
@ -1,12 +1,10 @@
|
||||||
# Describes the format for Habitica service
|
# Describes the format for Habitica service
|
||||||
|
|
||||||
---
|
|
||||||
api_call:
|
api_call:
|
||||||
description: Call Habitica api
|
description: Call Habitica api
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: Habitica's username to call for
|
description: Habitica's username to call for
|
||||||
example: 'xxxNotAValidNickxxx'
|
example: "xxxNotAValidNickxxx"
|
||||||
path:
|
path:
|
||||||
description: "Items from API URL in form of an array with method attached at the end. Consult https://habitica.com/apidoc/. Example uses https://habitica.com/apidoc/#api-Task-CreateUserTasks"
|
description: "Items from API URL in form of an array with method attached at the end. Consult https://habitica.com/apidoc/. Example uses https://habitica.com/apidoc/#api-Task-CreateUserTasks"
|
||||||
example: '["tasks", "user", "post"]'
|
example: '["tasks", "user", "post"]'
|
||||||
|
|
|
@ -15,4 +15,4 @@ send_message:
|
||||||
example: '{ "image_file": "file" } or { "image_url": "url" }'
|
example: '{ "image_file": "file" } or { "image_url": "url" }'
|
||||||
|
|
||||||
reconnect:
|
reconnect:
|
||||||
description: Reconnect the bot.
|
description: Reconnect the bot.
|
||||||
|
|
|
@ -3,14 +3,14 @@ sync:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to sync.
|
description: Name(s) of entities to sync.
|
||||||
example: 'remote.family_room'
|
example: "remote.family_room"
|
||||||
|
|
||||||
change_channel:
|
change_channel:
|
||||||
description: Sends change channel command to the Harmony HUB
|
description: Sends change channel command to the Harmony HUB
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of Harmony remote entities to send change channel command to
|
description: Name(s) of Harmony remote entities to send change channel command to
|
||||||
example: 'remote.family_room'
|
example: "remote.family_room"
|
||||||
channel:
|
channel:
|
||||||
description: Channel number to change to
|
description: Channel number to change to
|
||||||
example: '200'
|
example: "200"
|
||||||
|
|
|
@ -1,32 +1,44 @@
|
||||||
power_on: {description: Power on all devices which supports it.}
|
power_on: { description: Power on all devices which supports it. }
|
||||||
select_device:
|
select_device:
|
||||||
description: Select HDMI device.
|
description: Select HDMI device.
|
||||||
fields:
|
fields:
|
||||||
device: {description: 'Address of device to select. Can be entity_id, physical
|
device:
|
||||||
address or alias from configuration.', example: '"switch.hdmi_1" or "1.1.0.0"
|
description: Address of device to select. Can be entity_id, physical address or alias from configuration.
|
||||||
or "01:10"'}
|
example: '"switch.hdmi_1" or "1.1.0.0" or "01:10"'
|
||||||
send_command:
|
send_command:
|
||||||
description: Sends CEC command into HDMI CEC capable adapter.
|
description: Sends CEC command into HDMI CEC capable adapter.
|
||||||
fields:
|
fields:
|
||||||
att:
|
att:
|
||||||
description: Optional parameters.
|
description: Optional parameters.
|
||||||
example: [0, 2]
|
example: [0, 2]
|
||||||
cmd: {description: 'Command itself. Could be decimal number or string with hexadeximal
|
cmd:
|
||||||
notation: "0x10".', example: 144 or "0x90"}
|
description: 'Command itself. Could be decimal number or string with hexadeximal notation: "0x10".'
|
||||||
dst: {description: 'Destination for command. Could be decimal number or string
|
example: 144 or "0x90"
|
||||||
with hexadeximal notation: "0x10".', example: 5 or "0x5"}
|
dst:
|
||||||
raw: {description: 'Raw CEC command in format "00:00:00:00" where first two digits
|
description: 'Destination for command. Could be decimal number or string with hexadeximal notation: "0x10".'
|
||||||
|
example: 5 or "0x5"
|
||||||
|
raw:
|
||||||
|
description: >-
|
||||||
|
Raw CEC command in format "00:00:00:00" where first two digits
|
||||||
are source and destination, second byte is command and optional other bytes
|
are source and destination, second byte is command and optional other bytes
|
||||||
are command parameters. If raw command specified, other params are ignored.',
|
are command parameters. If raw command specified, other params are ignored.
|
||||||
example: '"10:36"'}
|
example: '"10:36"'
|
||||||
src: {description: 'Source of command. Could be decimal number or string with
|
src:
|
||||||
hexadeximal notation: "0x10".', example: 12 or "0xc"}
|
description: 'Source of command. Could be decimal number or string with hexadeximal notation: "0x10".'
|
||||||
standby: {description: Standby all devices which supports it.}
|
example: 12 or "0xc"
|
||||||
update: {description: Update devices state from network.}
|
standby:
|
||||||
|
description: Standby all devices which supports it.
|
||||||
|
update:
|
||||||
|
description: Update devices state from network.
|
||||||
volume:
|
volume:
|
||||||
description: Increase or decrease volume of system.
|
description: Increase or decrease volume of system.
|
||||||
fields:
|
fields:
|
||||||
down: {description: Decreases volume x levels., example: 3}
|
down:
|
||||||
mute: {description: 'Mutes audio system. Value should be on, off or toggle.',
|
description: Decreases volume x levels.
|
||||||
example: toggle}
|
example: 3
|
||||||
up: {description: Increases volume x levels., example: 3}
|
mute:
|
||||||
|
description: Mutes audio system. Value should be on, off or toggle.
|
||||||
|
example: toggle
|
||||||
|
up:
|
||||||
|
description: Increases volume x levels.
|
||||||
|
example: 3
|
||||||
|
|
|
@ -3,10 +3,10 @@ sign_in:
|
||||||
fields:
|
fields:
|
||||||
username:
|
username:
|
||||||
description: The username or email of the HEOS account. [Required]
|
description: The username or email of the HEOS account. [Required]
|
||||||
example: 'example@example.com'
|
example: "example@example.com"
|
||||||
password:
|
password:
|
||||||
description: The password of the HEOS account. [Required]
|
description: The password of the HEOS account. [Required]
|
||||||
example: 'password'
|
example: "password"
|
||||||
|
|
||||||
sign_out:
|
sign_out:
|
||||||
description: Sign the controller out of the HEOS account.
|
description: Sign the controller out of the HEOS account.
|
||||||
|
|
|
@ -1,27 +1,24 @@
|
||||||
boost_heating:
|
boost_heating:
|
||||||
description: "Set the boost mode ON defining the period of time and the desired target temperature
|
description: Set the boost mode ON defining the period of time and the desired target temperature for the boost.
|
||||||
for the boost."
|
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
{
|
description: Enter the entity_id for the device required to set the boost mode.
|
||||||
description: Enter the entity_id for the device required to set the boost mode.,
|
example: "climate.heating"
|
||||||
example: "climate.heating",
|
|
||||||
}
|
|
||||||
time_period:
|
time_period:
|
||||||
{ description: Set the time period for the boost., example: "01:30:00" }
|
description: Set the time period for the boost.
|
||||||
|
example: "01:30:00"
|
||||||
temperature:
|
temperature:
|
||||||
{
|
description: Set the target temperature for the boost period.
|
||||||
description: Set the target temperature for the boost period.,
|
example: "20.5"
|
||||||
example: "20.5",
|
|
||||||
}
|
|
||||||
boost_hot_water:
|
boost_hot_water:
|
||||||
description:
|
description: "Set the boost mode ON or OFF defining the period of time for the boost."
|
||||||
"Set the boost mode ON or OFF defining the period of time for the boost."
|
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
{
|
description: Enter the entity_id for the device reuired to set the boost mode.
|
||||||
description: Enter the entity_id for the device reuired to set the boost mode.,
|
example: "water_heater.hot_water"
|
||||||
example: "water_heater.hot_water",
|
time_period:
|
||||||
}
|
description: Set the time period for the boost.
|
||||||
time_period: { description: Set the time period for the boost., example: "01:30:00" }
|
example: "01:30:00"
|
||||||
on_off: { description: Set the boost function on or off., example: "on" }
|
on_off:
|
||||||
|
description: Set the boost function on or off.
|
||||||
|
example: "on"
|
||||||
|
|
|
@ -62,13 +62,13 @@ dump_hap_config:
|
||||||
fields:
|
fields:
|
||||||
config_output_path:
|
config_output_path:
|
||||||
description: (Default is 'Your home-assistant config directory') Path where to store the config.
|
description: (Default is 'Your home-assistant config directory') Path where to store the config.
|
||||||
example: '/config'
|
example: "/config"
|
||||||
config_output_file_prefix:
|
config_output_file_prefix:
|
||||||
description: (Default is 'hmip-config') Name of the config file. The SGTIN of the AP will always be appended.
|
description: (Default is 'hmip-config') Name of the config file. The SGTIN of the AP will always be appended.
|
||||||
example: 'hmip-config'
|
example: "hmip-config"
|
||||||
anonymize:
|
anonymize:
|
||||||
description: (Default is True) Should the Configuration be anonymized?
|
description: (Default is True) Should the Configuration be anonymized?
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
reset_energy_counter:
|
reset_energy_counter:
|
||||||
description: Reset the energy counter of a measuring entity.
|
description: Reset the energy counter of a measuring entity.
|
||||||
|
|
|
@ -3,96 +3,95 @@
|
||||||
# folder and make your changes.
|
# folder and make your changes.
|
||||||
|
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
# Magnet contact
|
# Magnet contact
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2109"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2109"]'
|
||||||
node: 'dataline_input'
|
node: "dataline_input"
|
||||||
type: 'opening'
|
type: "opening"
|
||||||
inverting: True
|
inverting: true
|
||||||
# Pir sensors
|
# Pir sensors
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x210e"]'
|
- xpath: './/product_dataline[@product_identifier="_0x210e"]'
|
||||||
node: 'dataline_input[1]'
|
node: "dataline_input[1]"
|
||||||
type: 'motion'
|
type: "motion"
|
||||||
# Pir sensors twilight sensor
|
# Pir sensors twilight sensor
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x0"]'
|
- xpath: './/product_dataline[@product_identifier="_0x0"]'
|
||||||
node: 'dataline_input[1]'
|
node: "dataline_input[1]"
|
||||||
type: 'motion'
|
type: "motion"
|
||||||
# Pir sensors alarm
|
# Pir sensors alarm
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x210f"]'
|
- xpath: './/product_dataline[@product_identifier="_0x210f"]'
|
||||||
node: 'dataline_input'
|
node: "dataline_input"
|
||||||
type: 'motion'
|
type: "motion"
|
||||||
# Smoke detector
|
# Smoke detector
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x210a"]'
|
- xpath: './/product_dataline[@product_identifier="_0x210a"]'
|
||||||
node: 'dataline_input'
|
node: "dataline_input"
|
||||||
type: 'smoke'
|
type: "smoke"
|
||||||
# leak detector
|
# leak detector
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x210c"]'
|
- xpath: './/product_dataline[@product_identifier="_0x210c"]'
|
||||||
node: 'dataline_input'
|
node: "dataline_input"
|
||||||
type: 'moisture'
|
type: "moisture"
|
||||||
# light detector
|
# light detector
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2110"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2110"]'
|
||||||
node: 'dataline_input'
|
node: "dataline_input"
|
||||||
type: 'light'
|
type: "light"
|
||||||
|
|
||||||
light:
|
light:
|
||||||
# Wireless Combi dimmer 4 buttons
|
# Wireless Combi dimmer 4 buttons
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4406"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4406"]'
|
||||||
node: 'airlink_dimming'
|
node: "airlink_dimming"
|
||||||
dimmable: True
|
dimmable: true
|
||||||
# Wireless Lamp outlet dimmer
|
# Wireless Lamp outlet dimmer
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4304"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4304"]'
|
||||||
node: 'airlink_dimming'
|
node: "airlink_dimming"
|
||||||
dimmable: True
|
dimmable: true
|
||||||
# Wireless universal dimmer
|
# Wireless universal dimmer
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4306"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4306"]'
|
||||||
node: 'airlink_dimming'
|
node: "airlink_dimming"
|
||||||
dimmable: True
|
dimmable: true
|
||||||
# Wireless Lamp outlet relay
|
# Wireless Lamp outlet relay
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4202"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4202"]'
|
||||||
node: 'airlink_relay'
|
node: "airlink_relay"
|
||||||
# Wireless Combi relay 4 buttons
|
# Wireless Combi relay 4 buttons
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4404"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4404"]'
|
||||||
node: 'airlink_relay'
|
node: "airlink_relay"
|
||||||
# Dataline Lamp outlet
|
# Dataline Lamp outlet
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2202"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2202"]'
|
||||||
node: 'dataline_output'
|
node: "dataline_output"
|
||||||
# Mobile Wireless dimmer
|
# Mobile Wireless dimmer
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4303"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4303"]'
|
||||||
node: 'airlink_dimming'
|
node: "airlink_dimming"
|
||||||
dimmable: True
|
dimmable: true
|
||||||
|
|
||||||
sensor:
|
sensor:
|
||||||
# Temperature sensor
|
# Temperature sensor
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2124"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2124"]'
|
||||||
node: 'resource_temperature'
|
node: "resource_temperature"
|
||||||
unit_of_measurement: '°C'
|
unit_of_measurement: "°C"
|
||||||
# Humidity/temperature
|
# Humidity/temperature
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2135"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2135"]'
|
||||||
node: 'resource_humidity_level'
|
node: "resource_humidity_level"
|
||||||
unit_of_measurement: '%'
|
unit_of_measurement: "%"
|
||||||
# Humidity/temperature
|
# Humidity/temperature
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2135"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2135"]'
|
||||||
node: 'resource_temperature'
|
node: "resource_temperature"
|
||||||
unit_of_measurement: '°C'
|
unit_of_measurement: "°C"
|
||||||
# Lux/temperature
|
# Lux/temperature
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2136"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2136"]'
|
||||||
node: 'resource_light'
|
node: "resource_light"
|
||||||
unit_of_measurement: 'Lux'
|
unit_of_measurement: "Lux"
|
||||||
# Lux/temperature
|
# Lux/temperature
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2136"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2136"]'
|
||||||
node: 'resource_temperature'
|
node: "resource_temperature"
|
||||||
unit_of_measurement: '°C'
|
unit_of_measurement: "°C"
|
||||||
|
|
||||||
switch:
|
switch:
|
||||||
# Wireless Plug outlet
|
# Wireless Plug outlet
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4201"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4201"]'
|
||||||
node: 'airlink_relay'
|
node: "airlink_relay"
|
||||||
# Dataline universal relay
|
# Dataline universal relay
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4203"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4203"]'
|
||||||
node: 'airlink_relay'
|
node: "airlink_relay"
|
||||||
# Dataline plug outlet
|
# Dataline plug outlet
|
||||||
- xpath: './/product_dataline[@product_identifier="_0x2201"]'
|
- xpath: './/product_dataline[@product_identifier="_0x2201"]'
|
||||||
node: 'dataline_output'
|
node: "dataline_output"
|
||||||
# Wireless mobile relay
|
# Wireless mobile relay
|
||||||
- xpath: './/product_airlink[@product_identifier="_0x4204"]'
|
- xpath: './/product_airlink[@product_identifier="_0x4204"]'
|
||||||
node: 'airlink_relay'
|
node: "airlink_relay"
|
||||||
|
|
||||||
|
|
|
@ -28,4 +28,4 @@ pulse:
|
||||||
description: Pulses an input on the IHC controller.
|
description: Pulses an input on the IHC controller.
|
||||||
fields:
|
fields:
|
||||||
ihc_id:
|
ihc_id:
|
||||||
description: The integer IHC resource ID.
|
description: The integer IHC resource ID.
|
||||||
|
|
|
@ -1,14 +1,18 @@
|
||||||
set_datetime:
|
set_datetime:
|
||||||
description: This can be used to dynamically set the date and/or time.
|
description: This can be used to dynamically set the date and/or time.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the input datetime to set the new value.,
|
entity_id:
|
||||||
example: input_datetime.test_date_time}
|
description: Entity id of the input datetime to set the new value.
|
||||||
date: {description: The target date the entity should be set to. Do not use with datetime.,
|
example: input_datetime.test_date_time
|
||||||
example: '"2019-04-20"'}
|
date:
|
||||||
time: {description: The target time the entity should be set to. Do not use with datetime.,
|
description: The target date the entity should be set to. Do not use with datetime.
|
||||||
example: '"05:04:20"'}
|
example: '"2019-04-20"'
|
||||||
datetime: {description: The target date & time the entity should be set to. Do not use with date or time.,
|
time:
|
||||||
example: '"2019-04-20 05:04:20"'}
|
description: The target time the entity should be set to. Do not use with datetime.
|
||||||
|
example: '"05:04:20"'
|
||||||
|
datetime:
|
||||||
|
description: The target date & time the entity should be set to. Do not use with date or time.
|
||||||
|
example: '"2019-04-20 05:04:20"'
|
||||||
|
|
||||||
reload:
|
reload:
|
||||||
description: Reload the input_datetime configuration.
|
description: Reload the input_datetime configuration.
|
||||||
|
|
|
@ -1,18 +1,23 @@
|
||||||
decrement:
|
decrement:
|
||||||
description: Decrement the value of an input number entity by its stepping.
|
description: Decrement the value of an input number entity by its stepping.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the input number the should be decremented.,
|
entity_id:
|
||||||
example: input_number.threshold}
|
description: Entity id of the input number the should be decremented.
|
||||||
|
example: input_number.threshold
|
||||||
increment:
|
increment:
|
||||||
description: Increment the value of an input number entity by its stepping.
|
description: Increment the value of an input number entity by its stepping.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the input number the should be incremented.,
|
entity_id:
|
||||||
example: input_number.threshold}
|
description: Entity id of the input number the should be incremented.
|
||||||
|
example: input_number.threshold
|
||||||
set_value:
|
set_value:
|
||||||
description: Set the value of an input number entity.
|
description: Set the value of an input number entity.
|
||||||
fields:
|
fields:
|
||||||
entity_id: {description: Entity id of the input number to set the new value.,
|
entity_id:
|
||||||
example: input_number.threshold}
|
description: Entity id of the input number to set the new value.
|
||||||
value: {description: The target value the entity should be set to., example: 42}
|
example: input_number.threshold
|
||||||
|
value:
|
||||||
|
description: The target value the entity should be set to.
|
||||||
|
example: 42
|
||||||
reload:
|
reload:
|
||||||
description: Reload the input_number configuration.
|
description: Reload the input_number configuration.
|
||||||
|
|
|
@ -6,7 +6,7 @@ add_all_link:
|
||||||
example: 1
|
example: 1
|
||||||
mode:
|
mode:
|
||||||
description: Linking mode controller - IM is controller responder - IM is responder
|
description: Linking mode controller - IM is controller responder - IM is responder
|
||||||
example: 'controller'
|
example: "controller"
|
||||||
delete_all_link:
|
delete_all_link:
|
||||||
description: Tells the Insteon Modem (IM) to remove an All-Link record from the All-Link Database of the IM and a device. Once the IM is set to delete the link, press the link button on the corresponding device to complete the process.
|
description: Tells the Insteon Modem (IM) to remove an All-Link record from the All-Link Database of the IM and a device. Once the IM is set to delete the link, press the link button on the corresponding device to complete the process.
|
||||||
fields:
|
fields:
|
||||||
|
@ -18,16 +18,16 @@ load_all_link_database:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the device to load. Use "all" to load the database of all devices.
|
description: Name of the device to load. Use "all" to load the database of all devices.
|
||||||
example: 'light.1a2b3c'
|
example: "light.1a2b3c"
|
||||||
reload:
|
reload:
|
||||||
description: Reload all records. If true the current records are cleared from memory (does not effect the device) and the records are reloaded. If false the existing records are left in place and only missing records are added. Default is false.
|
description: Reload all records. If true the current records are cleared from memory (does not effect the device) and the records are reloaded. If false the existing records are left in place and only missing records are added. Default is false.
|
||||||
example: 'true'
|
example: "true"
|
||||||
print_all_link_database:
|
print_all_link_database:
|
||||||
description: Print the All-Link Database for a device. Requires that the All-Link Database is loaded into memory.
|
description: Print the All-Link Database for a device. Requires that the All-Link Database is loaded into memory.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the device to print
|
description: Name of the device to print
|
||||||
example: 'light.1a2b3c'
|
example: "light.1a2b3c"
|
||||||
print_im_all_link_database:
|
print_im_all_link_database:
|
||||||
description: Print the All-Link Database for the INSTEON Modem (IM).
|
description: Print the All-Link Database for the INSTEON Modem (IM).
|
||||||
x10_all_units_off:
|
x10_all_units_off:
|
||||||
|
@ -59,4 +59,4 @@ scene_off:
|
||||||
fields:
|
fields:
|
||||||
group:
|
group:
|
||||||
description: INSTEON group or scene number
|
description: INSTEON group or scene number
|
||||||
example: 26
|
example: 26
|
||||||
|
|
|
@ -3,4 +3,4 @@ speedtest:
|
||||||
fields:
|
fields:
|
||||||
host:
|
host:
|
||||||
description: The host name of the iperf3 server (already configured) to run a test with.
|
description: The host name of the iperf3 server (already configured) to run a test with.
|
||||||
example: 'iperf.he.net'
|
example: "iperf.he.net"
|
||||||
|
|
|
@ -5,7 +5,7 @@ output_abs:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
output:
|
output:
|
||||||
description: Output port
|
description: Output port
|
||||||
example: "output1"
|
example: "output1"
|
||||||
|
@ -21,7 +21,7 @@ output_rel:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
output:
|
output:
|
||||||
description: Output port
|
description: Output port
|
||||||
example: "output1"
|
example: "output1"
|
||||||
|
@ -37,7 +37,7 @@ output_toggle:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
output:
|
output:
|
||||||
description: Output port
|
description: Output port
|
||||||
example: "output1"
|
example: "output1"
|
||||||
|
@ -50,7 +50,7 @@ relays:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
state:
|
state:
|
||||||
description: Relays states as string (1=on, 2=off, t=toggle, -=nochange)
|
description: Relays states as string (1=on, 2=off, t=toggle, -=nochange)
|
||||||
example: "t---001-"
|
example: "t---001-"
|
||||||
|
@ -60,16 +60,16 @@ led:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
led:
|
led:
|
||||||
description: Led
|
description: Led
|
||||||
example: "led6"
|
example: "led6"
|
||||||
state:
|
state:
|
||||||
description: Led state
|
description: Led state
|
||||||
example: 'blink'
|
example: "blink"
|
||||||
values:
|
values:
|
||||||
- on
|
- "on"
|
||||||
- off
|
- "off"
|
||||||
- blink
|
- blink
|
||||||
- flicker
|
- flicker
|
||||||
|
|
||||||
|
@ -78,45 +78,45 @@ var_abs:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
variable:
|
variable:
|
||||||
description: Variable or setpoint name
|
description: Variable or setpoint name
|
||||||
example: 'var1'
|
example: "var1"
|
||||||
value:
|
value:
|
||||||
description: Value to set
|
description: Value to set
|
||||||
example: '50'
|
example: "50"
|
||||||
unit_of_measurement:
|
unit_of_measurement:
|
||||||
description: Unit of value
|
description: Unit of value
|
||||||
example: 'celsius'
|
example: "celsius"
|
||||||
|
|
||||||
var_reset:
|
var_reset:
|
||||||
description: Reset value of variable or setpoint.
|
description: Reset value of variable or setpoint.
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
variable:
|
variable:
|
||||||
description: Variable or setpoint name
|
description: Variable or setpoint name
|
||||||
example: 'var1'
|
example: "var1"
|
||||||
|
|
||||||
var_rel:
|
var_rel:
|
||||||
description: Shift value of a variable, setpoint or threshold.
|
description: Shift value of a variable, setpoint or threshold.
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
variable:
|
variable:
|
||||||
description: Variable or setpoint name
|
description: Variable or setpoint name
|
||||||
example: 'var1'
|
example: "var1"
|
||||||
value:
|
value:
|
||||||
description: Shift value
|
description: Shift value
|
||||||
example: '50'
|
example: "50"
|
||||||
unit_of_measurement:
|
unit_of_measurement:
|
||||||
description: Unit of value
|
description: Unit of value
|
||||||
example: 'celsius'
|
example: "celsius"
|
||||||
value_reference:
|
value_reference:
|
||||||
description: Reference value (current or programmed) for setpoint and threshold
|
description: Reference value (current or programmed) for setpoint and threshold
|
||||||
example: 'current'
|
example: "current"
|
||||||
values:
|
values:
|
||||||
- current
|
- current
|
||||||
- prog
|
- prog
|
||||||
|
@ -126,10 +126,10 @@ lock_regulator:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
setpoint:
|
setpoint:
|
||||||
description: Setpoint name
|
description: Setpoint name
|
||||||
example: 'r1varsetpoint'
|
example: "r1varsetpoint"
|
||||||
state:
|
state:
|
||||||
description: New setpoint state
|
description: New setpoint state
|
||||||
example: true
|
example: true
|
||||||
|
@ -139,13 +139,13 @@ send_keys:
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
keys:
|
keys:
|
||||||
description: Keys to send
|
description: Keys to send
|
||||||
example: 'a1a5d8'
|
example: "a1a5d8"
|
||||||
state:
|
state:
|
||||||
description: 'Key state upon sending (optional, must be hit for deferred)'
|
description: "Key state upon sending (optional, must be hit for deferred)"
|
||||||
example: 'hit'
|
example: "hit"
|
||||||
values:
|
values:
|
||||||
- hit
|
- hit
|
||||||
- make
|
- make
|
||||||
|
@ -155,46 +155,46 @@ send_keys:
|
||||||
example: 10
|
example: 10
|
||||||
time_unit:
|
time_unit:
|
||||||
description: Time unit of send delay (optional)
|
description: Time unit of send delay (optional)
|
||||||
example: 's'
|
example: "s"
|
||||||
|
|
||||||
lock_keys:
|
lock_keys:
|
||||||
description: Lock keys.
|
description: Lock keys.
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
table:
|
table:
|
||||||
description: 'Table with keys to lock (optional, must be A for interval).'
|
description: "Table with keys to lock (optional, must be A for interval)."
|
||||||
example: 'A5'
|
example: "A5"
|
||||||
state:
|
state:
|
||||||
description: Key lock states as string (1=on, 2=off, T=toggle, -=nochange)
|
description: Key lock states as string (1=on, 2=off, T=toggle, -=nochange)
|
||||||
example: '1---t0--'
|
example: "1---t0--"
|
||||||
time:
|
time:
|
||||||
description: Lock interval (optional)
|
description: Lock interval (optional)
|
||||||
example: 10
|
example: 10
|
||||||
time_unit:
|
time_unit:
|
||||||
description: Time unit of lock interval (optional)
|
description: Time unit of lock interval (optional)
|
||||||
example: 's'
|
example: "s"
|
||||||
|
|
||||||
dyn_text:
|
dyn_text:
|
||||||
description: Send dynamic text to LCN-GTxD displays.
|
description: Send dynamic text to LCN-GTxD displays.
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
row:
|
row:
|
||||||
description: Text row 1..4 (support of 4 independent text rows)
|
description: Text row 1..4 (support of 4 independent text rows)
|
||||||
example: 1
|
example: 1
|
||||||
text:
|
text:
|
||||||
description: Text to send (up to 60 characters encoded as UTF-8)
|
description: Text to send (up to 60 characters encoded as UTF-8)
|
||||||
example: 'text up to 60 characters'
|
example: "text up to 60 characters"
|
||||||
|
|
||||||
pck:
|
pck:
|
||||||
description: Send arbitrary PCK command.
|
description: Send arbitrary PCK command.
|
||||||
fields:
|
fields:
|
||||||
address:
|
address:
|
||||||
description: Module address
|
description: Module address
|
||||||
example: 'myhome.s0.m7'
|
example: "myhome.s0.m7"
|
||||||
pck:
|
pck:
|
||||||
description: PCK command (without address header)
|
description: PCK command (without address header)
|
||||||
example: 'PIN4'
|
example: "PIN4"
|
||||||
|
|
|
@ -17,7 +17,7 @@ set_state:
|
||||||
example: 10
|
example: 10
|
||||||
power:
|
power:
|
||||||
description: Turn the light on (True) or off (False). Leave out to keep the power as it is.
|
description: Turn the light on (True) or off (False). Leave out to keep the power as it is.
|
||||||
example: True
|
example: false
|
||||||
|
|
||||||
effect_pulse:
|
effect_pulse:
|
||||||
description: Run a flash effect by changing to a color and back.
|
description: Run a flash effect by changing to a color and back.
|
||||||
|
@ -45,7 +45,7 @@ effect_pulse:
|
||||||
example: 2
|
example: 2
|
||||||
power_on:
|
power_on:
|
||||||
description: Powered off lights are temporarily turned on during the effect (default True).
|
description: Powered off lights are temporarily turned on during the effect (default True).
|
||||||
example: False
|
example: false
|
||||||
|
|
||||||
effect_colorloop:
|
effect_colorloop:
|
||||||
description: Run an effect with looping colors.
|
description: Run an effect with looping colors.
|
||||||
|
@ -67,7 +67,7 @@ effect_colorloop:
|
||||||
example: 0
|
example: 0
|
||||||
power_on:
|
power_on:
|
||||||
description: Powered off lights are temporarily turned on during the effect (default True).
|
description: Powered off lights are temporarily turned on during the effect (default True).
|
||||||
example: False
|
example: false
|
||||||
|
|
||||||
effect_stop:
|
effect_stop:
|
||||||
description: Stop a running effect.
|
description: Stop a running effect.
|
||||||
|
|
|
@ -12,4 +12,4 @@ log:
|
||||||
example: "light.kitchen"
|
example: "light.kitchen"
|
||||||
domain:
|
domain:
|
||||||
description: Icon of domain to display in custom logbook entry [Optional]
|
description: Icon of domain to display in custom logbook entry [Optional]
|
||||||
example: "light"
|
example: "light"
|
||||||
|
|
|
@ -3,7 +3,7 @@ send_message:
|
||||||
fields:
|
fields:
|
||||||
message:
|
message:
|
||||||
description: The message to be sent.
|
description: The message to be sent.
|
||||||
example: 'This is a message I am sending to matrix'
|
example: This is a message I am sending to matrix
|
||||||
target:
|
target:
|
||||||
description: A list of room(s) to send the message to.
|
description: A list of room(s) to send the message to.
|
||||||
example: '#hasstest:matrix.org'
|
example: "#hasstest:matrix.org"
|
||||||
|
|
|
@ -1,13 +1,12 @@
|
||||||
play_media:
|
play_media:
|
||||||
description: Downloads file from given url.
|
description: Downloads file from given url.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to play media on.
|
description: Name(s) of entities to play media on.
|
||||||
example: 'media_player.living_room_chromecast'
|
example: "media_player.living_room_chromecast"
|
||||||
media_content_id:
|
media_content_id:
|
||||||
description: The ID of the content to play. Platform dependent.
|
description: The ID of the content to play. Platform dependent.
|
||||||
example: 'https://soundcloud.com/bruttoband/brutto-11'
|
example: "https://soundcloud.com/bruttoband/brutto-11"
|
||||||
media_content_type:
|
media_content_type:
|
||||||
description: The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC.
|
description: The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC.
|
||||||
example: 'music'
|
example: "music"
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ set_room_temperature:
|
||||||
fields:
|
fields:
|
||||||
room_name:
|
room_name:
|
||||||
description: Name of room to change.
|
description: Name of room to change.
|
||||||
example: 'kitchen'
|
example: "kitchen"
|
||||||
away_temp:
|
away_temp:
|
||||||
description: Away temp.
|
description: Away temp.
|
||||||
example: 12
|
example: 12
|
||||||
|
@ -12,4 +12,4 @@ set_room_temperature:
|
||||||
example: 22
|
example: 22
|
||||||
sleep_temp:
|
sleep_temp:
|
||||||
description: Sleep temp.
|
description: Sleep temp.
|
||||||
example: 17
|
example: 17
|
||||||
|
|
|
@ -3,7 +3,7 @@ send_ir_code:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities that should have the IR code set and be turned on. Platform dependent.
|
description: Name(s) of entities that should have the IR code set and be turned on. Platform dependent.
|
||||||
example: 'switch.living_room_1_1'
|
example: "switch.living_room_1_1"
|
||||||
V_IR_SEND:
|
V_IR_SEND:
|
||||||
description: IR code to send.
|
description: IR code to send.
|
||||||
example: '0xC284'
|
example: "0xC284"
|
||||||
|
|
|
@ -3,7 +3,7 @@ custom_cleaning:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity. [Required]
|
description: Name of the vacuum entity. [Required]
|
||||||
example: 'vacuum.neato'
|
example: "vacuum.neato"
|
||||||
mode:
|
mode:
|
||||||
description: "Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set."
|
description: "Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set."
|
||||||
example: 2
|
example: 2
|
||||||
|
@ -15,4 +15,4 @@ custom_cleaning:
|
||||||
example: 2
|
example: 2
|
||||||
zone:
|
zone:
|
||||||
description: Only supported on the Botvac D7. Name of the zone to clean. Defaults to no zone i.e. complete house cleanup.
|
description: Only supported on the Botvac D7. Name of the zone to clean. Defaults to no zone i.e. complete house cleanup.
|
||||||
example: "Kitchen"
|
example: "Kitchen"
|
||||||
|
|
|
@ -16,4 +16,4 @@ panic:
|
||||||
fields:
|
fields:
|
||||||
code:
|
code:
|
||||||
description: The user code to use to trigger the panic.
|
description: The user code to use to trigger the panic.
|
||||||
example: 1234
|
example: 1234
|
||||||
|
|
|
@ -5,7 +5,7 @@ set_aircleaner_mode:
|
||||||
description: "This setting will affect all zones connected to the thermostat."
|
description: "This setting will affect all zones connected to the thermostat."
|
||||||
example: climate.master_bedroom
|
example: climate.master_bedroom
|
||||||
aircleaner_mode:
|
aircleaner_mode:
|
||||||
description: "The air cleaner mode to set. Options include \"auto\", \"quick\", or \"allergy\"."
|
description: 'The air cleaner mode to set. Options include "auto", "quick", or "allergy".'
|
||||||
example: allergy
|
example: allergy
|
||||||
|
|
||||||
set_humidify_setpoint:
|
set_humidify_setpoint:
|
||||||
|
@ -16,4 +16,4 @@ set_humidify_setpoint:
|
||||||
example: climate.master_bedroom
|
example: climate.master_bedroom
|
||||||
humidity:
|
humidity:
|
||||||
description: "The humidification setpoint as an int, range 35-65."
|
description: "The humidification setpoint as an int, range 35-65."
|
||||||
example: 45
|
example: 45
|
||||||
|
|
|
@ -3,16 +3,15 @@ led_matrix:
|
||||||
fields:
|
fields:
|
||||||
matrix:
|
matrix:
|
||||||
description: "A string representation of the matrix to be displayed. See the SDK documentation for more info: https://github.com/getSenic/nuimo-linux-python#write-to-nuimos-led-matrix"
|
description: "A string representation of the matrix to be displayed. See the SDK documentation for more info: https://github.com/getSenic/nuimo-linux-python#write-to-nuimos-led-matrix"
|
||||||
example:
|
example: "........
|
||||||
'........
|
0000000.
|
||||||
0000000.
|
.000000.
|
||||||
.000000.
|
..00000.
|
||||||
..00000.
|
.0.0000.
|
||||||
.0.0000.
|
.00.000.
|
||||||
.00.000.
|
.000000.
|
||||||
.000000.
|
.000000.
|
||||||
.000000.
|
........"
|
||||||
........'
|
|
||||||
interval:
|
interval:
|
||||||
description: Display interval in seconds
|
description: Display interval in seconds
|
||||||
example: 0.5
|
example: 0.5
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
# Ombi services.yaml entries
|
# Ombi services.yaml entries
|
||||||
|
|
||||||
submit_movie_request:
|
submit_movie_request:
|
||||||
description: Searches for a movie and requests the first result.
|
description: Searches for a movie and requests the first result.
|
||||||
fields:
|
fields:
|
||||||
|
@ -7,7 +6,6 @@ submit_movie_request:
|
||||||
description: Search parameter
|
description: Search parameter
|
||||||
example: "beverly hills cop"
|
example: "beverly hills cop"
|
||||||
|
|
||||||
|
|
||||||
submit_tv_request:
|
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:
|
||||||
|
@ -18,10 +16,9 @@ submit_tv_request:
|
||||||
description: Which season(s) to request (first, latest or all)
|
description: Which season(s) to request (first, latest or all)
|
||||||
example: "latest"
|
example: "latest"
|
||||||
|
|
||||||
|
|
||||||
submit_music_request:
|
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:
|
||||||
description: Search parameter
|
description: Search parameter
|
||||||
example: "nevermind"
|
example: "nevermind"
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
# Describes the format for available OpenUV services
|
# Describes the format for available OpenUV services
|
||||||
|
|
||||||
---
|
|
||||||
update_data:
|
update_data:
|
||||||
description: Request new data from OpenUV. Consumes two API calls.
|
description: Request new data from OpenUV. Consumes two API calls.
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ disable:
|
||||||
duration:
|
duration:
|
||||||
description: Time that the Pi-hole should be disabled for
|
description: Time that the Pi-hole should be disabled for
|
||||||
example: "00:00:15"
|
example: "00:00:15"
|
||||||
name:
|
name:
|
||||||
description: "[Optional] When multiple Pi-holes are configured, the name of the one to disable. If omitted, all configured Pi-holes will be disabled."
|
description: "[Optional] When multiple Pi-holes are configured, the name of the one to disable. If omitted, all configured Pi-holes will be disabled."
|
||||||
example: "Pi-Hole"
|
example: "Pi-Hole"
|
||||||
enable:
|
enable:
|
||||||
|
@ -12,4 +12,4 @@ enable:
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: "[Optional] When multiple Pi-holes are configured, the name of the one to enable. If omitted, all configured Pi-holes will be enabled."
|
description: "[Optional] When multiple Pi-holes are configured, the name of the one to enable. If omitted, all configured Pi-holes will be enabled."
|
||||||
example: "Pi-Hole"
|
example: "Pi-Hole"
|
||||||
|
|
|
@ -3,11 +3,11 @@ start_record:
|
||||||
fields:
|
fields:
|
||||||
guid:
|
guid:
|
||||||
description: GUID of the channel to start recording.
|
description: GUID of the channel to start recording.
|
||||||
example: '245EBE933C0A597EBE865C0A245E0002'
|
example: "245EBE933C0A597EBE865C0A245E0002"
|
||||||
|
|
||||||
stop_record:
|
stop_record:
|
||||||
description: Stop QVR Pro recording on specified channel.
|
description: Stop QVR Pro recording on specified channel.
|
||||||
fields:
|
fields:
|
||||||
guid:
|
guid:
|
||||||
description: GUID of the channel to stop recording.
|
description: GUID of the channel to stop recording.
|
||||||
example: '245EBE933C0A597EBE865C0A245E0002'
|
example: "245EBE933C0A597EBE865C0A245E0002"
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
# Describes the format for available RainMachine services
|
# Describes the format for available RainMachine services
|
||||||
|
|
||||||
---
|
|
||||||
disable_program:
|
disable_program:
|
||||||
description: Disable a program.
|
description: Disable a program.
|
||||||
fields:
|
fields:
|
||||||
|
|
|
@ -1,24 +1,21 @@
|
||||||
# Describes the format for available Remember The Milk services
|
# Describes the format for available Remember The Milk services
|
||||||
|
|
||||||
create_task:
|
create_task:
|
||||||
description: >
|
description: >-
|
||||||
Create (or update) a new task in your Remember The Milk account. If you want to update a task
|
Create (or update) a new task in your Remember The Milk account. If you want to update a task
|
||||||
later on, you have to set an "id" when creating the task.
|
later on, you have to set an "id" when creating the task.
|
||||||
Note: Updating a tasks does not support the smart syntax.
|
Note: Updating a tasks does not support the smart syntax.
|
||||||
|
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: name of the new task, you can use the smart syntax here
|
description: name of the new task, you can use the smart syntax here
|
||||||
example: 'do this ^today #from_hass'
|
example: "do this ^today #from_hass"
|
||||||
|
|
||||||
id:
|
id:
|
||||||
description: (optional) identifier for the task you're creating, can be used to update or complete the task later on
|
description: (optional) identifier for the task you're creating, can be used to update or complete the task later on
|
||||||
example: myid
|
example: myid
|
||||||
|
|
||||||
complete_task:
|
complete_task:
|
||||||
description: Complete a tasks that was privously created.
|
description: Complete a tasks that was privously created.
|
||||||
|
|
||||||
fields:
|
fields:
|
||||||
id:
|
id:
|
||||||
description: identifier that was defined when creating the task
|
description: identifier that was defined when creating the task
|
||||||
example: myid
|
example: myid
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
update:
|
update:
|
||||||
description: Updates the data we have for all your ring devices
|
description: Updates the data we have for all your ring devices
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
update_records:
|
update_records:
|
||||||
description: Trigger update of records.
|
description: Trigger update of records.
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
# Describes the format for available SimpliSafe services
|
# Describes the format for available SimpliSafe services
|
||||||
|
|
||||||
---
|
|
||||||
remove_pin:
|
remove_pin:
|
||||||
description: Remove a PIN by its label or value.
|
description: Remove a PIN by its label or value.
|
||||||
fields:
|
fields:
|
||||||
|
|
|
@ -1,31 +1,42 @@
|
||||||
feedback_off:
|
feedback_off:
|
||||||
description: Turns feedback sounds off.
|
description: Turns feedback sounds off.
|
||||||
fields:
|
fields:
|
||||||
site_id: {description: 'Site to turn sounds on, defaults to all sites (optional)',
|
site_id:
|
||||||
example: bedroom}
|
description: Site to turn sounds on, defaults to all sites (optional)
|
||||||
|
example: bedroom
|
||||||
feedback_on:
|
feedback_on:
|
||||||
description: Turns feedback sounds on.
|
description: Turns feedback sounds on.
|
||||||
fields:
|
fields:
|
||||||
site_id: {description: 'Site to turn sounds on, defaults to all sites (optional)',
|
site_id:
|
||||||
example: bedroom}
|
description: Site to turn sounds on, defaults to all sites (optional)
|
||||||
|
example: bedroom
|
||||||
say:
|
say:
|
||||||
description: Send a TTS message to Snips.
|
description: Send a TTS message to Snips.
|
||||||
fields:
|
fields:
|
||||||
custom_data: {description: custom data that will be included with all messages
|
custom_data:
|
||||||
in this session, example: user=UserName}
|
description: custom data that will be included with all messages in this session
|
||||||
site_id: {description: 'Site to use to start session, defaults to default (optional)',
|
example: user=UserName
|
||||||
example: bedroom}
|
site_id:
|
||||||
text: {description: Text to say., example: My name is snips}
|
description: Site to use to start session, defaults to default (optional)
|
||||||
|
example: bedroom
|
||||||
|
text:
|
||||||
|
description: Text to say.
|
||||||
|
example: My name is snips
|
||||||
say_action:
|
say_action:
|
||||||
description: Send a TTS message to Snips to listen for a response.
|
description: Send a TTS message to Snips to listen for a response.
|
||||||
fields:
|
fields:
|
||||||
can_be_enqueued: {description: 'If True, session waits for an open session to
|
can_be_enqueued:
|
||||||
end, if False session is dropped if one is running', example: true}
|
description: If True, session waits for an open session to end, if False session is dropped if one is running
|
||||||
custom_data: {description: custom data that will be included with all messages
|
example: true
|
||||||
in this session, example: user=UserName}
|
custom_data:
|
||||||
intent_filter: {description: Optional Array of Strings - A list of intents names
|
description: custom data that will be included with all messages in this session
|
||||||
to restrict the NLU resolution to on the first query., example: 'turnOnLights,
|
example: user=UserName
|
||||||
turnOffLights'}
|
intent_filter:
|
||||||
site_id: {description: 'Site to use to start session, defaults to default (optional)',
|
description: Optional Array of Strings - A list of intents names to restrict the NLU resolution to on the first query.
|
||||||
example: bedroom}
|
example: "turnOnLights, turnOffLights"
|
||||||
text: {description: Text to say, example: My name is snips}
|
site_id:
|
||||||
|
description: Site to use to start session, defaults to default (optional)
|
||||||
|
example: bedroom
|
||||||
|
text:
|
||||||
|
description: Text to say
|
||||||
|
example: My name is snips
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
speedtest:
|
speedtest:
|
||||||
description: Immediately take a speedest with Speedtest.net
|
description: Immediately take a speedest with Speedtest.net
|
||||||
|
|
|
@ -5,11 +5,11 @@ record:
|
||||||
description: The input source for the stream.
|
description: The input source for the stream.
|
||||||
example: "rtsp://my.stream.feed:554"
|
example: "rtsp://my.stream.feed:554"
|
||||||
filename:
|
filename:
|
||||||
description: The file name string.
|
description: The file name string.
|
||||||
example: "/tmp/my_stream.mp4"
|
example: "/tmp/my_stream.mp4"
|
||||||
duration:
|
duration:
|
||||||
description: "Target recording length (in seconds). Default: 30"
|
description: "Target recording length (in seconds). Default: 30"
|
||||||
example: 30
|
example: 30
|
||||||
lookback:
|
lookback:
|
||||||
description: "Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream for stream_source. Default: 0"
|
description: "Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream for stream_source. Default: 0"
|
||||||
example: 5
|
example: 5
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
set_away_mode:
|
set_away_mode:
|
||||||
description: 'Set the home/away mode for a Streamlabs Water Monitor.'
|
description: "Set the home/away mode for a Streamlabs Water Monitor."
|
||||||
fields:
|
fields:
|
||||||
away_mode: {description: home or away, example: 'home'}
|
away_mode:
|
||||||
|
description: home or away
|
||||||
|
example: "home"
|
||||||
|
|
|
@ -6,10 +6,10 @@ start:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Entity id of the timer to start. [optional]
|
description: Entity id of the timer to start. [optional]
|
||||||
example: 'timer.timer0'
|
example: "timer.timer0"
|
||||||
duration:
|
duration:
|
||||||
description: Duration the timer requires to finish. [optional]
|
description: Duration the timer requires to finish. [optional]
|
||||||
example: '00:01:00 or 60'
|
example: "00:01:00 or 60"
|
||||||
|
|
||||||
pause:
|
pause:
|
||||||
description: Pause a timer.
|
description: Pause a timer.
|
||||||
|
@ -17,7 +17,7 @@ pause:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Entity id of the timer to pause. [optional]
|
description: Entity id of the timer to pause. [optional]
|
||||||
example: 'timer.timer0'
|
example: "timer.timer0"
|
||||||
|
|
||||||
cancel:
|
cancel:
|
||||||
description: Cancel a timer.
|
description: Cancel a timer.
|
||||||
|
@ -25,7 +25,7 @@ cancel:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Entity id of the timer to cancel. [optional]
|
description: Entity id of the timer to cancel. [optional]
|
||||||
example: 'timer.timer0'
|
example: "timer.timer0"
|
||||||
|
|
||||||
finish:
|
finish:
|
||||||
description: Finish a timer.
|
description: Finish a timer.
|
||||||
|
@ -33,4 +33,4 @@ finish:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Entity id of the timer to finish. [optional]
|
description: Entity id of the timer to finish. [optional]
|
||||||
example: 'timer.timer0'
|
example: "timer.timer0"
|
||||||
|
|
|
@ -5,31 +5,31 @@ reset:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the utility meter to reset
|
description: Name(s) of the utility meter to reset
|
||||||
example: 'utility_meter.energy'
|
example: "utility_meter.energy"
|
||||||
|
|
||||||
next_tariff:
|
next_tariff:
|
||||||
description: Changes the tariff to the next one.
|
description: Changes the tariff to the next one.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to reset
|
description: Name(s) of entities to reset
|
||||||
example: 'utility_meter.energy'
|
example: "utility_meter.energy"
|
||||||
|
|
||||||
select_tariff:
|
select_tariff:
|
||||||
description: selects the current tariff of an utility meter.
|
description: selects the current tariff of an utility meter.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the entity to set the tariff for
|
description: Name of the entity to set the tariff for
|
||||||
example: 'utility_meter.energy'
|
example: "utility_meter.energy"
|
||||||
tariff:
|
tariff:
|
||||||
description: Name of the tariff to switch to
|
description: Name of the tariff to switch to
|
||||||
example: 'offpeak'
|
example: "offpeak"
|
||||||
|
|
||||||
calibrate:
|
calibrate:
|
||||||
description: calibrates an utility meter.
|
description: calibrates an utility meter.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the entity to calibrate
|
description: Name of the entity to calibrate
|
||||||
example: 'utility_meter.energy'
|
example: "utility_meter.energy"
|
||||||
value:
|
value:
|
||||||
description: Value to which set the meter
|
description: Value to which set the meter
|
||||||
example: '100'
|
example: "100"
|
||||||
|
|
|
@ -2,8 +2,7 @@ set_profile:
|
||||||
description: Set the ventilation profile.
|
description: Set the ventilation profile.
|
||||||
fields:
|
fields:
|
||||||
profile:
|
profile:
|
||||||
description: >
|
description: "Set to any of: Home, Away, Boost, Fireplace"
|
||||||
Set to any of: Home, Away, Boost, Fireplace
|
|
||||||
example: Away
|
example: Away
|
||||||
|
|
||||||
set_profile_fan_speed_home:
|
set_profile_fan_speed_home:
|
||||||
|
@ -13,7 +12,6 @@ set_profile_fan_speed_home:
|
||||||
description: Fan speed in %. Integer, between 0 and 100.
|
description: Fan speed in %. Integer, between 0 and 100.
|
||||||
example: 50
|
example: 50
|
||||||
|
|
||||||
|
|
||||||
set_profile_fan_speed_away:
|
set_profile_fan_speed_away:
|
||||||
description: Set the fan speed of the Away profile.
|
description: Set the fan speed of the Away profile.
|
||||||
fields:
|
fields:
|
||||||
|
|
|
@ -10,9 +10,9 @@ set_memo_text:
|
||||||
description: >
|
description: >
|
||||||
The module address in decimal format.
|
The module address in decimal format.
|
||||||
The decimal addresses are displayed in front of the modules listed at the integration page.
|
The decimal addresses are displayed in front of the modules listed at the integration page.
|
||||||
example: '11'
|
example: "11"
|
||||||
memo_text:
|
memo_text:
|
||||||
description: >
|
description: >
|
||||||
The actual text to be displayed.
|
The actual text to be displayed.
|
||||||
Text is limited to 64 characters.
|
Text is limited to 64 characters.
|
||||||
example: 'Do not forget trash'
|
example: "Do not forget trash"
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
update_devices:
|
update_devices:
|
||||||
description: Add new VeSync devices to Home Assistant
|
description: Add new VeSync devices to Home Assistant
|
||||||
|
|
|
@ -1,35 +1,37 @@
|
||||||
# Describes the format for available webostv services
|
# Describes the format for available webostv services
|
||||||
|
|
||||||
button:
|
button:
|
||||||
description: 'Send a button press command.'
|
description: "Send a button press command."
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the webostv entities where to run the API method.
|
description: Name(s) of the webostv entities where to run the API method.
|
||||||
example: 'media_player.living_room_tv'
|
example: "media_player.living_room_tv"
|
||||||
button:
|
button:
|
||||||
description: Name of the button to press. Known possible values are
|
description: >-
|
||||||
|
Name of the button to press. Known possible values are
|
||||||
LEFT, RIGHT, DOWN, UP, HOME, BACK, ENTER, DASH, INFO, ASTERISK, CC, EXIT,
|
LEFT, RIGHT, DOWN, UP, HOME, BACK, ENTER, DASH, INFO, ASTERISK, CC, EXIT,
|
||||||
MUTE, RED, GREEN, BLUE, VOLUMEUP, VOLUMEDOWN, CHANNELUP, CHANNELDOWN,
|
MUTE, RED, GREEN, BLUE, VOLUMEUP, VOLUMEDOWN, CHANNELUP, CHANNELDOWN,
|
||||||
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
|
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
|
||||||
example: 'LEFT'
|
example: "LEFT"
|
||||||
|
|
||||||
command:
|
command:
|
||||||
description: 'Send a command.'
|
description: "Send a command."
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the webostv entities where to run the API method.
|
description: Name(s) of the webostv entities where to run the API method.
|
||||||
example: 'media_player.living_room_tv'
|
example: "media_player.living_room_tv"
|
||||||
command:
|
command:
|
||||||
description: Endpoint of the command. Known valid endpoints are listed in
|
description: >-
|
||||||
|
Endpoint of the command. Known valid endpoints are listed in
|
||||||
https://github.com/TheRealLink/pylgtv/blob/master/pylgtv/endpoints.py
|
https://github.com/TheRealLink/pylgtv/blob/master/pylgtv/endpoints.py
|
||||||
example: 'media.controls/rewind'
|
example: "media.controls/rewind"
|
||||||
|
|
||||||
select_sound_output:
|
select_sound_output:
|
||||||
description: 'Send the TV the command to change sound output.'
|
description: "Send the TV the command to change sound output."
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the webostv entities to change sound output on.
|
description: Name(s) of the webostv entities to change sound output on.
|
||||||
example: 'media_player.living_room_tv'
|
example: "media_player.living_room_tv"
|
||||||
sound_output:
|
sound_output:
|
||||||
description: Name of the sound output to switch to.
|
description: Name of the sound output to switch to.
|
||||||
example: 'external_speaker'
|
example: "external_speaker"
|
||||||
|
|
|
@ -1,17 +1,16 @@
|
||||||
# Describes the format for available Wink services
|
# Describes the format for available Wink services
|
||||||
|
|
||||||
pair_new_device:
|
pair_new_device:
|
||||||
description: Pair a new device to a Wink Hub.
|
description: Pair a new device to a Wink Hub.
|
||||||
fields:
|
fields:
|
||||||
hub_name:
|
hub_name:
|
||||||
description: The name of the hub to pair a new device to.
|
description: The name of the hub to pair a new device to.
|
||||||
example: 'My hub'
|
example: "My hub"
|
||||||
pairing_mode:
|
pairing_mode:
|
||||||
description: One of ["zigbee", "zwave", "zwave_exclusion", "zwave_network_rediscovery", "lutron", "bluetooth", "kidde"].
|
description: One of ["zigbee", "zwave", "zwave_exclusion", "zwave_network_rediscovery", "lutron", "bluetooth", "kidde"].
|
||||||
example: 'zigbee'
|
example: "zigbee"
|
||||||
kidde_radio_code:
|
kidde_radio_code:
|
||||||
description: 'A string of 8 1s and 0s one for each dip switch on the kidde device left --> right = 1 --> 8. Down = 1 and Up = 0'
|
description: "A string of 8 1s and 0s one for each dip switch on the kidde device left --> right = 1 --> 8. Down = 1 and Up = 0"
|
||||||
example: '10101010'
|
example: "10101010"
|
||||||
|
|
||||||
rename_wink_device:
|
rename_wink_device:
|
||||||
description: Rename the provided device.
|
description: Rename the provided device.
|
||||||
|
@ -40,47 +39,55 @@ set_siren_volume:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
volume:
|
volume:
|
||||||
description: Volume level. One of ["low", "medium", "high"].
|
description: Volume level. One of ["low", "medium", "high"].
|
||||||
example: "high"
|
example: "high"
|
||||||
|
|
||||||
enable_chime:
|
enable_chime:
|
||||||
description: Enable the chime of a Dome siren with the provided sound.
|
description: Enable the chime of a Dome siren with the provided sound.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
tone:
|
tone:
|
||||||
description: The tone to use for the chime. One of ["doorbell", "fur_elise", "doorbell_extended", "alert", "william_tell", "rondo_alla_turca", "police_siren", "evacuation", "beep_beep", "beep", "inactive"]
|
description: >-
|
||||||
example: "doorbell"
|
The tone to use for the chime. One of ["doorbell", "fur_elise",
|
||||||
|
"doorbell_extended", "alert", "william_tell", "rondo_alla_turca",
|
||||||
|
"police_siren", "evacuation", "beep_beep", "beep", "inactive"]
|
||||||
|
example: "doorbell"
|
||||||
|
|
||||||
set_siren_tone:
|
set_siren_tone:
|
||||||
description: Set the sound to use when the siren is enabled. (This doesn't enable the siren)
|
description: Set the sound to use when the siren is enabled. (This doesn't enable the siren)
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
tone:
|
tone:
|
||||||
description: The tone to use for the chime. One of ["doorbell", "fur_elise", "doorbell_extended", "alert", "william_tell", "rondo_alla_turca", "police_siren", "evacuation", "beep_beep", "beep", "inactive"]
|
description: >-
|
||||||
example: "alert"
|
The tone to use for the chime. One of ["doorbell", "fur_elise",
|
||||||
|
"doorbell_extended", "alert", "william_tell", "rondo_alla_turca",
|
||||||
|
"police_siren", "evacuation", "beep_beep", "beep", "inactive"]
|
||||||
|
example: "alert"
|
||||||
|
|
||||||
siren_set_auto_shutoff:
|
siren_set_auto_shutoff:
|
||||||
description: How long to sound the siren before turning off.
|
description: How long to sound the siren before turning off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
auto_shutoff:
|
auto_shutoff:
|
||||||
description: The time in seconds to sound the siren. One of [None, -1, 30, 60, 120] (None and -1 are forever. Use None for gocontrol, and -1 for Dome)
|
description: >-
|
||||||
example: 60
|
The time in seconds to sound the siren. One of [None, -1, 30, 60, 120]
|
||||||
|
(None and -1 are forever. Use None for gocontrol, and -1 for Dome)
|
||||||
|
example: 60
|
||||||
|
|
||||||
set_siren_strobe_enabled:
|
set_siren_strobe_enabled:
|
||||||
description: Enable or disable the strobe light when the siren is sounding.
|
description: Enable or disable the strobe light when the siren is sounding.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
enabled:
|
enabled:
|
||||||
description: "True or False"
|
description: "True or False"
|
||||||
|
|
||||||
|
@ -89,38 +96,38 @@ set_chime_strobe_enabled:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
enabled:
|
enabled:
|
||||||
description: "True or False"
|
description: "True or False"
|
||||||
|
|
||||||
enable_siren:
|
enable_siren:
|
||||||
description: Enable/disable the siren.
|
description: Enable/disable the siren.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set
|
description: Name(s) of the entities to set
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
enabled:
|
enabled:
|
||||||
description: "True or False"
|
description: "true or false"
|
||||||
|
|
||||||
set_chime_volume:
|
set_chime_volume:
|
||||||
description: Set the volume of the chime for a Dome siren/chime.
|
description: Set the volume of the chime for a Dome siren/chime.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of the entities to set.
|
description: Name(s) of the entities to set.
|
||||||
example: 'switch.dome_siren'
|
example: "switch.dome_siren"
|
||||||
volume:
|
volume:
|
||||||
description: Volume level. One of ["low", "medium", "high"]
|
description: Volume level. One of ["low", "medium", "high"]
|
||||||
example: "low"
|
example: "low"
|
||||||
|
|
||||||
set_nimbus_dial_configuration:
|
set_nimbus_dial_configuration:
|
||||||
description: Set the configuration of an individual nimbus dial
|
description: Set the configuration of an individual nimbus dial
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the entity to set.
|
description: Name of the entity to set.
|
||||||
example: 'wink.nimbus_dial_3'
|
example: "wink.nimbus_dial_3"
|
||||||
rotation:
|
rotation:
|
||||||
description: Direction dial hand should spin ["cw" or "ccw"]
|
description: Direction dial hand should spin ["cw" or "ccw"]
|
||||||
example: 'cw'
|
example: "cw"
|
||||||
ticks:
|
ticks:
|
||||||
description: Number of times the hand should move
|
description: Number of times the hand should move
|
||||||
example: 12
|
example: 12
|
||||||
|
@ -145,12 +152,15 @@ set_nimbus_dial_state:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the entity to set.
|
description: Name of the entity to set.
|
||||||
example: 'wink.nimbus_dial_3'
|
example: "wink.nimbus_dial_3"
|
||||||
value:
|
value:
|
||||||
description: The value that should be set (Should be between min_value and max_value)
|
description: The value that should be set (Should be between min_value and max_value)
|
||||||
example: 250
|
example: 250
|
||||||
labels:
|
labels:
|
||||||
description: The values shown on the dial labels ["Dial 1", "test"] the first value is what is shown by default the second value is shown when the nimbus is pressed
|
description: >-
|
||||||
|
The values shown on the dial labels ["Dial 1", "test"] the first value
|
||||||
|
is what is shown by default the second value is shown when the nimbus is
|
||||||
|
pressed.
|
||||||
example: ["example", "test"]
|
example: ["example", "test"]
|
||||||
|
|
||||||
set_lock_vacation_mode:
|
set_lock_vacation_mode:
|
||||||
|
@ -158,7 +168,7 @@ set_lock_vacation_mode:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
enabled:
|
enabled:
|
||||||
description: enable or disable. true or false.
|
description: enable or disable. true or false.
|
||||||
example: true
|
example: true
|
||||||
|
@ -168,7 +178,7 @@ set_lock_alarm_mode:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
mode:
|
mode:
|
||||||
description: One of tamper, activity, or forced_entry.
|
description: One of tamper, activity, or forced_entry.
|
||||||
example: tamper
|
example: tamper
|
||||||
|
@ -178,7 +188,7 @@ set_lock_alarm_sensitivity:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
sensitivity:
|
sensitivity:
|
||||||
description: One of low, medium_low, medium, medium_high, high.
|
description: One of low, medium_low, medium, medium_high, high.
|
||||||
example: medium
|
example: medium
|
||||||
|
@ -188,7 +198,7 @@ set_lock_alarm_state:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
enabled:
|
enabled:
|
||||||
description: enable or disable. true or false.
|
description: enable or disable. true or false.
|
||||||
example: true
|
example: true
|
||||||
|
@ -198,7 +208,7 @@ set_lock_beeper_state:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
enabled:
|
enabled:
|
||||||
description: enable or disable. true or false.
|
description: enable or disable. true or false.
|
||||||
example: true
|
example: true
|
||||||
|
@ -208,10 +218,10 @@ add_new_lock_key_code:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of lock to unlock.
|
description: Name of lock to unlock.
|
||||||
example: 'lock.front_door'
|
example: "lock.front_door"
|
||||||
name:
|
name:
|
||||||
description: name of the new key code.
|
description: name of the new key code.
|
||||||
example: Bob
|
example: Bob
|
||||||
code:
|
code:
|
||||||
description: new key code, length must match length of other codes. Default length is 4.
|
description: new key code, length must match length of other codes. Default length is 4.
|
||||||
example: 1234
|
example: 1234
|
||||||
|
|
|
@ -3,49 +3,49 @@ fan_set_buzzer_on:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_buzzer_off:
|
fan_set_buzzer_off:
|
||||||
description: Turn the buzzer off.
|
description: Turn the buzzer off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_led_on:
|
fan_set_led_on:
|
||||||
description: Turn the led on.
|
description: Turn the led on.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_led_off:
|
fan_set_led_off:
|
||||||
description: Turn the led off.
|
description: Turn the led off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_child_lock_on:
|
fan_set_child_lock_on:
|
||||||
description: Turn the child lock on.
|
description: Turn the child lock on.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_child_lock_off:
|
fan_set_child_lock_off:
|
||||||
description: Turn the child lock off.
|
description: Turn the child lock off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_favorite_level:
|
fan_set_favorite_level:
|
||||||
description: Set the favorite level.
|
description: Set the favorite level.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
level:
|
level:
|
||||||
description: Level, between 0 and 16.
|
description: Level, between 0 and 16.
|
||||||
example: 1
|
example: 1
|
||||||
|
@ -55,7 +55,7 @@ fan_set_fan_level:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
level:
|
level:
|
||||||
description: Level, between 1 and 3.
|
description: Level, between 1 and 3.
|
||||||
example: 1
|
example: 1
|
||||||
|
@ -65,7 +65,7 @@ fan_set_led_brightness:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
brightness:
|
brightness:
|
||||||
description: Brightness (0 = Bright, 1 = Dim, 2 = Off)
|
description: Brightness (0 = Bright, 1 = Dim, 2 = Off)
|
||||||
example: 1
|
example: 1
|
||||||
|
@ -75,35 +75,35 @@ fan_set_auto_detect_on:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_auto_detect_off:
|
fan_set_auto_detect_off:
|
||||||
description: Turn the auto detect off.
|
description: Turn the auto detect off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_learn_mode_on:
|
fan_set_learn_mode_on:
|
||||||
description: Turn the learn mode on.
|
description: Turn the learn mode on.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_learn_mode_off:
|
fan_set_learn_mode_off:
|
||||||
description: Turn the learn mode off.
|
description: Turn the learn mode off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_volume:
|
fan_set_volume:
|
||||||
description: Set the sound volume.
|
description: Set the sound volume.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
volume:
|
volume:
|
||||||
description: Volume, between 0 and 100.
|
description: Volume, between 0 and 100.
|
||||||
example: 50
|
example: 50
|
||||||
|
@ -113,14 +113,14 @@ fan_reset_filter:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_extra_features:
|
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.
|
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:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
features:
|
features:
|
||||||
description: Integer, known values are 0 (default) and 1 (turbo mode).
|
description: Integer, known values are 0 (default) and 1 (turbo mode).
|
||||||
example: 1
|
example: 1
|
||||||
|
@ -130,7 +130,7 @@ fan_set_target_humidity:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
humidity:
|
humidity:
|
||||||
description: Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80.
|
description: Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80.
|
||||||
example: 50
|
example: 50
|
||||||
|
@ -140,14 +140,14 @@ fan_set_dry_on:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
fan_set_dry_off:
|
fan_set_dry_off:
|
||||||
description: Turn the dry mode off.
|
description: Turn the dry mode off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'fan.xiaomi_miio_device'
|
example: "fan.xiaomi_miio_device"
|
||||||
|
|
||||||
light_set_scene:
|
light_set_scene:
|
||||||
description: Set a fixed scene.
|
description: Set a fixed scene.
|
||||||
|
@ -173,77 +173,77 @@ light_reminder_on:
|
||||||
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
light_reminder_off:
|
light_reminder_off:
|
||||||
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
light_night_light_mode_on:
|
light_night_light_mode_on:
|
||||||
description: Turn the eyecare mode on (EYECARE SMART LAMP 2 ONLY).
|
description: Turn the eyecare mode on (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
light_night_light_mode_off:
|
light_night_light_mode_off:
|
||||||
description: Turn the eyecare mode fan_set_dry_off (EYECARE SMART LAMP 2 ONLY).
|
description: Turn the eyecare mode fan_set_dry_off (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
light_eyecare_mode_on:
|
light_eyecare_mode_on:
|
||||||
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
description: Enable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
light_eyecare_mode_off:
|
light_eyecare_mode_off:
|
||||||
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
description: Disable the eye fatigue reminder/notification (EYECARE SMART LAMP 2 ONLY).
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to act on.'
|
description: "Name of the entity to act on."
|
||||||
example: 'light.xiaomi_miio'
|
example: "light.xiaomi_miio"
|
||||||
|
|
||||||
remote_learn_command:
|
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.'
|
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.'
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: 'Name of the entity to learn command from.'
|
description: "Name of the entity to learn command from."
|
||||||
example: 'remote.xiaomi_miio'
|
example: "remote.xiaomi_miio"
|
||||||
slot:
|
slot:
|
||||||
description: 'Define the slot used to save the IR command (Value from 1 to 1000000)'
|
description: "Define the slot used to save the IR command (Value from 1 to 1000000)"
|
||||||
example: '1'
|
example: "1"
|
||||||
timeout:
|
timeout:
|
||||||
description: 'Define the timeout in seconds, before which the command must be learned.'
|
description: "Define the timeout in seconds, before which the command must be learned."
|
||||||
example: '30'
|
example: "30"
|
||||||
|
|
||||||
switch_set_wifi_led_on:
|
switch_set_wifi_led_on:
|
||||||
description: Turn the wifi led on.
|
description: Turn the wifi led on.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'switch.xiaomi_miio_device'
|
example: "switch.xiaomi_miio_device"
|
||||||
|
|
||||||
switch_set_wifi_led_off:
|
switch_set_wifi_led_off:
|
||||||
description: Turn the wifi led off.
|
description: Turn the wifi led off.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'switch.xiaomi_miio_device'
|
example: "switch.xiaomi_miio_device"
|
||||||
|
|
||||||
switch_set_power_price:
|
switch_set_power_price:
|
||||||
description: Set the power price.
|
description: Set the power price.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'switch.xiaomi_miio_device'
|
example: "switch.xiaomi_miio_device"
|
||||||
mode:
|
mode:
|
||||||
description: Power price, between 0 and 999.
|
description: Power price, between 0 and 999.
|
||||||
example: 31
|
example: 31
|
||||||
|
@ -253,66 +253,66 @@ switch_set_power_mode:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the xiaomi miio entity.
|
description: Name of the xiaomi miio entity.
|
||||||
example: 'switch.xiaomi_miio_device'
|
example: "switch.xiaomi_miio_device"
|
||||||
mode:
|
mode:
|
||||||
description: Power mode, valid values are 'normal' and 'green'.
|
description: Power mode, valid values are 'normal' and 'green'.
|
||||||
example: 'green'
|
example: "green"
|
||||||
|
|
||||||
vacuum_remote_control_start:
|
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`.
|
description: Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity.
|
description: Name of the vacuum entity.
|
||||||
example: 'vacuum.xiaomi_vacuum_cleaner'
|
example: "vacuum.xiaomi_vacuum_cleaner"
|
||||||
|
|
||||||
vacuum_remote_control_stop:
|
vacuum_remote_control_stop:
|
||||||
description: Stop remote control mode of the vacuum cleaner.
|
description: Stop remote control mode of the vacuum cleaner.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity.
|
description: Name of the vacuum entity.
|
||||||
example: 'vacuum.xiaomi_vacuum_cleaner'
|
example: "vacuum.xiaomi_vacuum_cleaner"
|
||||||
|
|
||||||
vacuum_remote_control_move:
|
vacuum_remote_control_move:
|
||||||
description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.
|
description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity.
|
description: Name of the vacuum entity.
|
||||||
example: 'vacuum.xiaomi_vacuum_cleaner'
|
example: "vacuum.xiaomi_vacuum_cleaner"
|
||||||
velocity:
|
velocity:
|
||||||
description: Speed, between -0.29 and 0.29.
|
description: Speed, between -0.29 and 0.29.
|
||||||
example: '0.2'
|
example: "0.2"
|
||||||
rotation:
|
rotation:
|
||||||
description: Rotation, between -179 degrees and 179 degrees.
|
description: Rotation, between -179 degrees and 179 degrees.
|
||||||
example: '90'
|
example: "90"
|
||||||
duration:
|
duration:
|
||||||
description: Duration of the movement.
|
description: Duration of the movement.
|
||||||
example: '1500'
|
example: "1500"
|
||||||
|
|
||||||
vacuum_remote_control_move_step:
|
vacuum_remote_control_move_step:
|
||||||
description: Remote control the vacuum cleaner, only makes one move and then stops.
|
description: Remote control the vacuum cleaner, only makes one move and then stops.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity.
|
description: Name of the vacuum entity.
|
||||||
example: 'vacuum.xiaomi_vacuum_cleaner'
|
example: "vacuum.xiaomi_vacuum_cleaner"
|
||||||
velocity:
|
velocity:
|
||||||
description: Speed, between -0.29 and 0.29.
|
description: Speed, between -0.29 and 0.29.
|
||||||
example: '0.2'
|
example: "0.2"
|
||||||
rotation:
|
rotation:
|
||||||
description: Rotation, between -179 degrees and 179 degrees.
|
description: Rotation, between -179 degrees and 179 degrees.
|
||||||
example: '90'
|
example: "90"
|
||||||
duration:
|
duration:
|
||||||
description: Duration of the movement.
|
description: Duration of the movement.
|
||||||
example: '1500'
|
example: "1500"
|
||||||
|
|
||||||
vacuum_clean_zone:
|
vacuum_clean_zone:
|
||||||
description: Start the cleaning operation in the selected areas for the number of repeats indicated.
|
description: Start the cleaning operation in the selected areas for the number of repeats indicated.
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the vacuum entity.
|
description: Name of the vacuum entity.
|
||||||
example: 'vacuum.xiaomi_vacuum_cleaner'
|
example: "vacuum.xiaomi_vacuum_cleaner"
|
||||||
zone:
|
zone:
|
||||||
description: Array of zones. Each zone is an array of 4 integer values.
|
description: Array of zones. Each zone is an array of 4 integer values.
|
||||||
example: '[[23510,25311,25110,26362]]'
|
example: "[[23510,25311,25110,26362]]"
|
||||||
repeats:
|
repeats:
|
||||||
description: Number of cleaning repeats for each zone between 1 and 3.
|
description: Number of cleaning repeats for each zone between 1 and 3.
|
||||||
example: '1'
|
example: "1"
|
||||||
|
|
|
@ -3,10 +3,10 @@ enable_output:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name(s) of entities to enable/disable port on.
|
description: Name(s) of entities to enable/disable port on.
|
||||||
example: 'media_player.yamaha'
|
example: "media_player.yamaha"
|
||||||
port:
|
port:
|
||||||
description: Name of port to enable/disable.
|
description: Name of port to enable/disable.
|
||||||
example: 'hdmi1'
|
example: "hdmi1"
|
||||||
enabled:
|
enabled:
|
||||||
description: Boolean indicating if port should be enabled or not.
|
description: Boolean indicating if port should be enabled or not.
|
||||||
example: true
|
example: true
|
||||||
|
|
|
@ -3,4 +3,4 @@ set_run_state:
|
||||||
fields:
|
fields:
|
||||||
name:
|
name:
|
||||||
description: The string name of the ZoneMinder run state to set as active.
|
description: The string name of the ZoneMinder run state to set as active.
|
||||||
example: 'Home'
|
example: "Home"
|
||||||
|
|
|
@ -31,14 +31,14 @@ heal_network:
|
||||||
fields:
|
fields:
|
||||||
return_routes:
|
return_routes:
|
||||||
description: Whether or not to update the return routes from the nodes to the controller. Defaults to False.
|
description: Whether or not to update the return routes from the nodes to the controller. Defaults to False.
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
heal_node:
|
heal_node:
|
||||||
description: Start a Z-Wave node heal. Refer to OZW_Log.txt for progress.
|
description: Start a Z-Wave node heal. Refer to OZW_Log.txt for progress.
|
||||||
fields:
|
fields:
|
||||||
return_routes:
|
return_routes:
|
||||||
description: Whether or not to update the return routes from the node to the controller. Defaults to False.
|
description: Whether or not to update the return routes from the node to the controller. Defaults to False.
|
||||||
example: True
|
example: true
|
||||||
|
|
||||||
remove_node:
|
remove_node:
|
||||||
description: Remove a node from the Z-Wave network. Refer to OZW_Log.txt for progress.
|
description: Remove a node from the Z-Wave network. Refer to OZW_Log.txt for progress.
|
||||||
|
@ -100,7 +100,6 @@ set_poll_intensity:
|
||||||
description: The intensity to poll, 0 = disabled, 1 = Every time through list, 2 = Every second time through list...
|
description: The intensity to poll, 0 = disabled, 1 = Every time through list, 2 = Every second time through list...
|
||||||
example: 2
|
example: 2
|
||||||
|
|
||||||
|
|
||||||
print_config_parameter:
|
print_config_parameter:
|
||||||
description: Prints a Z-Wave node config parameter value to log.
|
description: Prints a Z-Wave node config parameter value to log.
|
||||||
fields:
|
fields:
|
||||||
|
@ -120,7 +119,7 @@ refresh_entity:
|
||||||
fields:
|
fields:
|
||||||
entity_id:
|
entity_id:
|
||||||
description: Name of the entity to refresh.
|
description: Name of the entity to refresh.
|
||||||
example: 'light.leviton_vrmx11lz_multilevel_scene_switch_level_40'
|
example: "light.leviton_vrmx11lz_multilevel_scene_switch_level_40"
|
||||||
|
|
||||||
refresh_node:
|
refresh_node:
|
||||||
description: Refresh zwave node.
|
description: Refresh zwave node.
|
||||||
|
@ -153,7 +152,7 @@ test_node:
|
||||||
description: This will send test messages to a node in the Z-Wave network. This could bring back dead nodes.
|
description: This will send test messages to a node in the Z-Wave network. This could bring back dead nodes.
|
||||||
fields:
|
fields:
|
||||||
node_id:
|
node_id:
|
||||||
description: ID of the node to send test messages to.
|
description: ID of the node to send test messages to.
|
||||||
example: 10
|
example: 10
|
||||||
messages:
|
messages:
|
||||||
description: Optional. Amount of test messages to send.
|
description: Optional. Amount of test messages to send.
|
||||||
|
@ -167,10 +166,10 @@ rename_node:
|
||||||
example: 10
|
example: 10
|
||||||
update_ids:
|
update_ids:
|
||||||
description: (optional) Rename the entity IDs for entities of this node.
|
description: (optional) Rename the entity IDs for entities of this node.
|
||||||
example: True
|
example: true
|
||||||
name:
|
name:
|
||||||
description: New Name
|
description: New Name
|
||||||
example: 'kitchen'
|
example: "kitchen"
|
||||||
|
|
||||||
rename_value:
|
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}
|
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}
|
||||||
|
@ -183,10 +182,10 @@ rename_value:
|
||||||
example: 72037594255792737
|
example: 72037594255792737
|
||||||
update_ids:
|
update_ids:
|
||||||
description: (optional) Update the entity ID for this value's entity.
|
description: (optional) Update the entity ID for this value's entity.
|
||||||
example: True
|
example: true
|
||||||
name:
|
name:
|
||||||
description: New Name
|
description: New Name
|
||||||
example: 'Luminosity'
|
example: "Luminosity"
|
||||||
|
|
||||||
reset_node_meters:
|
reset_node_meters:
|
||||||
description: Resets the meter counters of a node.
|
description: Resets the meter counters of a node.
|
||||||
|
|
|
@ -2,8 +2,9 @@
|
||||||
|
|
||||||
bandit==1.6.2
|
bandit==1.6.2
|
||||||
black==19.10b0
|
black==19.10b0
|
||||||
codespell==v1.16.0
|
codespell==1.16.0
|
||||||
flake8-docstrings==1.5.0
|
flake8-docstrings==1.5.0
|
||||||
flake8==3.7.9
|
flake8==3.7.9
|
||||||
isort==v4.3.21
|
isort==4.3.21
|
||||||
pydocstyle==5.0.2
|
pydocstyle==5.0.2
|
||||||
|
yamllint==1.21.0
|
||||||
|
|
|
@ -262,7 +262,7 @@ def requirements_pre_commit_output():
|
||||||
for repo in (x for x in pre_commit_conf["repos"] if x.get("rev")):
|
for repo in (x for x in pre_commit_conf["repos"] if x.get("rev")):
|
||||||
for hook in repo["hooks"]:
|
for hook in repo["hooks"]:
|
||||||
if hook["id"] not in IGNORE_PRE_COMMIT_HOOK_ID:
|
if hook["id"] not in IGNORE_PRE_COMMIT_HOOK_ID:
|
||||||
reqs.append(f"{hook['id']}=={repo['rev']}")
|
reqs.append(f"{hook['id']}=={repo['rev'].lstrip('v')}")
|
||||||
reqs.extend(x for x in hook.get("additional_dependencies", ()))
|
reqs.extend(x for x in hook.get("additional_dependencies", ()))
|
||||||
output = [
|
output = [
|
||||||
f"# Automatically generated "
|
f"# Automatically generated "
|
||||||
|
|
Loading…
Reference in a new issue