Last active
November 22, 2020 20:03
-
-
Save tjunussov/64bfc898da75dbcbbf82654b2b56f29b to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #hass runtime | |
| vi /var/run/s6/services/home-assistant/run | |
| exec python3 -m homeassistant --config /config --verbose --debug --log-rotate-days 1 --log-file /var/log/homeassistant.log | |
| hass -h | |
| usage: hass [-h] [--version] [-c path_to_config_dir] [--demo-mode] [--debug] | |
| [--open-ui] [--skip-pip] [-v] [--pid-file path_to_pid_file] | |
| [--log-rotate-days LOG_ROTATE_DAYS] [--log-file LOG_FILE] | |
| [--log-no-color] [--runner] [--script ...] [--daemon] | |
| cd /usr/local/lib/python3.7/site-packages/ | |
| # file decsriptors vs process names | |
| lsof -Fpcn | nawk ' | |
| /^p/ { pid=substr($0,2) } | |
| /^c/ { cmd=substr($0,2) } | |
| /^n/ { fd[cmd"["pid"]"]++ } | |
| END { for (cc in fd) printf("%-20s %i\n",cc,fd[cc]) } ' | sort -n -k 2 | |
| Network Hassio Host IP address - 172.30.32.1 | |
| nmap -sU -Pn 192.168.0.108 -p 9898,4321 | |
| [ | |
| { | |
| "domain": "homeassistant", | |
| "services": { | |
| "check_config": { | |
| "description": "Check the Home Assistant configuration files for errors. Errors will be displayed in the Home Assistant log.", | |
| "fields": {} | |
| }, | |
| "reload_core_config": { | |
| "description": "Reload the core configuration.", | |
| "fields": {} | |
| }, | |
| "restart": { | |
| "description": "Restart the Home Assistant service.", | |
| "fields": {} | |
| }, | |
| "set_location": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "stop": { | |
| "description": "Stop the Home Assistant service.", | |
| "fields": {} | |
| }, | |
| "toggle": { | |
| "description": "Generic service to toggle devices on/off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "The entity_id of the device to toggle on/off.", | |
| "example": "light.living_room" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Generic service to turn devices off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "The entity_id of the device to turn off.", | |
| "example": "light.living_room" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Generic service to turn devices on under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "The entity_id of the device to turn on.", | |
| "example": "light.living_room" | |
| } | |
| } | |
| }, | |
| "update_entity": { | |
| "description": "Force one or more entities to update its data", | |
| "fields": { | |
| "entity_id": { | |
| "description": "One or multiple entity_ids to update. Can be a list.", | |
| "example": "light.living_room" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "persistent_notification", | |
| "services": { | |
| "create": { | |
| "description": "Show a notification in the frontend.", | |
| "fields": { | |
| "message": { | |
| "description": "Message body of the notification. [Templates accepted]", | |
| "example": "Please check your configuration.yaml." | |
| }, | |
| "notification_id": { | |
| "description": "Target ID of the notification, will replace a notification with the same Id. [Optional]", | |
| "example": 1234 | |
| }, | |
| "title": { | |
| "description": "Optional title for your notification. [Optional, Templates accepted]", | |
| "example": "Test notification" | |
| } | |
| } | |
| }, | |
| "dismiss": { | |
| "description": "Remove a notification from the frontend.", | |
| "fields": { | |
| "notification_id": { | |
| "description": "Target ID of the notification, which should be removed. [Required]", | |
| "example": 1234 | |
| } | |
| } | |
| }, | |
| "mark_read": { | |
| "description": "Mark a notification read.", | |
| "fields": { | |
| "notification_id": { | |
| "description": "Target ID of the notification, which should be mark read. [Required]", | |
| "example": 1234 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "system_log", | |
| "services": { | |
| "clear": { | |
| "description": "Clear all log entries.", | |
| "fields": {} | |
| }, | |
| "write": { | |
| "description": "Write log entry.", | |
| "fields": { | |
| "level": { | |
| "description": "Log level: debug, info, warning, error, critical. Defaults to 'error'.", | |
| "example": "debug" | |
| }, | |
| "logger": { | |
| "description": "Logger name under which to log the message. Defaults to 'system_log.external'.", | |
| "example": "mycomponent.myplatform" | |
| }, | |
| "message": { | |
| "description": "Message to log. [Required]", | |
| "example": "Something went wrong" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "recorder", | |
| "services": { | |
| "purge": { | |
| "description": "Start purge task - delete events and states older than x days, according to keep_days service data.", | |
| "fields": { | |
| "keep_days": { | |
| "description": "Number of history days to keep in database after purge. Value >= 0.", | |
| "example": 2 | |
| }, | |
| "repack": { | |
| "description": "Attempt to save disk space by rewriting the entire database file.", | |
| "example": true | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "input_boolean", | |
| "services": { | |
| "toggle": { | |
| "description": "Toggles an input boolean.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Entity id of the input boolean to toggle.", | |
| "example": "input_boolean.notify_alerts" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turns off an input boolean", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Entity id of the input boolean to turn off.", | |
| "example": "input_boolean.notify_alerts" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turns on an input boolean.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Entity id of the input boolean to turn on.", | |
| "example": "input_boolean.notify_alerts" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "google_assistant", | |
| "services": { | |
| "request_sync": { | |
| "description": "Send a request_sync command to Google.", | |
| "fields": { | |
| "agent_user_id": { | |
| "description": "Optional. Only needed for automations. Specific Home Assistant user id (not username, ID in configuration > users > under username) to sync with Google Assistant. Do not need when you call this service through Home Assistant front end or API. Used in automation script or other place where context.user_id is missing." | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "mqtt", | |
| "services": { | |
| "publish": { | |
| "description": "Publish a message to an MQTT topic.", | |
| "fields": { | |
| "payload": { | |
| "description": "Payload to publish.", | |
| "example": "This is great" | |
| }, | |
| "payload_template": { | |
| "description": "Template to render as payload value. Ignored if payload given.", | |
| "example": "{{ states('sensor.temperature') }}" | |
| }, | |
| "qos": { | |
| "default": 0, | |
| "description": "Quality of Service to use.", | |
| "example": 2, | |
| "values": [ | |
| 0, | |
| 1, | |
| 2 | |
| ] | |
| }, | |
| "retain": { | |
| "default": false, | |
| "description": "If message should have the retain flag set.", | |
| "example": true | |
| }, | |
| "topic": { | |
| "description": "Topic to publish payload.", | |
| "example": "/homeassistant/hello" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "media_player", | |
| "services": { | |
| "clear_playlist": { | |
| "description": "Send the media player the command to clear players playlist.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to change source on.", | |
| "example": "media_player.living_room_chromecast" | |
| } | |
| } | |
| }, | |
| "media_next_track": { | |
| "description": "Send the media player the command for next track.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to send next track command to.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "media_pause": { | |
| "description": "Send the media player the command for pause.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to pause on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "media_play": { | |
| "description": "Send the media player the command for play.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to play on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "media_play_pause": { | |
| "description": "Toggle media player play/pause state.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to toggle play/pause state on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "media_previous_track": { | |
| "description": "Send the media player the command for previous track.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to send previous track command to.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "media_seek": { | |
| "description": "Send the media player the command to seek in current playing media.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to seek media on.", | |
| "example": "media_player.living_room_chromecast" | |
| }, | |
| "seek_position": { | |
| "description": "Position to seek to. The format is platform dependent.", | |
| "example": 100 | |
| } | |
| } | |
| }, | |
| "media_stop": { | |
| "description": "Send the media player the stop command.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to stop on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "play_media": { | |
| "description": "Send the media player the command for playing media.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to seek media on", | |
| "example": "media_player.living_room_chromecast" | |
| }, | |
| "media_content_id": { | |
| "description": "The ID of the content to play. Platform dependent.", | |
| "example": "https://home-assistant.io/images/cast/splash.png" | |
| }, | |
| "media_content_type": { | |
| "description": "The type of the content to play. Must be one of image, music, tvshow, video, episode, channel or playlist", | |
| "example": "music" | |
| } | |
| } | |
| }, | |
| "select_sound_mode": { | |
| "description": "Send the media player the command to change sound mode.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to change sound mode on.", | |
| "example": "media_player.marantz" | |
| }, | |
| "sound_mode": { | |
| "description": "Name of the sound mode to switch to.", | |
| "example": "Music" | |
| } | |
| } | |
| }, | |
| "select_source": { | |
| "description": "Send the media player the command to change input source.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to change source on.", | |
| "example": "media_player.media_player.txnr535_0009b0d81f82" | |
| }, | |
| "source": { | |
| "description": "Name of the source to switch to. Platform dependent.", | |
| "example": "video1" | |
| } | |
| } | |
| }, | |
| "shuffle_set": { | |
| "description": "Set shuffling state.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to set.", | |
| "example": "media_player.spotify" | |
| }, | |
| "shuffle": { | |
| "description": "True/false for enabling/disabling shuffle.", | |
| "example": true | |
| } | |
| } | |
| }, | |
| "toggle": { | |
| "description": "Toggles a media player power state.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to toggle.", | |
| "example": "media_player.living_room_chromecast" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turn a media player power off.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn off.", | |
| "example": "media_player.living_room_chromecast" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turn a media player power on.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn on.", | |
| "example": "media_player.living_room_chromecast" | |
| } | |
| } | |
| }, | |
| "volume_down": { | |
| "description": "Turn a media player volume down.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn volume down on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| }, | |
| "volume_mute": { | |
| "description": "Mute a media player's volume.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to mute.", | |
| "example": "media_player.living_room_sonos" | |
| }, | |
| "is_volume_muted": { | |
| "description": "True/false for mute/unmute.", | |
| "example": true | |
| } | |
| } | |
| }, | |
| "volume_set": { | |
| "description": "Set a media player's volume level.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to set volume level on.", | |
| "example": "media_player.living_room_sonos" | |
| }, | |
| "volume_level": { | |
| "description": "Volume level to set as float.", | |
| "example": 0.6 | |
| } | |
| } | |
| }, | |
| "volume_up": { | |
| "description": "Turn a media player volume up.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn volume up on.", | |
| "example": "media_player.living_room_sonos" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "xiaomi_aqara", | |
| "services": { | |
| "add_device": { | |
| "description": "Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.", | |
| "fields": { | |
| "gw_mac": { | |
| "description": "MAC address of the Xiaomi Aqara Gateway.", | |
| "example": "34ce00880088" | |
| } | |
| } | |
| }, | |
| "play_ringtone": { | |
| "description": "Play a specific ringtone. The version of the gateway firmware must be 1.4.1_145 at least.", | |
| "fields": { | |
| "gw_mac": { | |
| "description": "MAC address of the Xiaomi Aqara Gateway.", | |
| "example": "34ce00880088" | |
| }, | |
| "ringtone_id": { | |
| "description": "One of the allowed ringtone ids.", | |
| "example": 8 | |
| }, | |
| "ringtone_vol": { | |
| "description": "The volume in percent.", | |
| "example": 30 | |
| } | |
| } | |
| }, | |
| "remove_device": { | |
| "description": "Removes a specific device. The removal is required if a device shall be paired with another gateway.", | |
| "fields": { | |
| "device_id": { | |
| "description": "Hardware address of the device to remove.", | |
| "example": "158d0000000000" | |
| }, | |
| "gw_mac": { | |
| "description": "MAC address of the Xiaomi Aqara Gateway.", | |
| "example": "34ce00880088" | |
| } | |
| } | |
| }, | |
| "stop_ringtone": { | |
| "description": "Stops a playing ringtone immediately.", | |
| "fields": { | |
| "gw_mac": { | |
| "description": "MAC address of the Xiaomi Aqara Gateway.", | |
| "example": "34ce00880088" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "tts", | |
| "services": { | |
| "clear_cache": { | |
| "description": "Remove cache files and RAM cache.", | |
| "fields": {} | |
| }, | |
| "google_translate_say": { | |
| "description": "", | |
| "fields": {} | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "frontend", | |
| "services": { | |
| "reload_themes": { | |
| "description": "Reload themes from yaml configuration.", | |
| "fields": {} | |
| }, | |
| "set_theme": { | |
| "description": "Set a theme unless the client selected per-device theme.", | |
| "fields": { | |
| "name": { | |
| "description": "Name of a predefined theme or 'default'.", | |
| "example": "light" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "logbook", | |
| "services": { | |
| "log": { | |
| "description": "", | |
| "fields": {} | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "notify", | |
| "services": { | |
| "notify": { | |
| "description": "Send a notification.", | |
| "fields": { | |
| "data": { | |
| "description": "Extended information for notification. Optional depending on the platform.", | |
| "example": "platform specific" | |
| }, | |
| "message": { | |
| "description": "Message body of the notification.", | |
| "example": "The garage door has been open for 10 minutes." | |
| }, | |
| "target": { | |
| "description": "An array of targets to send the notification to. Optional depending on the platform.", | |
| "example": "platform specific" | |
| }, | |
| "title": { | |
| "description": "Optional title for your notification.", | |
| "example": "Your Garage Door Friend" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "cloud", | |
| "services": { | |
| "remote_connect": { | |
| "description": "Make instance UI available outside over NabuCasa cloud.", | |
| "fields": {} | |
| }, | |
| "remote_disconnect": { | |
| "description": "Disconnect UI from NabuCasa cloud.", | |
| "fields": {} | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "group", | |
| "services": { | |
| "reload": { | |
| "description": "Reload group configuration.", | |
| "fields": {} | |
| }, | |
| "remove": { | |
| "description": "Remove a user group.", | |
| "fields": { | |
| "object_id": { | |
| "description": "Group id and part of entity id.", | |
| "example": "test_group" | |
| } | |
| } | |
| }, | |
| "set": { | |
| "description": "Create/Update a user group.", | |
| "fields": { | |
| "add_entities": { | |
| "description": "List of members they will change on group listening.", | |
| "example": "domain.entity_id1, domain.entity_id2" | |
| }, | |
| "all": { | |
| "description": "Enable this option if the group should only turn on when all entities are on.", | |
| "example": true | |
| }, | |
| "control": { | |
| "description": "Value for control the group control.", | |
| "example": "hidden" | |
| }, | |
| "entities": { | |
| "description": "List of all members in the group. Not compatible with 'delta'.", | |
| "example": "domain.entity_id1, domain.entity_id2" | |
| }, | |
| "icon": { | |
| "description": "Name of icon for the group.", | |
| "example": "mdi:camera" | |
| }, | |
| "name": { | |
| "description": "Name of group", | |
| "example": "My test group" | |
| }, | |
| "object_id": { | |
| "description": "Group id and part of entity id.", | |
| "example": "test_group" | |
| }, | |
| "view": { | |
| "description": "Boolean for if the group is a view.", | |
| "example": true | |
| }, | |
| "visible": { | |
| "description": "If the group is visible on UI.", | |
| "example": true | |
| } | |
| } | |
| }, | |
| "set_visibility": { | |
| "description": "Hide or show a group.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to set value.", | |
| "example": "group.travel" | |
| }, | |
| "visible": { | |
| "description": "True if group should be shown or False if it should be hidden.", | |
| "example": true | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "script", | |
| "services": { | |
| "bathroom_timer": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "reload": { | |
| "description": "Reload all the available scripts", | |
| "fields": {} | |
| }, | |
| "toggle": { | |
| "description": "Toggle script", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of script to be toggled.", | |
| "example": "script.arrive_home" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turn off script", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of script to be turned off.", | |
| "example": "script.arrive_home" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turn on script", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of script to be turned on.", | |
| "example": "script.arrive_home" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "cover", | |
| "services": { | |
| "close_cover": { | |
| "description": "Close all or specified cover.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to close.", | |
| "example": "cover.living_room" | |
| } | |
| } | |
| }, | |
| "close_cover_tilt": { | |
| "description": "Close all or specified cover tilt.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to close tilt.", | |
| "example": "cover.living_room_blinds" | |
| } | |
| } | |
| }, | |
| "open_cover": { | |
| "description": "Open all or specified cover.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to open.", | |
| "example": "cover.living_room" | |
| } | |
| } | |
| }, | |
| "open_cover_tilt": { | |
| "description": "Open all or specified cover tilt.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) tilt to open.", | |
| "example": "cover.living_room_blinds" | |
| } | |
| } | |
| }, | |
| "set_cover_position": { | |
| "description": "Move to specific position all or specified cover.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to set cover position.", | |
| "example": "cover.living_room" | |
| }, | |
| "position": { | |
| "description": "Position of the cover (0 to 100).", | |
| "example": 30 | |
| } | |
| } | |
| }, | |
| "set_cover_tilt_position": { | |
| "description": "Move to specific position all or specified cover tilt.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to set cover tilt position.", | |
| "example": "cover.living_room_blinds" | |
| }, | |
| "tilt_position": { | |
| "description": "Tilt position of the cover (0 to 100).", | |
| "example": 30 | |
| } | |
| } | |
| }, | |
| "stop_cover": { | |
| "description": "Stop all or specified cover.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to stop.", | |
| "example": "cover.living_room" | |
| } | |
| } | |
| }, | |
| "stop_cover_tilt": { | |
| "description": "Stop all or specified cover.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to stop.", | |
| "example": "cover.living_room_blinds" | |
| } | |
| } | |
| }, | |
| "toggle": { | |
| "description": "Toggles a cover open/closed.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to toggle.", | |
| "example": "cover.garage_door" | |
| } | |
| } | |
| }, | |
| "toggle_cover_tilt": { | |
| "description": "Toggles a cover tilt open/closed.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of cover(s) to toggle tilt.", | |
| "example": "cover.living_room_blinds" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "lock", | |
| "services": { | |
| "lock": { | |
| "description": "Lock all or specified locks.", | |
| "fields": { | |
| "code": { | |
| "description": "An optional code to lock the lock with.", | |
| "example": 1234 | |
| }, | |
| "entity_id": { | |
| "description": "Name of lock to lock.", | |
| "example": "lock.front_door" | |
| } | |
| } | |
| }, | |
| "open": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "unlock": { | |
| "description": "Unlock all or specified locks.", | |
| "fields": { | |
| "code": { | |
| "description": "An optional code to unlock the lock with.", | |
| "example": 1234 | |
| }, | |
| "entity_id": { | |
| "description": "Name of lock to unlock.", | |
| "example": "lock.front_door" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "light", | |
| "services": { | |
| "toggle": { | |
| "description": "Toggles a light.", | |
| "fields": { | |
| "...": { | |
| "description": "All turn_on parameters can be used." | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turn a light off.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn off.", | |
| "example": "light.kitchen" | |
| }, | |
| "flash": { | |
| "description": "If the light should flash.", | |
| "values": [ | |
| "short", | |
| "long" | |
| ] | |
| }, | |
| "transition": { | |
| "description": "Duration in seconds it takes to get to next state.", | |
| "example": 60 | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turn a light on.", | |
| "fields": { | |
| "brightness": { | |
| "description": "Number between 0..255 indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.", | |
| "example": 120 | |
| }, | |
| "brightness_pct": { | |
| "description": "Number between 0..100 indicating percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light.", | |
| "example": 47 | |
| }, | |
| "color_name": { | |
| "description": "A human readable color name.", | |
| "example": "red" | |
| }, | |
| "color_temp": { | |
| "description": "Color temperature for the light in mireds.", | |
| "example": 250 | |
| }, | |
| "effect": { | |
| "description": "Light effect.", | |
| "values": [ | |
| "colorloop", | |
| "random" | |
| ] | |
| }, | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn on", | |
| "example": "light.kitchen" | |
| }, | |
| "flash": { | |
| "description": "If the light should flash.", | |
| "values": [ | |
| "short", | |
| "long" | |
| ] | |
| }, | |
| "hs_color": { | |
| "description": "Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.", | |
| "example": "[300, 70]" | |
| }, | |
| "kelvin": { | |
| "description": "Color temperature for the light in Kelvin.", | |
| "example": 4000 | |
| }, | |
| "profile": { | |
| "description": "Name of a light profile to use.", | |
| "example": "relax" | |
| }, | |
| "rgb_color": { | |
| "description": "Color for the light in RGB-format.", | |
| "example": "[255, 100, 100]" | |
| }, | |
| "transition": { | |
| "description": "Duration in seconds it takes to get to next state", | |
| "example": 60 | |
| }, | |
| "white_value": { | |
| "description": "Number between 0..255 indicating level of white.", | |
| "example": "250" | |
| }, | |
| "xy_color": { | |
| "description": "Color for the light in XY-format.", | |
| "example": "[0.52, 0.43]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "broadlink", | |
| "services": { | |
| "learn": { | |
| "description": "Learn a IR or RF code from remote.", | |
| "fields": { | |
| "host": { | |
| "description": "IP address of device to send packet via. This must be an already configured device.", | |
| "example": "192.168.0.1" | |
| } | |
| } | |
| }, | |
| "send": { | |
| "description": "Send a raw packet to device.", | |
| "fields": { | |
| "host": { | |
| "description": "IP address of device to send packet via. This must be an already configured device.", | |
| "example": "192.168.0.1" | |
| }, | |
| "packet": { | |
| "description": "base64 encoded packet." | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "automation", | |
| "services": { | |
| "reload": { | |
| "description": "Reload the automation configuration.", | |
| "fields": {} | |
| }, | |
| "toggle": { | |
| "description": "Toggle an automation.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name of the automation to toggle on/off.", | |
| "example": "automation.notify_home" | |
| } | |
| } | |
| }, | |
| "trigger": { | |
| "description": "Trigger the action of an automation.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name of the automation to trigger.", | |
| "example": "automation.notify_home" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Disable an automation.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name of the automation to turn off.", | |
| "example": "automation.notify_home" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Enable an automation.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name of the automation to turn on.", | |
| "example": "automation.notify_home" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "hassio", | |
| "services": { | |
| "addon_restart": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "addon_start": { | |
| "description": "Start a HassIO docker addon.", | |
| "fields": { | |
| "addon": { | |
| "description": "Name of addon.", | |
| "example": "smb_config" | |
| } | |
| } | |
| }, | |
| "addon_stdin": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "addon_stop": { | |
| "description": "Stop a HassIO docker addon.", | |
| "fields": { | |
| "addon": { | |
| "description": "Name of addon.", | |
| "example": "smb_config" | |
| } | |
| } | |
| }, | |
| "host_reboot": { | |
| "description": "Reboot host computer.", | |
| "fields": {} | |
| }, | |
| "host_shutdown": { | |
| "description": "Poweroff host computer.", | |
| "fields": {} | |
| }, | |
| "restore_full": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "restore_partial": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "snapshot_full": { | |
| "description": "", | |
| "fields": {} | |
| }, | |
| "snapshot_partial": { | |
| "description": "", | |
| "fields": {} | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "stream", | |
| "services": { | |
| "record": { | |
| "description": "", | |
| "fields": {} | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "switch", | |
| "services": { | |
| "toggle": { | |
| "description": "Toggles a switch state.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to toggle.", | |
| "example": "switch.living_room" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turn a switch off.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn off.", | |
| "example": "switch.living_room" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turn a switch on.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to turn on", | |
| "example": "switch.living_room" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| { | |
| "domain": "camera", | |
| "services": { | |
| "disable_motion_detection": { | |
| "description": "Disable the motion detection in a camera.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to disable motion detection.", | |
| "example": "camera.living_room_camera" | |
| } | |
| } | |
| }, | |
| "enable_motion_detection": { | |
| "description": "Enable the motion detection in a camera.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to enable motion detection.", | |
| "example": "camera.living_room_camera" | |
| } | |
| } | |
| }, | |
| "play_stream": { | |
| "description": "Play camera stream on supported media player.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to stream from.", | |
| "example": "camera.living_room_camera" | |
| }, | |
| "format": { | |
| "description": "(Optional) Stream format supported by media player.", | |
| "example": "hls" | |
| }, | |
| "media_player": { | |
| "description": "Name(s) of media player to stream to.", | |
| "example": "media_player.living_room_tv" | |
| } | |
| } | |
| }, | |
| "record": { | |
| "description": "Record live camera feed.", | |
| "fields": { | |
| "duration": { | |
| "default": 30, | |
| "description": "(Optional) Target recording length (in seconds).", | |
| "example": 30 | |
| }, | |
| "entity_id": { | |
| "description": "Name of entities to record.", | |
| "example": "camera.living_room_camera" | |
| }, | |
| "filename": { | |
| "description": "Template of a Filename. Variable is entity_id. Must be mp4.", | |
| "example": "/tmp/snapshot_{{ entity_id }}.mp4" | |
| }, | |
| "lookback": { | |
| "description": "(Optional) Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream.", | |
| "example": 4 | |
| } | |
| } | |
| }, | |
| "snapshot": { | |
| "description": "Take a snapshot from a camera.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Name(s) of entities to create snapshots from.", | |
| "example": "camera.living_room_camera" | |
| }, | |
| "filename": { | |
| "description": "Template of a Filename. Variable is entity_id.", | |
| "example": "/tmp/snapshot_{{ entity_id }}" | |
| } | |
| } | |
| }, | |
| "turn_off": { | |
| "description": "Turn off camera.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Entity id.", | |
| "example": "camera.living_room" | |
| } | |
| } | |
| }, | |
| "turn_on": { | |
| "description": "Turn on camera.", | |
| "fields": { | |
| "entity_id": { | |
| "description": "Entity id.", | |
| "example": "camera.living_room" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment