github/streamdeck-homeassistant
1
1
Fork 0
mirror of https://github.com/cgiesche/streamdeck-homeassistant.git synced 2026-04-22 03:00:19 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.5.2
streamdeck-homeassistant/doc/services.json
Christoph Giesche 7f61b2b566 Cleanup and reorg.
2023-01-11 23:56:18 +01:00

4484 lines
121 KiB
JSON
Raw Permalink Blame History

{
"id": 3,
"type": "result",
"success": true,
"result": {
"persistent_notification": {
"create": {
"name": "Create",
"description": "Show a notification in the frontend.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification. [Templates accepted]",
"required": true,
"example": "Please check your configuration.yaml.",
"selector": {
"text": null
}
},
"title": {
"name": "Title",
"description": "Optional title for your notification. [Templates accepted]",
"example": "Test notification",
"selector": {
"text": null
}
},
"notification_id": {
"name": "Notification ID",
"description": "Target ID of the notification, will replace a notification with the same ID.",
"example": 1234,
"selector": {
"text": null
}
}
}
},
"dismiss": {
"name": "Dismiss",
"description": "Remove a notification from the frontend.",
"fields": {
"notification_id": {
"name": "Notification ID",
"description": "Target ID of the notification, which should be removed.",
"required": true,
"example": 1234,
"selector": {
"text": null
}
}
}
},
"mark_read": {
"name": "Mark read",
"description": "Mark a notification read.",
"fields": {
"notification_id": {
"name": "Notification ID",
"description": "Target ID of the notification, which should be mark read.",
"required": true,
"example": 1234,
"selector": {
"text": null
}
}
}
}
},
"homeassistant": {
"save_persistent_states": {
"name": "Save Persistent States",
"description": "Save the persistent states (for entities derived from RestoreEntity) immediately. Maintain the normal periodic saving interval.",
"fields": {}
},
"turn_off": {
"name": "Generic turn off",
"description": "Generic service to turn devices off under any domain.",
"fields": {},
"target": {
"entity": {}
}
},
"turn_on": {
"name": "Generic turn on",
"description": "Generic service to turn devices on under any domain.",
"fields": {},
"target": {
"entity": {}
}
},
"toggle": {
"name": "Generic toggle",
"description": "Generic service to toggle devices on/off under any domain",
"fields": {},
"target": {
"entity": {}
}
},
"stop": {
"name": "Stop",
"description": "Stop the Home Assistant service.",
"fields": {}
},
"restart": {
"name": "Restart",
"description": "Restart the Home Assistant service.",
"fields": {}
},
"check_config": {
"name": "Check configuration",
"description": "Check the Home Assistant configuration files for errors. Errors will be displayed in the Home Assistant log.",
"fields": {}
},
"update_entity": {
"name": "Update entity",
"description": "Force one or more entities to update its data",
"fields": {},
"target": {
"entity": {}
}
},
"reload_core_config": {
"name": "Reload core configuration",
"description": "Reload the core configuration.",
"fields": {}
},
"set_location": {
"name": "Set location",
"description": "Update the Home Assistant location.",
"fields": {
"latitude": {
"name": "Latitude",
"description": "Latitude of your location.",
"required": true,
"example": 32.87336,
"selector": {
"text": null
}
},
"longitude": {
"name": "Longitude",
"description": "Longitude of your location.",
"required": true,
"example": 117.22743,
"selector": {
"text": null
}
}
}
},
"reload_config_entry": {
"name": "Reload config entry",
"description": "Reload a config entry that matches a target.",
"fields": {
"entry_id": {
"advanced": true,
"name": "Config entry id",
"description": "A configuration entry id",
"required": false,
"example": "8955375327824e14ba89e4b29cc3ec9a",
"selector": {
"text": null
}
}
},
"target": {
"entity": {},
"device": {}
}
}
},
"system_log": {
"clear": {
"name": "Clear all",
"description": "Clear all log entries.",
"fields": {}
},
"write": {
"name": "Write",
"description": "Write log entry.",
"fields": {
"message": {
"name": "Message",
"description": "Message to log.",
"required": true,
"example": "Something went wrong",
"selector": {
"text": null
}
},
"level": {
"name": "Level",
"description": "Log level.",
"default": "error",
"selector": {
"select": {
"options": [
{
"label": "Debug",
"value": "debug"
},
{
"label": "Info",
"value": "info"
},
{
"label": "Warning",
"value": "warning"
},
{
"label": "Error",
"value": "error"
},
{
"label": "Critical",
"value": "critical"
}
]
}
}
},
"logger": {
"name": "Logger",
"description": "Logger name under which to log the message. Defaults to 'system_log.external'.",
"example": "mycomponent.myplatform",
"selector": {
"text": null
}
}
}
}
},
"logger": {
"set_default_level": {
"name": "Set default level",
"description": "Set the default log level for integrations.",
"fields": {
"level": {
"name": "Level",
"description": "Default severity level for all integrations.",
"selector": {
"select": {
"options": [
{
"label": "Debug",
"value": "debug"
},
{
"label": "Info",
"value": "info"
},
{
"label": "Warning",
"value": "warning"
},
{
"label": "Error",
"value": "error"
},
{
"label": "Fatal",
"value": "fatal"
},
{
"label": "Critical",
"value": "critical"
}
]
}
}
}
}
},
"set_level": {
"name": "Set level",
"description": "Set log level for integrations.",
"fields": {}
}
},
"person": {
"reload": {
"name": "Reload",
"description": "Reload the person configuration.",
"fields": {}
}
},
"frontend": {
"set_theme": {
"name": "Set theme",
"description": "Set a theme unless the client selected per-device theme.",
"fields": {
"name": {
"name": "Theme",
"description": "Name of a predefined theme",
"required": true,
"example": "default",
"selector": {
"theme": null
}
},
"mode": {
"name": "Mode",
"description": "The mode the theme is for.",
"default": "light",
"selector": {
"select": {
"options": [
{
"label": "Dark",
"value": "dark"
},
{
"label": "Light",
"value": "light"
}
]
}
}
}
}
},
"reload_themes": {
"name": "Reload themes",
"description": "Reload themes from YAML configuration.",
"fields": {}
}
},
"recorder": {
"purge": {
"name": "Purge",
"description": "Start purge task - to clean up old data from your database.",
"fields": {
"keep_days": {
"name": "Days to keep",
"description": "Number of history days to keep in database after purge.",
"selector": {
"number": {
"min": 0,
"max": 365,
"unit_of_measurement": "days"
}
}
},
"repack": {
"name": "Repack",
"description": "Attempt to save disk space by rewriting the entire database file.",
"default": false,
"selector": {
"boolean": null
}
},
"apply_filter": {
"name": "Apply filter",
"description": "Apply entity_id and event_type filter in addition to time based purge.",
"default": false,
"selector": {
"boolean": null
}
}
}
},
"purge_entities": {
"name": "Purge Entities",
"description": "Start purge task to remove specific entities from your database.",
"fields": {
"domains": {
"name": "Domains to remove",
"description": "List the domains that need to be removed from the recorder database.",
"example": "sun",
"required": false,
"default": [],
"selector": {
"object": null
}
},
"entity_globs": {
"name": "Entity Globs to remove",
"description": "List the glob patterns to select entities for removal from the recorder database.",
"example": "domain*.object_id*",
"required": false,
"default": [],
"selector": {
"object": null
}
}
},
"target": {
"entity": {}
}
},
"enable": {
"name": "Enable",
"description": "Start the recording of events and state changes",
"fields": {}
},
"disable": {
"name": "Disable",
"description": "Stop the recording of events and state changes",
"fields": {}
}
},
"cloud": {
"remote_connect": {
"name": "Remote connect",
"description": "Make instance UI available outside over NabuCasa cloud",
"fields": {}
},
"remote_disconnect": {
"name": "Remote disconnect",
"description": "Disconnect UI from NabuCasa cloud",
"fields": {}
}
},
"scene": {
"reload": {
"name": "Reload",
"description": "Reload the scene configuration.",
"fields": {}
},
"apply": {
"name": "Apply",
"description": "Activate a scene with configuration.",
"fields": {
"entities": {
"name": "Entities state",
"description": "The entities and the state that they need to be.",
"required": true,
"example": {
"light.kitchen": "on",
"light.ceiling": {
"state": "on",
"brightness": 80
}
},
"selector": {
"object": null
}
},
"transition": {
"name": "Transition",
"description": "Transition duration it takes to bring devices to the state defined in the scene.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
}
}
},
"create": {
"name": "Create",
"description": "Creates a new scene.",
"fields": {
"scene_id": {
"name": "Scene entity ID",
"description": "The entity_id of the new scene.",
"required": true,
"example": "all_lights",
"selector": {
"text": null
}
},
"entities": {
"name": "Entities state",
"description": "The entities to control with the scene.",
"example": {
"light.tv_back_light": "on",
"light.ceiling": {
"state": "on",
"brightness": 200
}
},
"selector": {
"object": null
}
},
"snapshot_entities": {
"name": "Snapshot entities",
"description": "The entities of which a snapshot is to be taken",
"example": [
"light.ceiling",
"light.kitchen"
],
"selector": {
"object": null
}
}
}
},
"turn_on": {
"name": "Activate",
"description": "Activate a scene.",
"fields": {
"transition": {
"name": "Transition",
"description": "Transition duration it takes to bring devices to the state defined in the scene.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
}
},
"target": {
"entity": {
"domain": "scene"
}
}
}
},
"light": {
"turn_on": {
"name": "Turn on",
"description": "Turn on one or more lights and adjust properties of the light, even when they are turned on already.\n",
"fields": {
"transition": {
"name": "Transition",
"description": "Duration it takes to get to next state.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
},
"rgb_color": {
"name": "Color",
"description": "The color for the light (based on RGB - red, green, blue).",
"selector": {
"color_rgb": null
}
},
"rgbw_color": {
"name": "RGBW-color",
"description": "A list containing four integers between 0 and 255 representing the RGBW (red, green, blue, white) color for the light.",
"advanced": true,
"example": "[255, 100, 100, 50]",
"selector": {
"object": null
}
},
"rgbww_color": {
"name": "RGBWW-color",
"description": "A list containing five integers between 0 and 255 representing the RGBWW (red, green, blue, cold white, warm white) color for the light.",
"advanced": true,
"example": "[255, 100, 100, 50, 70]",
"selector": {
"object": null
}
},
"color_name": {
"name": "Color name",
"description": "A human readable color name.",
"advanced": true,
"selector": {
"select": {
"options": [
"homeassistant",
"aliceblue",
"antiquewhite",
"aqua",
"aquamarine",
"azure",
"beige",
"bisque",
"blanchedalmond",
"blue",
"blueviolet",
"brown",
"burlywood",
"cadetblue",
"chartreuse",
"chocolate",
"coral",
"cornflowerblue",
"cornsilk",
"crimson",
"cyan",
"darkblue",
"darkcyan",
"darkgoldenrod",
"darkgray",
"darkgreen",
"darkgrey",
"darkkhaki",
"darkmagenta",
"darkolivegreen",
"darkorange",
"darkorchid",
"darkred",
"darksalmon",
"darkseagreen",
"darkslateblue",
"darkslategray",
"darkslategrey",
"darkturquoise",
"darkviolet",
"deeppink",
"deepskyblue",
"dimgray",
"dimgrey",
"dodgerblue",
"firebrick",
"floralwhite",
"forestgreen",
"fuchsia",
"gainsboro",
"ghostwhite",
"gold",
"goldenrod",
"gray",
"green",
"greenyellow",
"grey",
"honeydew",
"hotpink",
"indianred",
"indigo",
"ivory",
"khaki",
"lavender",
"lavenderblush",
"lawngreen",
"lemonchiffon",
"lightblue",
"lightcoral",
"lightcyan",
"lightgoldenrodyellow",
"lightgray",
"lightgreen",
"lightgrey",
"lightpink",
"lightsalmon",
"lightseagreen",
"lightskyblue",
"lightslategray",
"lightslategrey",
"lightsteelblue",
"lightyellow",
"lime",
"limegreen",
"linen",
"magenta",
"maroon",
"mediumaquamarine",
"mediumblue",
"mediumorchid",
"mediumpurple",
"mediumseagreen",
"mediumslateblue",
"mediumspringgreen",
"mediumturquoise",
"mediumvioletred",
"midnightblue",
"mintcream",
"mistyrose",
"moccasin",
"navajowhite",
"navy",
"navyblue",
"oldlace",
"olive",
"olivedrab",
"orange",
"orangered",
"orchid",
"palegoldenrod",
"palegreen",
"paleturquoise",
"palevioletred",
"papayawhip",
"peachpuff",
"peru",
"pink",
"plum",
"powderblue",
"purple",
"red",
"rosybrown",
"royalblue",
"saddlebrown",
"salmon",
"sandybrown",
"seagreen",
"seashell",
"sienna",
"silver",
"skyblue",
"slateblue",
"slategray",
"slategrey",
"snow",
"springgreen",
"steelblue",
"tan",
"teal",
"thistle",
"tomato",
"turquoise",
"violet",
"wheat",
"white",
"whitesmoke",
"yellow",
"yellowgreen"
]
}
}
},
"hs_color": {
"name": "Hue/Sat color",
"description": "Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.",
"advanced": true,
"example": "[300, 70]",
"selector": {
"object": null
}
},
"xy_color": {
"name": "XY-color",
"description": "Color for the light in XY-format.",
"advanced": true,
"example": "[0.52, 0.43]",
"selector": {
"object": null
}
},
"color_temp": {
"name": "Color temperature",
"description": "Color temperature for the light in mireds.",
"selector": {
"color_temp": {
"min_mireds": 153,
"max_mireds": 500
}
}
},
"kelvin": {
"name": "Color temperature (Kelvin)",
"description": "Color temperature for the light in Kelvin.",
"advanced": true,
"selector": {
"number": {
"min": 2000,
"max": 6500,
"step": 100,
"unit_of_measurement": "K"
}
}
},
"brightness": {
"name": "Brightness value",
"description": "Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 255
}
}
},
"brightness_pct": {
"name": "Brightness",
"description": "Number 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.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
},
"brightness_step": {
"name": "Brightness step value",
"description": "Change brightness by an amount.",
"advanced": true,
"selector": {
"number": {
"min": -225,
"max": 255
}
}
},
"brightness_step_pct": {
"name": "Brightness step",
"description": "Change brightness by a percentage.",
"selector": {
"number": {
"min": -100,
"max": 100,
"unit_of_measurement": "%"
}
}
},
"white": {
"name": "White",
"description": "Set the light to white mode and change its brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 255
}
}
},
"profile": {
"name": "Profile",
"description": "Name of a light profile to use.",
"advanced": true,
"example": "relax",
"selector": {
"text": null
}
},
"flash": {
"name": "Flash",
"description": "If the light should flash.",
"advanced": true,
"selector": {
"select": {
"options": [
{
"label": "Long",
"value": "long"
},
{
"label": "Short",
"value": "short"
}
]
}
}
},
"effect": {
"name": "Effect",
"description": "Light effect.",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "light"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turns off one or more lights.",
"fields": {
"transition": {
"name": "Transition",
"description": "Duration it takes to get to next state.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
},
"flash": {
"name": "Flash",
"description": "If the light should flash.",
"advanced": true,
"selector": {
"select": {
"options": [
{
"label": "Long",
"value": "long"
},
{
"label": "Short",
"value": "short"
}
]
}
}
}
},
"target": {
"entity": {
"domain": "light"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggles one or more lights, from on to off, or, off to on, based on their current state.\n",
"fields": {
"transition": {
"name": "Transition",
"description": "Duration it takes to get to next state.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
},
"rgb_color": {
"name": "RGB-color",
"description": "Color for the light in RGB-format.",
"advanced": true,
"example": "[255, 100, 100]",
"selector": {
"object": null
}
},
"color_name": {
"name": "Color name",
"description": "A human readable color name.",
"advanced": true,
"selector": {
"select": {
"options": [
"homeassistant",
"aliceblue",
"antiquewhite",
"aqua",
"aquamarine",
"azure",
"beige",
"bisque",
"blanchedalmond",
"blue",
"blueviolet",
"brown",
"burlywood",
"cadetblue",
"chartreuse",
"chocolate",
"coral",
"cornflowerblue",
"cornsilk",
"crimson",
"cyan",
"darkblue",
"darkcyan",
"darkgoldenrod",
"darkgray",
"darkgreen",
"darkgrey",
"darkkhaki",
"darkmagenta",
"darkolivegreen",
"darkorange",
"darkorchid",
"darkred",
"darksalmon",
"darkseagreen",
"darkslateblue",
"darkslategray",
"darkslategrey",
"darkturquoise",
"darkviolet",
"deeppink",
"deepskyblue",
"dimgray",
"dimgrey",
"dodgerblue",
"firebrick",
"floralwhite",
"forestgreen",
"fuchsia",
"gainsboro",
"ghostwhite",
"gold",
"goldenrod",
"gray",
"green",
"greenyellow",
"grey",
"honeydew",
"hotpink",
"indianred",
"indigo",
"ivory",
"khaki",
"lavender",
"lavenderblush",
"lawngreen",
"lemonchiffon",
"lightblue",
"lightcoral",
"lightcyan",
"lightgoldenrodyellow",
"lightgray",
"lightgreen",
"lightgrey",
"lightpink",
"lightsalmon",
"lightseagreen",
"lightskyblue",
"lightslategray",
"lightslategrey",
"lightsteelblue",
"lightyellow",
"lime",
"limegreen",
"linen",
"magenta",
"maroon",
"mediumaquamarine",
"mediumblue",
"mediumorchid",
"mediumpurple",
"mediumseagreen",
"mediumslateblue",
"mediumspringgreen",
"mediumturquoise",
"mediumvioletred",
"midnightblue",
"mintcream",
"mistyrose",
"moccasin",
"navajowhite",
"navy",
"navyblue",
"oldlace",
"olive",
"olivedrab",
"orange",
"orangered",
"orchid",
"palegoldenrod",
"palegreen",
"paleturquoise",
"palevioletred",
"papayawhip",
"peachpuff",
"peru",
"pink",
"plum",
"powderblue",
"purple",
"red",
"rosybrown",
"royalblue",
"saddlebrown",
"salmon",
"sandybrown",
"seagreen",
"seashell",
"sienna",
"silver",
"skyblue",
"slateblue",
"slategray",
"slategrey",
"snow",
"springgreen",
"steelblue",
"tan",
"teal",
"thistle",
"tomato",
"turquoise",
"violet",
"wheat",
"white",
"whitesmoke",
"yellow",
"yellowgreen"
]
}
}
},
"hs_color": {
"name": "Hue/Sat color",
"description": "Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.",
"advanced": true,
"example": "[300, 70]",
"selector": {
"object": null
}
},
"xy_color": {
"name": "XY-color",
"description": "Color for the light in XY-format.",
"advanced": true,
"example": "[0.52, 0.43]",
"selector": {
"object": null
}
},
"color_temp": {
"name": "Color temperature (mireds)",
"description": "Color temperature for the light in mireds.",
"advanced": true,
"selector": {
"color_temp": null
}
},
"kelvin": {
"name": "Color temperature (Kelvin)",
"description": "Color temperature for the light in Kelvin.",
"advanced": true,
"selector": {
"number": {
"min": 2000,
"max": 6500,
"step": 100,
"unit_of_measurement": "K"
}
}
},
"brightness": {
"name": "Brightness value",
"description": "Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 255
}
}
},
"brightness_pct": {
"name": "Brightness",
"description": "Number 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.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
},
"profile": {
"name": "Profile",
"description": "Name of a light profile to use.",
"advanced": true,
"example": "relax",
"selector": {
"text": null
}
},
"flash": {
"name": "Flash",
"description": "If the light should flash.",
"advanced": true,
"selector": {
"select": {
"options": [
{
"label": "Long",
"value": "long"
},
{
"label": "Short",
"value": "short"
}
]
}
}
},
"effect": {
"name": "Effect",
"description": "Light effect.",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "light"
}
}
}
},
"alarm_control_panel": {
"alarm_disarm": {
"name": "Disarm",
"description": "Send the alarm the command for disarm.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to disarm the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_arm_home": {
"name": "Arm home",
"description": "Send the alarm the command for arm home.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to arm home the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_arm_away": {
"name": "Arm away",
"description": "Send the alarm the command for arm away.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to arm away the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_arm_night": {
"name": "Arm night",
"description": "Send the alarm the command for arm night.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to arm night the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_arm_vacation": {
"name": "Arm vacation",
"description": "Send the alarm the command for arm vacation.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to arm vacation the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_arm_custom_bypass": {
"name": "Arm with custom bypass",
"description": "Send arm custom bypass command.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to arm custom bypass the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
},
"alarm_trigger": {
"name": "Trigger",
"description": "Send the alarm the command for trigger.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to trigger the alarm control panel with.",
"example": "1234",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "alarm_control_panel"
}
}
}
},
"logbook": {
"log": {
"name": "Log",
"description": "Create a custom entry in your logbook.",
"fields": {
"name": {
"name": "Name",
"description": "Custom name for an entity, can be referenced with entity_id.",
"required": true,
"example": "Kitchen",
"selector": {
"text": null
}
},
"message": {
"name": "Message",
"description": "Message of the custom logbook entry.",
"required": true,
"example": "is being used",
"selector": {
"text": null
}
},
"entity_id": {
"name": "Entity ID",
"description": "Entity to reference in custom logbook entry.",
"selector": {
"entity": null
}
},
"domain": {
"name": "Domain",
"description": "Icon of domain to display in custom logbook entry.",
"example": "light",
"selector": {
"text": null
}
}
}
}
},
"group": {
"reload": {
"name": "Reload",
"description": "Reload group configuration, entities, and notify services.",
"fields": {}
},
"set": {
"name": "Set",
"description": "Create/Update a user group.",
"fields": {
"object_id": {
"name": "Object ID",
"description": "Group id and part of entity id.",
"required": true,
"example": "test_group",
"selector": {
"text": null
}
},
"name": {
"name": "Name",
"description": "Name of group",
"example": "My test group",
"selector": {
"text": null
}
},
"icon": {
"name": "Icon",
"description": "Name of icon for the group.",
"example": "mdi:camera",
"selector": {
"icon": null
}
},
"entities": {
"name": "Entities",
"description": "List of all members in the group. Not compatible with 'delta'.",
"example": "domain.entity_id1, domain.entity_id2",
"selector": {
"object": null
}
},
"add_entities": {
"name": "Add Entities",
"description": "List of members that will change on group listening.",
"example": "domain.entity_id1, domain.entity_id2",
"selector": {
"object": null
}
},
"all": {
"name": "All",
"description": "Enable this option if the group should only turn on when all entities are on.",
"selector": {
"boolean": null
}
}
}
},
"remove": {
"name": "Remove",
"description": "Remove a user group.",
"fields": {
"object_id": {
"name": "Object ID",
"description": "Group id and part of entity id.",
"required": true,
"example": "test_group",
"selector": {
"object": null
}
}
}
}
},
"counter": {
"increment": {
"name": "Increment",
"description": "Increment a counter.",
"fields": {},
"target": {
"entity": {
"domain": "counter"
}
}
},
"decrement": {
"name": "Decrement",
"description": "Decrement a counter.",
"fields": {},
"target": {
"entity": {
"domain": "counter"
}
}
},
"reset": {
"name": "Reset",
"description": "Reset a counter.",
"fields": {},
"target": {
"entity": {
"domain": "counter"
}
}
},
"configure": {
"name": "Configure",
"description": "Change counter parameters.",
"fields": {
"minimum": {
"name": "Minimum",
"description": "New minimum value for the counter or None to remove minimum.",
"selector": {
"number": {
"min": -9223372036854775807,
"max": 9223372036854775807,
"mode": "box"
}
}
},
"maximum": {
"name": "Maximum",
"description": "New maximum value for the counter or None to remove maximum.",
"selector": {
"number": {
"min": -9223372036854775807,
"max": 9223372036854775807,
"mode": "box"
}
}
},
"step": {
"name": "Step",
"description": "New value for step.",
"selector": {
"number": {
"min": 1,
"max": 9223372036854775807,
"mode": "box"
}
}
},
"initial": {
"name": "Initial",
"description": "New value for initial.",
"selector": {
"number": {
"min": 0,
"max": 9223372036854775807,
"mode": "box"
}
}
},
"value": {
"name": "Value",
"description": "New state value.",
"selector": {
"number": {
"min": 0,
"max": 9223372036854775807,
"mode": "box"
}
}
}
},
"target": {
"entity": {
"domain": "counter"
}
}
}
},
"zone": {
"reload": {
"name": "Reload",
"description": "Reload the YAML-based zone configuration.",
"fields": {}
}
},
"timer": {
"reload": {
"name": "",
"description": "",
"fields": {}
},
"start": {
"name": "Start",
"description": "Start a timer",
"fields": {
"duration": {
"description": "Duration the timer requires to finish. [optional]",
"default": 0,
"example": "00:01:00 or 60",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "timer"
}
}
},
"pause": {
"name": "Pause",
"description": "Pause a timer.",
"fields": {},
"target": {
"entity": {
"domain": "timer"
}
}
},
"cancel": {
"name": "Cancel",
"description": "Cancel a timer.",
"fields": {},
"target": {
"entity": {
"domain": "timer"
}
}
},
"finish": {
"name": "Finish",
"description": "Finish a timer.",
"fields": {},
"target": {
"entity": {
"domain": "timer"
}
}
}
},
"automation": {
"trigger": {
"name": "Trigger",
"description": "Trigger the actions of an automation.",
"fields": {
"skip_condition": {
"name": "Skip conditions",
"description": "Whether or not the conditions will be skipped.",
"default": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "automation"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggle (enable / disable) an automation.",
"fields": {},
"target": {
"entity": {
"domain": "automation"
}
}
},
"turn_on": {
"name": "Turn on",
"description": "Enable an automation.",
"fields": {},
"target": {
"entity": {
"domain": "automation"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Disable an automation.",
"fields": {
"stop_actions": {
"name": "Stop actions",
"description": "Stop currently running actions.",
"default": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "automation"
}
}
},
"reload": {
"name": "Reload",
"description": "Reload the automation configuration.",
"fields": {}
}
},
"input_button": {
"reload": {
"name": "",
"description": "",
"fields": {}
},
"press": {
"name": "Press",
"description": "Press the input button entity.",
"fields": {},
"target": {
"entity": {
"domain": "input_button"
}
}
}
},
"input_text": {
"reload": {
"name": "Reload",
"description": "Reload the input_text configuration.",
"fields": {}
},
"set_value": {
"name": "Set",
"description": "Set the value of an input text entity.",
"fields": {
"value": {
"name": "Value",
"description": "The target value the entity should be set to.",
"required": true,
"example": "This is an example text",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "input_text"
}
}
}
},
"input_select": {
"reload": {
"name": "Reload",
"description": "Reload the input_select configuration.",
"fields": {}
},
"select_option": {
"name": "Select",
"description": "Select an option of an input select entity.",
"fields": {
"option": {
"name": "Option",
"description": "Option to be selected.",
"required": true,
"example": "\"Item A\"",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "input_select"
}
}
},
"select_next": {
"name": "Next",
"description": "Select the next options of an input select entity.",
"fields": {
"cycle": {
"name": "Cycle",
"description": "If the option should cycle from the last to the first.",
"default": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "input_select"
}
}
},
"select_previous": {
"name": "Previous",
"description": "Select the previous options of an input select entity.",
"fields": {
"cycle": {
"name": "Cycle",
"description": "If the option should cycle from the first to the last.",
"default": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "input_select"
}
}
},
"select_first": {
"name": "First",
"description": "Select the first option of an input select entity.",
"fields": {},
"target": {
"entity": {
"domain": "input_select"
}
}
},
"select_last": {
"name": "Last",
"description": "Select the last option of an input select entity.",
"fields": {},
"target": {
"entity": {
"domain": "input_select"
}
}
},
"set_options": {
"name": "Set options",
"description": "Set the options of an input select entity.",
"fields": {
"options": {
"name": "Options",
"description": "Options for the input select entity.",
"required": true,
"example": "[\"Item A\", \"Item B\", \"Item C\"]",
"selector": {
"object": null
}
}
},
"target": {
"entity": {
"domain": "input_select"
}
}
}
},
"input_boolean": {
"reload": {
"name": "Reload",
"description": "Reload the input_boolean configuration",
"fields": {}
},
"turn_on": {
"name": "Turn on",
"description": "Turn on an input boolean",
"fields": {},
"target": {
"entity": {
"domain": "input_boolean"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn off an input boolean",
"fields": {},
"target": {
"entity": {
"domain": "input_boolean"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggle an input boolean",
"fields": {},
"target": {
"entity": {
"domain": "input_boolean"
}
}
}
},
"input_datetime": {
"reload": {
"name": "Reload",
"description": "Reload the input_datetime configuration.",
"fields": {}
},
"set_datetime": {
"name": "Set",
"description": "This can be used to dynamically set the date and/or time.",
"fields": {
"date": {
"name": "Date",
"description": "The target date the entity should be set to.",
"example": "\"2019-04-20\"",
"selector": {
"text": null
}
},
"time": {
"name": "Time",
"description": "The target time the entity should be set to.",
"example": "\"05:04:20\"",
"selector": {
"time": null
}
},
"datetime": {
"name": "Date & Time",
"description": "The target date & time the entity should be set to.",
"example": "\"2019-04-20 05:04:20\"",
"selector": {
"text": null
}
},
"timestamp": {
"name": "Timestamp",
"description": "The target date & time the entity should be set to as expressed by a UNIX timestamp.",
"selector": {
"number": {
"min": 0,
"max": 9223372036854775807,
"mode": "box"
}
}
}
},
"target": {
"entity": {
"domain": "input_datetime"
}
}
}
},
"template": {
"reload": {
"name": "Reload",
"description": "Reload all template entities.",
"fields": {}
}
},
"schedule": {
"reload": {
"name": "Reload",
"description": "Reload the schedule configuration",
"fields": {}
}
},
"input_number": {
"reload": {
"name": "Reload",
"description": "Reload the input_number configuration.",
"fields": {}
},
"set_value": {
"name": "Set",
"description": "Set the value of an input number entity.",
"fields": {
"value": {
"name": "Value",
"description": "The target value the entity should be set to.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 9223372036854775807,
"step": 0.001,
"mode": "box"
}
}
}
},
"target": {
"entity": {
"domain": "input_number"
}
}
},
"increment": {
"name": "Increment",
"description": "Increment the value of an input number entity by its stepping.",
"fields": {},
"target": {
"entity": {
"domain": "input_number"
}
}
},
"decrement": {
"name": "Decrement",
"description": "Decrement the value of an input number entity by its stepping.",
"fields": {},
"target": {
"entity": {
"domain": "input_number"
}
}
}
},
"script": {
"reload": {
"name": "Reload",
"description": "Reload all the available scripts",
"fields": {}
},
"turn_on": {
"name": "Turn on",
"description": "Turn on script",
"fields": {},
"target": {
"entity": {
"domain": "script"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn off script",
"fields": {},
"target": {
"entity": {
"domain": "script"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggle script",
"fields": {},
"target": {
"entity": {
"domain": "script"
}
}
}
},
"vacuum": {
"turn_on": {
"name": "Turn on",
"description": "Start a new cleaning task.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Stop the current cleaning task and return to home.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"toggle": {
"name": "",
"description": "",
"fields": {}
},
"start_pause": {
"name": "Start/Pause",
"description": "Start, pause, or resume the cleaning task.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"start": {
"name": "Start",
"description": "Start or resume the cleaning task.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"pause": {
"name": "Pause",
"description": "Pause the cleaning task.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"return_to_base": {
"name": "Return to base",
"description": "Tell the vacuum cleaner to return to its dock.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"clean_spot": {
"name": "Clean spot",
"description": "Tell the vacuum cleaner to do a spot clean-up.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"locate": {
"name": "Locate",
"description": "Locate the vacuum cleaner robot.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"stop": {
"name": "Stop",
"description": "Stop the current cleaning task.",
"fields": {},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"set_fan_speed": {
"name": "Set fan speed",
"description": "Set the fan speed of the vacuum cleaner.",
"fields": {
"fan_speed": {
"name": "Fan speed",
"description": "Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium' or by percentage, between 0 and 100.",
"required": true,
"example": "low",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "vacuum"
}
}
},
"send_command": {
"name": "Send command",
"description": "Send a raw command to the vacuum cleaner.",
"fields": {
"command": {
"name": "Command",
"description": "Command to execute.",
"required": true,
"example": "set_dnd_timer",
"selector": {
"text": null
}
},
"params": {
"name": "Parameters",
"description": "Parameters for the command.",
"example": "{ \"key\": \"value\" }",
"selector": {
"object": null
}
}
},
"target": {
"entity": {
"domain": "vacuum"
}
}
}
},
"mqtt": {
"publish": {
"name": "Publish",
"description": "Publish a message to an MQTT topic.",
"fields": {
"topic": {
"name": "Topic",
"description": "Topic to publish payload.",
"required": true,
"example": "/homeassistant/hello",
"selector": {
"text": null
}
},
"payload": {
"name": "Payload",
"description": "Payload to publish.",
"example": "This is great",
"selector": {
"text": null
}
},
"payload_template": {
"name": "Payload Template",
"description": "Template to render as payload value. Ignored if payload given.",
"advanced": true,
"example": "{{ states('sensor.temperature') }}",
"selector": {
"object": null
}
},
"qos": {
"name": "QoS",
"description": "Quality of Service to use.",
"advanced": true,
"default": 0,
"selector": {
"select": {
"options": [
"0",
"1",
"2"
]
}
}
},
"retain": {
"name": "Retain",
"description": "If message should have the retain flag set.",
"default": false,
"selector": {
"boolean": null
}
}
}
},
"dump": {
"name": "Dump",
"description": "Dump messages on a topic selector to the 'mqtt_dump.txt' file in your configuration folder.",
"fields": {
"topic": {
"name": "Topic",
"description": "topic to listen to",
"example": "OpenZWave/#",
"selector": {
"text": null
}
},
"duration": {
"name": "Duration",
"description": "how long we should listen for messages in seconds",
"default": 5,
"selector": {
"number": {
"min": 1,
"max": 300,
"unit_of_measurement": "seconds"
}
}
}
}
},
"reload": {
"name": "Reload",
"description": "Reload all MQTT entities from YAML.",
"fields": {}
}
},
"xiaomi_miio": {
"vacuum_remote_control_start": {
"name": "Vacuum remote control start",
"description": "Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`.",
"fields": {},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_remote_control_stop": {
"name": "Vacuum remote control stop",
"description": "Stop remote control mode of the vacuum cleaner.",
"fields": {},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_remote_control_move": {
"name": "Vacuum remote control move",
"description": "Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.",
"fields": {
"velocity": {
"name": "Velocity",
"description": "Speed.",
"selector": {
"number": {
"min": -0.29,
"max": 0.29,
"step": 0.01
}
}
},
"rotation": {
"name": "Rotation",
"description": "Rotation, between -179 degrees and 179 degrees.",
"selector": {
"number": {
"min": -179,
"max": 179,
"unit_of_measurement": "°"
}
}
},
"duration": {
"name": "Duration",
"description": "Duration of the movement.",
"selector": {
"number": {
"min": 1,
"max": 86400,
"unit_of_measurement": "seconds"
}
}
}
},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_remote_control_move_step": {
"name": "Vacuum remote control move step",
"description": "Remote control the vacuum cleaner, only makes one move and then stops.",
"fields": {
"velocity": {
"name": "Velocity",
"description": "Speed.",
"selector": {
"number": {
"min": -0.29,
"max": 0.29,
"step": 0.01
}
}
},
"rotation": {
"name": "Rotation",
"description": "Rotation.",
"selector": {
"number": {
"min": -179,
"max": 179,
"unit_of_measurement": "°"
}
}
},
"duration": {
"name": "Duration",
"description": "Duration of the movement.",
"selector": {
"number": {
"min": 1,
"max": 86400,
"unit_of_measurement": "seconds"
}
}
}
},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_clean_zone": {
"name": "Vacuum clean zone",
"description": "Start the cleaning operation in the selected areas for the number of repeats indicated.",
"fields": {
"zone": {
"name": "Zone",
"description": "Array of zones. Each zone is an array of 4 integer values.",
"example": "[[23510,25311,25110,26362]]",
"selector": {
"object": null
}
},
"repeats": {
"name": "Repeats",
"description": "Number of cleaning repeats for each zone.",
"selector": {
"number": {
"min": 1,
"max": 3
}
}
}
},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_goto": {
"name": "Vacuum go to",
"description": "Go to the specified coordinates.",
"fields": {
"x_coord": {
"name": "X coordinate",
"description": "x-coordinate.",
"example": 27500,
"selector": {
"text": null
}
},
"y_coord": {
"name": "Y coordinate",
"description": "y-coordinate.",
"example": 32000,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
},
"vacuum_clean_segment": {
"name": "Vacuum clean segment",
"description": "Start cleaning of the specified segment(s).",
"fields": {
"segments": {
"name": "Segments",
"description": "Segments.",
"example": "[1,2]",
"selector": {
"object": null
}
}
},
"target": {
"entity": {
"integration": "xiaomi_miio",
"domain": "vacuum"
}
}
}
},
"media_player": {
"turn_on": {
"name": "Turn on",
"description": "Turn a media player power on.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn a media player power off.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggles a media player power state.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"volume_up": {
"name": "Turn up volume",
"description": "Turn a media player volume up.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"volume_down": {
"name": "Turn down volume",
"description": "Turn a media player volume down.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_play_pause": {
"name": "Play/Pause",
"description": "Toggle media player play/pause state.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_play": {
"name": "Play",
"description": "Send the media player the command for play.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_pause": {
"name": "Pause",
"description": "Send the media player the command for pause.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_stop": {
"name": "Stop",
"description": "Send the media player the stop command.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_next_track": {
"name": "Next",
"description": "Send the media player the command for next track.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_previous_track": {
"name": "Previous",
"description": "Send the media player the command for previous track.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"clear_playlist": {
"name": "Clear playlist",
"description": "Send the media player the command to clear players playlist.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"volume_set": {
"name": "Set volume",
"description": "Set a media player's volume level.",
"fields": {
"volume_level": {
"name": "Level",
"description": "Volume level to set as float.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 1,
"step": 0.01
}
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"volume_mute": {
"name": "Mute volume",
"description": "Mute a media player's volume.",
"fields": {
"is_volume_muted": {
"name": "Muted",
"description": "True/false for mute/unmute.",
"required": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"media_seek": {
"name": "Seek",
"description": "Send the media player the command to seek in current playing media.",
"fields": {
"seek_position": {
"name": "Position",
"description": "Position to seek to. The format is platform dependent.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 9223372036854775807,
"step": 0.01,
"mode": "box"
}
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"join": {
"name": "Join",
"description": "Group players together. Only works on platforms with support for player groups.",
"fields": {
"group_members": {
"name": "Group members",
"description": "The players which will be synced with the target player.",
"required": true,
"example": "- media_player.multiroom_player2\n- media_player.multiroom_player3\n",
"selector": {
"entity": {
"multiple": true,
"domain": "media_player"
}
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"select_source": {
"name": "Select source",
"description": "Send the media player the command to change input source.",
"fields": {
"source": {
"name": "Source",
"description": "Name of the source to switch to. Platform dependent.",
"required": true,
"example": "video1",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"select_sound_mode": {
"name": "Select sound mode",
"description": "Send the media player the command to change sound mode.",
"fields": {
"sound_mode": {
"name": "Sound mode",
"description": "Name of the sound mode to switch to.",
"example": "Music",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"play_media": {
"name": "Play media",
"description": "Send the media player the command for playing media.",
"fields": {
"media_content_id": {
"name": "Content ID",
"description": "The ID of the content to play. Platform dependent.",
"required": true,
"example": "https://home-assistant.io/images/cast/splash.png",
"selector": {
"text": null
}
},
"media_content_type": {
"name": "Content type",
"description": "The type of the content to play. Like image, music, tvshow, video, episode, channel or playlist.",
"required": true,
"example": "music",
"selector": {
"text": null
}
},
"enqueue": {
"name": "Enqueue",
"description": "If the content should be played now or be added to the queue.",
"required": false,
"selector": {
"select": {
"options": [
{
"label": "Play now",
"value": "play"
},
{
"label": "Play next",
"value": "next"
},
{
"label": "Add to queue",
"value": "add"
},
{
"label": "Play now and clear queue",
"value": "replace"
}
]
}
}
},
"announce": {
"name": "Announce",
"description": "If the media should be played as an announcement.",
"required": false,
"example": "true",
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"shuffle_set": {
"name": "Shuffle",
"description": "Set shuffling state.",
"fields": {
"shuffle": {
"name": "Shuffle",
"description": "True/false for enabling/disabling shuffle.",
"required": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"unjoin": {
"name": "Unjoin",
"description": "Unjoin the player from a group. Only works on platforms with support for player groups.",
"fields": {},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"repeat_set": {
"name": "Repeat",
"description": "Set repeat mode",
"fields": {
"repeat": {
"name": "Repeat mode",
"description": "Repeat mode to set.",
"required": true,
"selector": {
"select": {
"options": [
{
"label": "Off",
"value": "off"
},
{
"label": "Repeat all",
"value": "all"
},
{
"label": "Repeat one",
"value": "one"
}
]
}
}
}
},
"target": {
"entity": {
"domain": "media_player"
}
}
},
"onkyo_select_hdmi_output": {
"name": "",
"description": "",
"fields": {}
}
},
"climate": {
"turn_on": {
"name": "Turn on",
"description": "Turn climate device on.",
"fields": {},
"target": {
"entity": {
"domain": "climate"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn climate device off.",
"fields": {},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_hvac_mode": {
"name": "Set HVAC mode",
"description": "Set HVAC operation mode for climate device.",
"fields": {
"hvac_mode": {
"name": "HVAC mode",
"description": "New value of operation mode.",
"selector": {
"select": {
"options": [
{
"label": "Off",
"value": "off"
},
{
"label": "Auto",
"value": "auto"
},
{
"label": "Cool",
"value": "cool"
},
{
"label": "Dry",
"value": "dry"
},
{
"label": "Fan Only",
"value": "fan_only"
},
{
"label": "Heat/Cool",
"value": "heat_cool"
},
{
"label": "Heat",
"value": "heat"
}
]
}
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_preset_mode": {
"name": "Set preset mode",
"description": "Set preset mode for climate device.",
"fields": {
"preset_mode": {
"name": "Preset mode",
"description": "New value of preset mode.",
"required": true,
"example": "away",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_aux_heat": {
"name": "Turn on/off auxiliary heater",
"description": "Turn auxiliary heater on/off for climate device.",
"fields": {
"aux_heat": {
"name": "Auxiliary heating",
"description": "New value of auxiliary heater.",
"required": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_temperature": {
"name": "Set temperature",
"description": "Set target temperature of climate device.",
"fields": {
"temperature": {
"name": "Temperature",
"description": "New target temperature for HVAC.",
"selector": {
"number": {
"min": 0,
"max": 250,
"step": 0.1,
"mode": "box"
}
}
},
"target_temp_high": {
"name": "Target temperature high",
"description": "New target high temperature for HVAC.",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 250,
"step": 0.1,
"mode": "box"
}
}
},
"target_temp_low": {
"name": "Target temperature low",
"description": "New target low temperature for HVAC.",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 250,
"step": 0.1,
"mode": "box"
}
}
},
"hvac_mode": {
"name": "HVAC mode",
"description": "HVAC operation mode to set temperature to.",
"selector": {
"select": {
"options": [
{
"label": "Off",
"value": "off"
},
{
"label": "Auto",
"value": "auto"
},
{
"label": "Cool",
"value": "cool"
},
{
"label": "Dry",
"value": "dry"
},
{
"label": "Fan Only",
"value": "fan_only"
},
{
"label": "Heat/Cool",
"value": "heat_cool"
},
{
"label": "Heat",
"value": "heat"
}
]
}
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_humidity": {
"name": "Set target humidity",
"description": "Set target humidity of climate device.",
"fields": {
"humidity": {
"name": "Humidity",
"description": "New target humidity for climate device.",
"required": true,
"selector": {
"number": {
"min": 30,
"max": 99,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_fan_mode": {
"name": "Set fan mode",
"description": "Set fan operation for climate device.",
"fields": {
"fan_mode": {
"name": "Fan mode",
"description": "New value of fan mode.",
"required": true,
"example": "low",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
},
"set_swing_mode": {
"name": "Set swing mode",
"description": "Set swing operation for climate device.",
"fields": {
"swing_mode": {
"name": "Swing mode",
"description": "New value of swing mode.",
"required": true,
"example": "horizontal",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "climate"
}
}
}
},
"device_tracker": {
"see": {
"name": "See",
"description": "Control tracked device.",
"fields": {
"mac": {
"name": "MAC address",
"description": "MAC address of device",
"example": "FF:FF:FF:FF:FF:FF",
"selector": {
"text": null
}
},
"dev_id": {
"name": "Device ID",
"description": "Id of device (find id in known_devices.yaml).",
"example": "phonedave",
"selector": {
"text": null
}
},
"host_name": {
"name": "Host name",
"description": "Hostname of device",
"example": "Dave",
"selector": {
"text": null
}
},
"location_name": {
"name": "Location name",
"description": "Name of location where device is located (not_home is away).",
"example": "home",
"selector": {
"text": null
}
},
"gps": {
"name": "GPS coordinates",
"description": "GPS coordinates where device is located (latitude, longitude).",
"example": "[51.509802, -0.086692]",
"selector": {
"object": null
}
},
"gps_accuracy": {
"name": "GPS accuracy",
"description": "Accuracy of GPS coordinates.",
"selector": {
"number": {
"min": 1,
"max": 100,
"unit_of_measurement": "%"
}
}
},
"battery": {
"name": "Battery level",
"description": "Battery level of device.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
}
}
},
"button": {
"press": {
"name": "Press",
"description": "Press the button entity.",
"fields": {},
"target": {
"entity": {
"domain": "button"
}
}
}
},
"siren": {
"turn_on": {
"name": "",
"description": "Turn siren on.",
"fields": {
"tone": {
"description": "The tone to emit when turning the siren on. When `available_tones` property is a map, either the key or the value can be used. Must be supported by the integration.",
"example": "fire",
"required": false,
"selector": {
"text": null
}
},
"volume_level": {
"description": "The volume level of the noise to emit when turning the siren on. Must be supported by the integration.",
"example": 0.5,
"required": false,
"selector": {
"number": {
"min": 0,
"max": 1,
"step": 0.05
}
}
},
"duration": {
"description": "The duration in seconds of the noise to emit when turning the siren on. Must be supported by the integration.",
"example": 15,
"required": false,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "siren"
}
}
},
"turn_off": {
"name": "",
"description": "Turn siren off.",
"fields": {},
"target": {
"entity": {
"domain": "siren"
}
}
},
"toggle": {
"name": "",
"description": "Toggles a siren.",
"fields": {},
"target": {
"entity": {
"domain": "siren"
}
}
}
},
"fan": {
"turn_on": {
"name": "Turn on",
"description": "Turn fan on.",
"fields": {
"speed": {
"name": "Speed",
"description": "Speed setting.",
"example": "high",
"selector": {
"text": null
}
},
"percentage": {
"name": "Percentage",
"description": "Percentage speed setting.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
},
"preset_mode": {
"name": "Preset mode",
"description": "Preset mode setting.",
"example": "auto",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn fan off.",
"fields": {},
"target": {
"entity": {
"domain": "fan"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggle the fan on/off.",
"fields": {},
"target": {
"entity": {
"domain": "fan"
}
}
},
"increase_speed": {
"name": "Increase speed",
"description": "Increase the speed of the fan by one speed or a percentage_step.",
"fields": {
"percentage_step": {
"advanced": true,
"required": false,
"description": "Increase speed by a percentage.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"decrease_speed": {
"name": "Decrease speed",
"description": "Decrease the speed of the fan by one speed or a percentage_step.",
"fields": {
"percentage_step": {
"advanced": true,
"required": false,
"description": "Decrease speed by a percentage.",
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"oscillate": {
"name": "Oscillate",
"description": "Oscillate the fan.",
"fields": {
"oscillating": {
"name": "Oscillating",
"description": "Flag to turn on/off oscillation.",
"required": true,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"set_direction": {
"name": "Set direction",
"description": "Set the fan rotation.",
"fields": {
"direction": {
"name": "Direction",
"description": "The direction to rotate.",
"required": true,
"selector": {
"select": {
"options": [
{
"label": "Forward",
"value": "forward"
},
{
"label": "Reverse",
"value": "reverse"
}
]
}
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"set_percentage": {
"name": "Set speed percentage",
"description": "Set fan speed percentage.",
"fields": {
"percentage": {
"name": "Percentage",
"description": "Percentage speed setting.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
},
"set_preset_mode": {
"name": "Set preset mode",
"description": "Set preset mode for a fan device.",
"fields": {
"preset_mode": {
"name": "Preset mode",
"description": "New value of preset mode.",
"required": true,
"example": "auto",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "fan"
}
}
}
},
"lock": {
"unlock": {
"name": "Unlock",
"description": "Unlock all or specified locks.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to unlock the lock with.",
"example": 1234,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "lock"
}
}
},
"lock": {
"name": "Lock",
"description": "Lock all or specified locks.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to lock the lock with.",
"example": 1234,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "lock"
}
}
},
"open": {
"name": "Open",
"description": "Open all or specified locks.",
"fields": {
"code": {
"name": "Code",
"description": "An optional code to open the lock with.",
"example": 1234,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "lock"
}
}
}
},
"text": {
"set_value": {
"name": "Set value",
"description": "Set value of a text entity.",
"fields": {
"value": {
"name": "Value",
"description": "Value to set.",
"required": true,
"example": "Hello world!",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "text"
}
}
}
},
"update": {
"install": {
"name": "Install update",
"description": "Install an update for this device or service",
"fields": {
"version": {
"name": "Version",
"description": "Version to install, if omitted, the latest version will be installed.",
"required": false,
"example": "1.0.0",
"selector": {
"text": null
}
},
"backup": {
"name": "Backup",
"description": "Backup before installing the update, if supported by the integration.",
"required": false,
"selector": {
"boolean": null
}
}
},
"target": {
"entity": {
"domain": "update"
}
}
},
"skip": {
"name": "Skip update",
"description": "Mark currently available update as skipped.",
"fields": {},
"target": {
"entity": {
"domain": "update"
}
}
},
"clear_skipped": {
"name": "Clear skipped update",
"description": "Removes the skipped version marker from an update.",
"fields": {},
"target": {
"entity": {
"domain": "update"
}
}
}
},
"cover": {
"open_cover": {
"name": "Open",
"description": "Open all or specified cover.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"close_cover": {
"name": "Close",
"description": "Close all or specified cover.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"set_cover_position": {
"name": "Set position",
"description": "Move to specific position all or specified cover.",
"fields": {
"position": {
"name": "Position",
"description": "Position of the cover",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "cover"
}
}
},
"stop_cover": {
"name": "Stop",
"description": "Stop all or specified cover.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggle a cover open/closed.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"open_cover_tilt": {
"name": "Open tilt",
"description": "Open all or specified cover tilt.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"close_cover_tilt": {
"name": "Close tilt",
"description": "Close all or specified cover tilt.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"stop_cover_tilt": {
"name": "Stop tilt",
"description": "Stop all or specified cover.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
},
"set_cover_tilt_position": {
"name": "Set tilt position",
"description": "Move to specific position all or specified cover tilt.",
"fields": {
"tilt_position": {
"name": "Tilt position",
"description": "Tilt position of the cover.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "cover"
}
}
},
"toggle_cover_tilt": {
"name": "Toggle tilt",
"description": "Toggle a cover tilt open/closed.",
"fields": {},
"target": {
"entity": {
"domain": "cover"
}
}
}
},
"humidifier": {
"turn_on": {
"name": "Turn on",
"description": "Turn humidifier device on.",
"fields": {},
"target": {
"entity": {
"domain": "humidifier"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn humidifier device off.",
"fields": {},
"target": {
"entity": {
"domain": "humidifier"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggles a humidifier device.",
"fields": {},
"target": {
"entity": {
"domain": "humidifier"
}
}
},
"set_mode": {
"name": "Set mode",
"description": "Set mode for humidifier device.",
"fields": {
"mode": {
"description": "New mode",
"required": true,
"example": "away",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "humidifier"
}
}
},
"set_humidity": {
"name": "Set humidity",
"description": "Set target humidity of humidifier device.",
"fields": {
"humidity": {
"description": "New target humidity for humidifier device.",
"required": true,
"selector": {
"number": {
"min": 0,
"max": 100,
"unit_of_measurement": "%"
}
}
}
},
"target": {
"entity": {
"domain": "humidifier"
}
}
}
},
"number": {
"set_value": {
"name": "Set",
"description": "Set the value of a Number entity.",
"fields": {
"value": {
"name": "Value",
"description": "The target value the entity should be set to.",
"example": 42,
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "number"
}
}
}
},
"select": {
"select_option": {
"name": "Select",
"description": "Select an option of an select entity.",
"fields": {
"option": {
"name": "Option",
"description": "Option to be selected.",
"required": true,
"example": "\"Item A\"",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "select"
}
}
}
},
"elgato": {
"identify": {
"name": "Identify",
"description": "Identify an Elgato Light. Blinks the light, which can be useful for, e.g., a visual notification.",
"fields": {},
"target": {
"entity": {
"integration": "elgato",
"domain": "light"
}
}
}
},
"camera": {
"enable_motion_detection": {
"name": "Enable motion detection",
"description": "Enable the motion detection in a camera.",
"fields": {},
"target": {
"entity": {
"domain": "camera"
}
}
},
"disable_motion_detection": {
"name": "Disable motion detection",
"description": "Disable the motion detection in a camera.",
"fields": {},
"target": {
"entity": {
"domain": "camera"
}
}
},
"turn_off": {
"name": "Turn off",
"description": "Turn off camera.",
"fields": {},
"target": {
"entity": {
"domain": "camera"
}
}
},
"turn_on": {
"name": "Turn on",
"description": "Turn on camera.",
"fields": {},
"target": {
"entity": {
"domain": "camera"
}
}
},
"snapshot": {
"name": "Take snapshot",
"description": "Take a snapshot from a camera.",
"fields": {
"filename": {
"name": "Filename",
"description": "Template of a Filename. Variable is entity_id.",
"required": true,
"example": "/tmp/snapshot_{{ entity_id.name }}.jpg",
"selector": {
"text": null
}
}
},
"target": {
"entity": {
"domain": "camera"
}
}
},
"play_stream": {
"name": "Play stream",
"description": "Play camera stream on supported media player.",
"fields": {
"media_player": {
"name": "Media Player",
"description": "Name(s) of media player to stream to.",
"required": true,
"selector": {
"entity": {
"domain": "media_player"
}
}
},
"format": {
"name": "Format",
"description": "Stream format supported by media player.",
"default": "hls",
"selector": {
"select": {
"options": [
"hls"
]
}
}
}
},
"target": {
"entity": {
"domain": "camera"
}
}
},
"record": {
"name": "Record",
"description": "Record live camera feed.",
"fields": {
"filename": {
"name": "Filename",
"description": "Template of a Filename. Variable is entity_id. Must be mp4.",
"required": true,
"example": "/tmp/snapshot_{{ entity_id.name }}.mp4",
"selector": {
"text": null
}
},
"duration": {
"name": "Duration",
"description": "Target recording length.",
"default": 30,
"selector": {
"number": {
"min": 1,
"max": 3600,
"unit_of_measurement": "seconds"
}
}
},
"lookback": {
"name": "Lookback",
"description": "Target lookback period to include in addition to duration. Only available if there is currently an active HLS stream.",
"default": 0,
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
}
},
"target": {
"entity": {
"domain": "camera"
}
}
}
},
"rest": {
"reload": {
"name": "Reload",
"description": "Reload all rest entities and notify services",
"fields": {}
}
},
"switch": {
"turn_off": {
"name": "Turn off",
"description": "Turn a switch off",
"fields": {},
"target": {
"entity": {
"domain": "switch"
}
}
},
"turn_on": {
"name": "Turn on",
"description": "Turn a switch on",
"fields": {},
"target": {
"entity": {
"domain": "switch"
}
}
},
"toggle": {
"name": "Toggle",
"description": "Toggles a switch state",
"fields": {},
"target": {
"entity": {
"domain": "switch"
}
}
}
},
"home_connect": {
"set_option_active": {
"name": "Set active program option",
"description": "Sets an option for the active program.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
},
"key": {
"name": "Key",
"description": "Key of the option.",
"example": "LaundryCare.Dryer.Option.DryingTarget",
"required": true,
"selector": {
"text": null
}
},
"value": {
"name": "Value",
"description": "Value of the option.",
"example": "LaundryCare.Dryer.EnumType.DryingTarget.IronDry",
"required": true,
"selector": {
"object": null
}
}
}
},
"set_option_selected": {
"name": "Set selected program option",
"description": "Sets an option for the selected program.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
},
"key": {
"name": "Key",
"description": "Key of the option.",
"example": "LaundryCare.Dryer.Option.DryingTarget",
"required": true,
"selector": {
"text": null
}
},
"value": {
"name": "Value",
"description": "Value of the option.",
"example": "LaundryCare.Dryer.EnumType.DryingTarget.IronDry",
"required": true,
"selector": {
"object": null
}
}
}
},
"change_setting": {
"name": "Change setting",
"description": "Changes a setting.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
},
"key": {
"name": "Key",
"description": "Key of the setting.",
"example": "BSH.Common.Setting.ChildLock",
"required": true,
"selector": {
"text": null
}
},
"value": {
"name": "Value",
"description": "Value of the setting.",
"example": "true",
"required": true,
"selector": {
"object": null
}
}
}
},
"pause_program": {
"name": "Pause program",
"description": "Pauses the current running program.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
}
}
},
"resume_program": {
"name": "Resume program",
"description": "Resumes a paused program.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
}
}
},
"select_program": {
"name": "Select program",
"description": "Selects a program without starting it.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
},
"program": {
"name": "Program",
"description": "Program to select",
"example": "Dishcare.Dishwasher.Program.Auto2",
"required": true,
"selector": {
"text": null
}
},
"key": {
"name": "Option key",
"description": "Key of the option.",
"example": "BSH.Common.Option.StartInRelative",
"selector": {
"text": null
}
},
"value": {
"name": "Option value",
"description": "Value of the option.",
"example": 1800,
"selector": {
"object": null
}
},
"unit": {
"name": "Option unit",
"description": "Unit for the option.",
"example": "seconds",
"selector": {
"text": null
}
}
}
},
"start_program": {
"name": "Start program",
"description": "Selects a program and starts it.",
"fields": {
"device_id": {
"name": "Device ID",
"description": "Id of the device.",
"required": true,
"selector": {
"device": {
"integration": "home_connect"
}
}
},
"program": {
"name": "Program",
"description": "Program to select",
"example": "Dishcare.Dishwasher.Program.Auto2",
"required": true,
"selector": {
"text": null
}
},
"key": {
"name": "Option key",
"description": "Key of the option.",
"example": "BSH.Common.Option.StartInRelative",
"selector": {
"text": null
}
},
"value": {
"name": "Option value",
"description": "Value of the option.",
"example": 1800,
"selector": {
"object": null
}
},
"unit": {
"name": "Option unit",
"description": "Unit for the option.",
"example": "seconds",
"selector": {
"text": null
}
}
}
}
},
"notify": {
"persistent_notification": {
"name": "Send a persistent notification",
"description": "Sends a notification that is visible in the front-end.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification.",
"required": true,
"example": "The garage door has been open for 10 minutes.",
"selector": {
"text": null
}
},
"title": {
"name": "Title",
"description": "Title for your notification.",
"example": "Your Garage Door Friend",
"selector": {
"text": null
}
}
}
},
"mobile_app_sm_g991b": {
"name": "Send a notification via mobile_app_sm_g991b",
"description": "Sends a notification message using the mobile_app_sm_g991b integration.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification.",
"required": true,
"example": "The garage door has been open for 10 minutes.",
"selector": {
"text": null
}
},
"title": {
"name": "Title",
"description": "Title for your notification.",
"example": "Your Garage Door Friend",
"selector": {
"text": null
}
},
"target": {
"name": "Target",
"description": "An array of targets to send the notification to. Optional depending on the platform.",
"example": "platform specific",
"selector": {
"object": null
}
},
"data": {
"name": "Data",
"description": "Extended information for notification. Optional depending on the platform.",
"example": "platform specific",
"selector": {
"object": null
}
}
}
},
"notify": {
"name": "Send a notification with notify",
"description": "Sends a notification message using the notify service.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification.",
"required": true,
"example": "The garage door has been open for 10 minutes.",
"selector": {
"text": null
}
},
"title": {
"name": "Title",
"description": "Title for your notification.",
"example": "Your Garage Door Friend",
"selector": {
"text": null
}
},
"target": {
"name": "Target",
"description": "An array of targets to send the notification to. Optional depending on the platform.",
"example": "platform specific",
"selector": {
"object": null
}
},
"data": {
"name": "Data",
"description": "Extended information for notification. Optional depending on the platform.",
"example": "platform specific",
"selector": {
"object": null
}
}
}
}
},
"hue": {
"activate_scene": {
"name": "Activate Hue Scene",
"description": "Activate a Hue scene with more control over the options.",
"fields": {
"transition": {
"name": "Transition",
"description": "Transition duration it takes to bring devices to the state defined in the scene.",
"selector": {
"number": {
"min": 0,
"max": 300,
"unit_of_measurement": "seconds"
}
}
},
"dynamic": {
"name": "Dynamic",
"description": "Enable dynamic mode of the scene.",
"selector": {
"boolean": null
}
},
"speed": {
"name": "Speed",
"description": "Speed of dynamic palette for this scene",
"advanced": true,
"selector": {
"number": {
"min": 0,
"max": 100
}
}
},
"brightness": {
"name": "Brightness",
"description": "Set brightness for the scene.",
"advanced": true,
"selector": {
"number": {
"min": 1,
"max": 255
}
}
}
},
"target": {
"entity": {
"domain": "scene",
"integration": "hue"
}
}
},
"hue_activate_scene": {
"name": "Activate scene",
"description": "Activate a hue scene stored in the hue hub.",
"fields": {
"group_name": {
"name": "Group",
"description": "Name of hue group/room from the hue app.",
"example": "Living Room",
"selector": {
"text": null
}
},
"scene_name": {
"name": "Scene",
"description": "Name of hue scene from the hue app.",
"example": "Energize",
"selector": {
"text": null
}
},
"dynamic": {
"name": "Dynamic",
"description": "Enable dynamic mode of the scene (V2 bridges and supported scenes only).",
"selector": {
"boolean": null
}
}
}
}
},
"tts": {
"google_translate_say": {
"name": "Say a TTS message with google_translate",
"description": "Say something using text-to-speech on a media player with google_translate.",
"fields": {
"entity_id": {
"name": "Entity",
"description": "Name(s) of media player entities.",
"required": true,
"selector": {
"entity": {
"domain": "media_player"
}
}
},
"message": {
"name": "Message",
"description": "Text to speak on devices.",
"example": "My name is hanna",
"required": true,
"selector": {
"text": null
}
},
"cache": {
"name": "Cache",
"description": "Control file cache of this message.",
"default": false,
"selector": {
"boolean": null
}
},
"language": {
"name": "Language",
"description": "Language to use for speech generation.",
"example": "ru",
"selector": {
"text": null
}
},
"options": {
"name": "Options",
"description": "A dictionary containing platform-specific options. Optional depending on the platform.",
"advanced": true,
"example": "platform specific",
"selector": {
"object": null
}
}
}
},
"clear_cache": {
"name": "Clear TTS cache",
"description": "Remove all text-to-speech cache files and RAM cache.",
"fields": {}
}
},
"backup": {
"create": {
"name": "Create backup",
"description": "Create a new backup.",
"fields": {}
}
},
"unifi": {
"reconnect_client": {
"name": "Reconnect wireless client",
"description": "Try to get wireless client to reconnect to UniFi Network",
"fields": {
"device_id": {
"name": "Device",
"description": "Try reconnect client to wireless network",
"required": true,
"selector": {
"device": {
"integration": "unifi"
}
}
}
}
},
"remove_clients": {
"name": "Remove clients from the UniFi Network",
"description": "Clean up clients that has only been associated with the controller for a short period of time.",
"fields": {}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink