AD-DA.ca
Sign in

AD-DA.ca, Home Assistant

Updated October 14, 2026

Description

Two-way control of Home Assistant from Q-SYS over the Home Assistant WebSocket API (ws or wss). State changes are pushed by Home Assistant, so the controls follow the entities without polling.

The plugin has five modes. One plugin in Server mode holds the connection to a Home Assistant instance. Any number of plugins in the other modes then select that Server:

  • Entity exposes the entities of one Home Assistant domain as Q-SYS controls.

  • Event listens to Home Assistant events and fires events.

  • MQTT subscribes and publishes to MQTT topics through the Home Assistant MQTT integration.

  • Assist sends text to the Home Assistant conversation agents and returns their answer.

The Server plugin must have its Script Access set to Script or All, otherwise the other modes cannot find it. Home Assistant needs a long-lived access token, created under Profile > Security. The Event and MQTT modes need the token of an administrator, and the MQTT mode needs the MQTT integration of Home Assistant.

Key Features

  • Push Feedback — Entities are subscribed on Home Assistant, every change reaches the controls as soon as it happens

  • One Connection — A single WebSocket per Home Assistant instance, shared by every plugin of the design

  • All Main Domains — Lights, switches, covers, climate, media players, numbers, selects, scenes, scripts, sensors and more, plus an Any Domain mode able to call any service

  • Only What Applies — Controls an entity does not support are disabled

  • Events and MQTT — Listen to and fire Home Assistant events, subscribe and publish to MQTT topics

  • Assist — Send a sentence to a conversation agent and read its answer

  • Hidden Token — The access token is kept in a hidden storage, the plugin only shows a mask

  • Self Healing — Automatic reconnection and resubscription, an invalid token is never retried

  • Smooth Faders — Knob movements are debounced (Knob Debounce property) and feedback is held while a fader is moving

Release Notes

2026-10 : 3.0.0.0

New Feature

  • Added the Server mode: WebSocket connection (ws / wss) to Home Assistant with a long-lived access token, automatic reconnection and entity list

  • Added the Entity mode: two-way control of the entities of one domain through a Server plugin, selected with setup_server

  • Added the Entity Domain property with 51 Home Assistant domains and Any Domain to call any service

  • Added the Entity Count property for 1 to 32 entities per plugin

  • Added entity_picture_preview_<n> to show the picture of media players, cameras and images

  • Added the Event mode to listen to Home Assistant events (event_type_<n>, event_select_<n>, event_filter_<n>, event_received_<n>, event_data_<n>) and to fire events (event_fire_<n>)

  • Added the MQTT mode to subscribe (mqtt_topic_<n>, mqtt_payload_<n>, mqtt_received_<n>) and publish (mqtt_publish_<n>) through the Home Assistant MQTT integration

  • Added the Assist mode to send text to a conversation agent (assist_text, assist_response)

  • Added the Event Count and Topic Count properties

  • Added a hidden storage for the access token, connection_token only shows a mask

  • Added entity_seek_<n> to media players and entity_transition_<n> to lights

  • Added the automatic disabling of the controls an entity does not support

  • Added the Knob Debounce property to send only the value a knob settles on

  • Added entity_state_<n>, entity_name_<n>, entity_available_<n> and entity_attributes_<n> on every entity

Properties

License

Type: string
Default Value: (empty)
Description: License key of the primary Core. Only in Server mode.

License Backup

Type: string
Default Value: (empty)
Description: License key of the backup Core. Only in Server mode.

Mode

Type: enum
Choices: Server, Entity, Event, MQTT, Assist
Default Value: Server
Description: Server connects to Home Assistant. The other modes work through a Server plugin.

Entity Domain

Type: enum
Choices: see Domains below
Default Value: Light
Description: Home Assistant domain of the entities controlled by this plugin. Only in Entity mode.

Entity Count

Type: integer
Min: 1
Max: 32
Default Value: 1
Description: Number of entities on the Controls page. Only in Entity mode.

Event Count

Type: integer
Min: 1
Max: 32
Default Value: 4
Description: Number of events on the Controls page. Only in Event mode.

Topic Count

Type: integer
Min: 1
Max: 32
Default Value: 4
Description: Number of MQTT topics on the Controls page. Only in MQTT mode.

Knob Debounce

Type: boolean
Default Value: true
Description: When enabled, a knob sends only the value it settles on, 0.1 s after its last movement. When disabled, every movement is sent to Home Assistant. Only in Entity mode.

Debug Print

Type: enum
Choices: None, RX, TX, RX/TX, Function Calls, All
Default Value: None
Description: Prints debug messages to the plugin's debug output. The access token is never printed.

Controls

Every page starts with the same header: the plugin title, the build version, the logo and the Status. The title tells which plugin it is: Home Assistant - followed by the mode, or by the Entity Domain in Entity mode, for example Home Assistant - Server, Home Assistant - Light or Home Assistant - MQTT.

Status

Controls name: Status
Type: Indicator-Status
Pin Style: Output
Pin Name: Status
Description: Displays the plugin's operational status.

OK

Compromised - Entities #2 require attention

Fault - Access token refused by Home Assistant

Setup page of the Server with the access token refused by Home Assistant
Controls page of a Light plugin whose second entity does not exist on Home Assistant

Server Mode

Setup Page

Setup page of the Server, connected to Home Assistant

Connection

Protocol

Controls name: connection_protocol
Type: Text (combo box)
Pin Style: Input / Output
Pin Name: Connection~Protocol
Description: ws or wss.

Host

Controls name: connection_host
Type: Text
Pin Style: Input / Output
Pin Name: Connection~Host
Description: IP address or host name of Home Assistant.

Port

Controls name: connection_port
Type: Knob-Integer
Pin Style: Input / Output
Pin Name: Connection~Port
Description: TCP port, 8123 by default.

Token

Controls name: connection_token
Type: Text
Pin Style: Input / Output
Pin Name: Connection~Token
Description: Long-lived access token. Once entered, the token moves to a hidden storage and the field only shows ****************. Type a new token over the mask to replace it, or clear the field to remove it.

Changing any connection control reconnects at once. A refused token is not retried until the token changes or Reconnect is pressed, because Home Assistant bans addresses after repeated failures.

Connected

Controls name: connection_connected
Type: Indicator-Led
Pin Style: Output
Pin Name: Connection~Connected
Description: On when the plugin is authenticated on Home Assistant.

Reconnect

Controls name: connection_reconnect
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Connection~Reconnect
Description: Closes the connection and opens it again.

Server Information

Version

Controls name: info_version
Type: Indicator-Text
Pin Style: Output
Pin Name: Information~Version
Description: Home Assistant version.

Location Name

Controls name: info_location
Type: Indicator-Text
Pin Style: Output
Pin Name: Information~Location Name
Description: Name of the Home Assistant instance.

Entities

Controls name: info_entities
Type: Indicator-Text
Pin Style: Output
Pin Name: Information~Entities
Description: Number of entities offered to the Entity plugins.

Refresh

Controls name: info_refresh
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Information~Refresh
Description: Reads the entity list again. Done automatically when the Home Assistant entity registry changes and when Home Assistant has finished starting.

Watched Entities

Controls name: info_watched
Type: Indicator-Text
Pin Style: Output
Pin Name: Information~Watched Entities
Description: Number of entities subscribed for the Entity plugins.

Last Error

Controls name: info_last_error
Type: Indicator-Text
Pin Style: Output
Pin Name: Information~Last Error
Description: Last error answered by Home Assistant, starting with the command or service that was called.

Entity Mode

Controls Page

Controls page of a Light plugin with two lights

One section per entity. <n> is the entity number and <Domain> the Entity Domain property.

Entity

Entity ID

Controls name: entity_id_<n>
Type: Text (combo box)
Pin Style: Input / Output
Pin Name: <Domain>~<n>~Entity ID
Description: Entity controlled by the section. The choices are the entities of the domain known by the Server. The first choice, (None), is always present and clears the selection.

Available

Controls name: entity_available_<n>
Type: Indicator-Led
Pin Style: Output
Pin Name: <Domain>~<n>~Available
Description: On when the Server is connected and the entity is not unavailable. The controls of the entity are disabled otherwise.

Friendly Name

Controls name: entity_name_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: <Domain>~<n>~Friendly Name
Description: Friendly name of the entity, read only.

State

Controls name: entity_state_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: <Domain>~<n>~State
Description: Raw state of the entity.

Attributes

Controls name: entity_attributes_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: <Domain>~<n>~Attributes
Description: Every attribute of the entity, as JSON.

A selected entity is never cleared by the plugin. When it does not exist on Home Assistant the Status reports its number.

Domains

The controls between State and Attributes depend on the Entity Domain property.

A control the selected entity does not support is disabled: for example the color controls of a light that only dims, or the single target temperature of a thermostat working with a low / high range. The plugin reads this from the supported_features and supported_color_modes attributes; an entity that does not publish them keeps every control.

Fields described as local are not sent when they change. Set them first, then use the action of the same entity.

Any Domain

Controls page of an Any Domain plugin with a custom service call

Home Assistant domain: any, the entity list shows every domain

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_turn_on_<n>

Button-Trigger

Input / Output

Any Domain~<n>~Turn On

Calls homeassistant.turn_on.

entity_turn_off_<n>

Button-Trigger

Input / Output

Any Domain~<n>~Turn Off

Calls homeassistant.turn_off.

entity_toggle_<n>

Button-Trigger

Input / Output

Any Domain~<n>~Toggle

Calls homeassistant.toggle.

entity_on_<n>

Indicator-Led

Output

Any Domain~<n>~On

On when the state is on.

entity_value_<n>

Knob-Float

Output

Any Domain~<n>~Value

Shows the state.

entity_changed_<n>

Button-Trigger

Output

Any Domain~<n>~Changed

Triggers each time the state changes to a new value.

entity_service_<n>

Text

Input / Output

Any Domain~<n>~Service

Local field, sent with the actions of the entity.

entity_service_data_<n>

Text

Input / Output

Any Domain~<n>~Service Data

Local field, sent with the actions of the entity.

entity_call_<n>

Button-Trigger

Input / Output

Any Domain~<n>~Call

Calls the service typed in Service with the JSON of Service Data.

Alarm Control Panel

Controls page of an Alarm Control Panel plugin, armed away

Home Assistant domain: alarm_control_panel

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_code_<n>

Text

Input / Output

Alarm Control Panel~<n>~Code

Local field, sent with the actions of the entity.

entity_disarm_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Disarm

Calls alarm_control_panel.alarm_disarm with code.

entity_arm_home_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Arm Home

Calls alarm_control_panel.alarm_arm_home with code.

entity_arm_away_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Arm Away

Calls alarm_control_panel.alarm_arm_away with code.

entity_arm_night_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Arm Night

Calls alarm_control_panel.alarm_arm_night with code.

entity_arm_vacation_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Arm Vacation

Calls alarm_control_panel.alarm_arm_vacation with code.

entity_arm_bypass_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Arm Bypass

Calls alarm_control_panel.alarm_arm_custom_bypass with code.

entity_trigger_<n>

Button-Trigger

Input / Output

Alarm Control Panel~<n>~Trigger

Calls alarm_control_panel.alarm_trigger with code.

entity_armed_<n>

Indicator-Led

Output

Alarm Control Panel~<n>~Armed

On when the state is armed_home / armed_away / armed_night / armed_vacation / armed_custom_bypass.

entity_pending_<n>

Indicator-Led

Output

Alarm Control Panel~<n>~Pending

On when the state is pending / arming / disarming.

entity_triggered_<n>

Indicator-Led

Output

Alarm Control Panel~<n>~Triggered

On when the state is triggered.

Alert

Home Assistant domain: alert

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Alert~<n>~Power

Follows the state, calls alert.turn_on / alert.turn_off.

entity_firing_<n>

Indicator-Led

Output

Alert~<n>~Firing

On when the state is on.

Assist Satellite

Home Assistant domain: assist_satellite

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_message_<n>

Text

Input / Output

Assist Satellite~<n>~Message

Local field, sent with the actions of the entity.

entity_announce_<n>

Button-Trigger

Input / Output

Assist Satellite~<n>~Announce

Calls assist_satellite.announce with message.

entity_busy_<n>

Indicator-Led

Output

Assist Satellite~<n>~Busy

On when the state is listening / processing / responding.

Automation

Home Assistant domain: automation

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Automation~<n>~Power

Follows the state, calls automation.turn_on / automation.turn_off.

entity_trigger_<n>

Button-Trigger

Input / Output

Automation~<n>~Trigger

Calls automation.trigger.

entity_last_triggered_<n>

Indicator-Text

Output

Automation~<n>~Last Triggered

Shows the attribute last_triggered.

entity_triggered_<n>

Button-Trigger

Output

Automation~<n>~Triggered

Triggers each time the attribute last_triggered changes to a new value.

Binary Sensor

Home Assistant domain: binary_sensor

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_on_<n>

Indicator-Led

Output

Binary Sensor~<n>~On

On when the state is on.

entity_device_class_<n>

Indicator-Text

Output

Binary Sensor~<n>~Device Class

Shows the attribute device_class.

Button

Home Assistant domain: button

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_press_<n>

Button-Trigger

Input / Output

Button~<n>~Press

Calls button.press.

entity_pressed_<n>

Button-Trigger

Output

Button~<n>~Pressed

Triggers each time the state changes to a new value.

Calendar

Home Assistant domain: calendar

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_on_<n>

Indicator-Led

Output

Calendar~<n>~On

On when the state is on.

entity_message_<n>

Indicator-Text

Output

Calendar~<n>~Message

Shows the attribute message.

entity_description_<n>

Indicator-Text

Output

Calendar~<n>~Description

Shows the attribute description.

entity_location_<n>

Indicator-Text

Output

Calendar~<n>~Location

Shows the attribute location.

entity_start_time_<n>

Indicator-Text

Output

Calendar~<n>~Start Time

Shows the attribute start_time.

entity_end_time_<n>

Indicator-Text

Output

Calendar~<n>~End Time

Shows the attribute end_time.

entity_all_day_<n>

Indicator-Led

Output

Calendar~<n>~All Day

On when the attribute all_day is true.

Camera

Controls page of a Camera plugin with its picture preview

Home Assistant domain: camera

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Camera~<n>~Power

Follows the state, calls camera.turn_on / camera.turn_off.

entity_motion_detection_<n>

Button-Toggle

Input / Output

Camera~<n>~Motion Detection

Follows the attribute motion_detection, calls camera.enable_motion_detection / camera.disable_motion_detection.

entity_recording_<n>

Indicator-Led

Output

Camera~<n>~Recording

On when the state is recording.

entity_streaming_<n>

Indicator-Led

Output

Camera~<n>~Streaming

On when the state is streaming.

entity_picture_<n>

Indicator-Text

Output

Camera~<n>~Picture

Shows the attribute entity_picture.

entity_picture_preview_<n>

Button-Trigger

Output

Camera~<n>~Picture Preview

Shows the picture of the attribute entity_picture, downloaded from Home Assistant each time its URL changes.

Climate

Controls page of a Climate plugin in heat / cool mode

Home Assistant domain: climate

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Climate~<n>~Power

Follows the state, calls climate.turn_on / climate.turn_off.

entity_hvac_mode_<n>

Text (combo box)

Input / Output

Climate~<n>~Hvac Mode

Follows the state, calls climate.set_hvac_mode, choices from attribute hvac_modes.

entity_hvac_action_<n>

Indicator-Text

Output

Climate~<n>~Hvac Action

Shows the attribute hvac_action.

entity_current_temperature_<n>

Knob-Float

Output

Climate~<n>~Current Temperature

Shows the attribute current_temperature.

entity_temperature_<n>

Knob-Float

Input / Output

Climate~<n>~Temperature

Follows the attribute temperature, calls climate.set_temperature.

entity_target_low_<n>

Knob-Float

Input / Output

Climate~<n>~Target Low

Follows the attribute target_temp_low, calls climate.set_temperature.

entity_target_high_<n>

Knob-Float

Input / Output

Climate~<n>~Target High

Follows the attribute target_temp_high, calls climate.set_temperature.

entity_current_humidity_<n>

Knob-Float

Output

Climate~<n>~Current Humidity

Shows the attribute current_humidity.

entity_humidity_<n>

Knob-Percent

Input / Output

Climate~<n>~Humidity

Follows the attribute humidity, calls climate.set_humidity.

entity_fan_mode_<n>

Text (combo box)

Input / Output

Climate~<n>~Fan Mode

Follows the attribute fan_mode, calls climate.set_fan_mode, choices from attribute fan_modes.

entity_preset_mode_<n>

Text (combo box)

Input / Output

Climate~<n>~Preset Mode

Follows the attribute preset_mode, calls climate.set_preset_mode, choices from attribute preset_modes.

entity_swing_mode_<n>

Text (combo box)

Input / Output

Climate~<n>~Swing Mode

Follows the attribute swing_mode, calls climate.set_swing_mode, choices from attribute swing_modes.

Counter

Home Assistant domain: counter

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Counter~<n>~Value

Follows the state, calls counter.set_value.

entity_decrement_<n>

Button-Trigger

Input / Output

Counter~<n>~Decrement

Calls counter.decrement.

entity_increment_<n>

Button-Trigger

Input / Output

Counter~<n>~Increment

Calls counter.increment.

entity_reset_<n>

Button-Trigger

Input / Output

Counter~<n>~Reset

Calls counter.reset.

Cover

Controls page of a Cover plugin with position and tilt

Home Assistant domain: cover

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_open_<n>

Button-Trigger

Input / Output

Cover~<n>~Open

Calls cover.open_cover.

entity_stop_<n>

Button-Trigger

Input / Output

Cover~<n>~Stop

Calls cover.stop_cover.

entity_close_<n>

Button-Trigger

Input / Output

Cover~<n>~Close

Calls cover.close_cover.

entity_position_<n>

Knob-Percent

Input / Output

Cover~<n>~Position

Follows the attribute current_position, calls cover.set_cover_position.

entity_tilt_open_<n>

Button-Trigger

Input / Output

Cover~<n>~Tilt Open

Calls cover.open_cover_tilt.

entity_tilt_stop_<n>

Button-Trigger

Input / Output

Cover~<n>~Tilt Stop

Calls cover.stop_cover_tilt.

entity_tilt_close_<n>

Button-Trigger

Input / Output

Cover~<n>~Tilt Close

Calls cover.close_cover_tilt.

entity_tilt_position_<n>

Knob-Percent

Input / Output

Cover~<n>~Tilt Position

Follows the attribute current_tilt_position, calls cover.set_cover_tilt_position.

entity_is_open_<n>

Indicator-Led

Output

Cover~<n>~Is Open

On when the state is open / opening.

entity_moving_<n>

Indicator-Led

Output

Cover~<n>~Moving

On when the state is opening / closing.

Date

Home Assistant domain: date

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Date~<n>~Value

Follows the state, calls date.set_value.

Datetime

Home Assistant domain: datetime

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Datetime~<n>~Value

Follows the state, calls datetime.set_value.

Device Tracker

Home Assistant domain: device_tracker

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_home_<n>

Indicator-Led

Output

Device Tracker~<n>~Home

On when the state is home.

entity_source_type_<n>

Indicator-Text

Output

Device Tracker~<n>~Source Type

Shows the attribute source_type.

entity_latitude_<n>

Indicator-Text

Output

Device Tracker~<n>~Latitude

Shows the attribute latitude.

entity_longitude_<n>

Indicator-Text

Output

Device Tracker~<n>~Longitude

Shows the attribute longitude.

Event

Home Assistant domain: event

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_event_type_<n>

Indicator-Text

Output

Event~<n>~Event Type

Shows the attribute event_type.

entity_fired_<n>

Button-Trigger

Output

Event~<n>~Fired

Triggers each time the state changes to a new value.

Fan

Home Assistant domain: fan

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Fan~<n>~Power

Follows the state, calls fan.turn_on / fan.turn_off.

entity_percentage_<n>

Knob-Percent

Input / Output

Fan~<n>~Percentage

Follows the attribute percentage, calls fan.set_percentage.

entity_decrease_speed_<n>

Button-Trigger

Input / Output

Fan~<n>~Decrease Speed

Calls fan.decrease_speed.

entity_increase_speed_<n>

Button-Trigger

Input / Output

Fan~<n>~Increase Speed

Calls fan.increase_speed.

entity_preset_mode_<n>

Text (combo box)

Input / Output

Fan~<n>~Preset Mode

Follows the attribute preset_mode, calls fan.set_preset_mode, choices from attribute preset_modes.

entity_oscillating_<n>

Button-Toggle

Input / Output

Fan~<n>~Oscillating

Follows the attribute oscillating, calls fan.oscillate.

entity_direction_<n>

Text (combo box)

Input / Output

Fan~<n>~Direction

Follows the attribute direction, calls fan.set_direction.

Group

Home Assistant domain: group

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Group~<n>~Power

Follows the state, calls homeassistant.turn_on / homeassistant.turn_off.

entity_members_<n>

Indicator-Text

Output

Group~<n>~Members

Shows the attribute entity_id.

Humidifier

Home Assistant domain: humidifier

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Humidifier~<n>~Power

Follows the state, calls humidifier.turn_on / humidifier.turn_off.

entity_humidity_<n>

Knob-Percent

Input / Output

Humidifier~<n>~Humidity

Follows the attribute humidity, calls humidifier.set_humidity.

entity_current_humidity_<n>

Knob-Float

Output

Humidifier~<n>~Current Humidity

Shows the attribute current_humidity.

entity_mode_<n>

Text (combo box)

Input / Output

Humidifier~<n>~Mode

Follows the attribute mode, calls humidifier.set_mode, choices from attribute available_modes.

entity_action_<n>

Indicator-Text

Output

Humidifier~<n>~Action

Shows the attribute action.

Image

Home Assistant domain: image

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_picture_<n>

Indicator-Text

Output

Image~<n>~Picture

Shows the attribute entity_picture.

entity_picture_preview_<n>

Button-Trigger

Output

Image~<n>~Picture Preview

Shows the picture of the attribute entity_picture, downloaded from Home Assistant each time its URL changes.

entity_updated_<n>

Button-Trigger

Output

Image~<n>~Updated

Triggers each time the state changes to a new value.

Input Boolean

Home Assistant domain: input_boolean

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Input Boolean~<n>~Power

Follows the state, calls input_boolean.turn_on / input_boolean.turn_off.

Input Button

Home Assistant domain: input_button

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_press_<n>

Button-Trigger

Input / Output

Input Button~<n>~Press

Calls input_button.press.

entity_pressed_<n>

Button-Trigger

Output

Input Button~<n>~Pressed

Triggers each time the state changes to a new value.

Input Datetime

Home Assistant domain: input_datetime

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Input Datetime~<n>~Value

Follows the state, calls input_datetime.set_datetime.

entity_has_date_<n>

Indicator-Led

Output

Input Datetime~<n>~Has Date

On when the attribute has_date is true.

entity_has_time_<n>

Indicator-Led

Output

Input Datetime~<n>~Has Time

On when the attribute has_time is true.

Input Number

Controls page of an Input Number plugin

Home Assistant domain: input_number

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Input Number~<n>~Value

Follows the state, calls input_number.set_value.

entity_level_<n>

Knob-Percent

Input / Output

Input Number~<n>~Level

Follows the state, calls input_number.set_value, scaled between the min and max attributes.

entity_unit_<n>

Indicator-Text

Output

Input Number~<n>~Unit

Shows the attribute unit_of_measurement.

Input Select

Controls page of an Input Select plugin

Home Assistant domain: input_select

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_option_<n>

Text (combo box)

Input / Output

Input Select~<n>~Option

Follows the state, calls input_select.select_option, choices from attribute options.

entity_previous_<n>

Button-Trigger

Input / Output

Input Select~<n>~Previous

Calls input_select.select_previous.

entity_next_<n>

Button-Trigger

Input / Output

Input Select~<n>~Next

Calls input_select.select_next.

Input Text

Home Assistant domain: input_text

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Input Text~<n>~Value

Follows the state, calls input_text.set_value.

Lawn Mower

Home Assistant domain: lawn_mower

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_start_<n>

Button-Trigger

Input / Output

Lawn Mower~<n>~Start

Calls lawn_mower.start_mowing.

entity_pause_<n>

Button-Trigger

Input / Output

Lawn Mower~<n>~Pause

Calls lawn_mower.pause.

entity_dock_<n>

Button-Trigger

Input / Output

Lawn Mower~<n>~Dock

Calls lawn_mower.dock.

entity_mowing_<n>

Indicator-Led

Output

Lawn Mower~<n>~Mowing

On when the state is mowing.

entity_docked_<n>

Indicator-Led

Output

Lawn Mower~<n>~Docked

On when the state is docked.

entity_error_<n>

Indicator-Led

Output

Lawn Mower~<n>~Error

On when the state is error.

Light

Controls page of a Light plugin whose second entity does not exist on Home Assistant

Home Assistant domain: light

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Light~<n>~Power

Follows the state, calls light.turn_on / light.turn_off.

entity_transition_<n>

Knob-Float

Input / Output

Light~<n>~Transition

Local field, sent with the actions of the entity when it is above 0.

entity_brightness_<n>

Knob-Percent

Input / Output

Light~<n>~Brightness

Follows the attribute brightness, calls light.turn_on.

entity_color_temp_<n>

Knob-Integer

Input / Output

Light~<n>~Color Temp

Follows the attribute color_temp_kelvin, calls light.turn_on.

entity_color_<n>

Text

Input / Output

Light~<n>~Color

Follows the attribute rgb_color, calls light.turn_on.

entity_effect_<n>

Text (combo box)

Input / Output

Light~<n>~Effect

Follows the attribute effect, calls light.turn_on, choices from attribute effect_list.

entity_color_mode_<n>

Indicator-Text

Output

Light~<n>~Color Mode

Shows the attribute color_mode.

Lock

Controls page of a Lock plugin, locked

Home Assistant domain: lock

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_code_<n>

Text

Input / Output

Lock~<n>~Code

Local field, sent with the actions of the entity.

entity_locked_<n>

Button-Toggle

Input / Output

Lock~<n>~Locked

Follows the state, calls lock.lock / lock.unlock.

entity_open_<n>

Button-Trigger

Input / Output

Lock~<n>~Open

Calls lock.open with code.

entity_jammed_<n>

Indicator-Led

Output

Lock~<n>~Jammed

On when the state is jammed.

Media Player

Controls page of a Media Player plugin playing, with seek and album art

Home Assistant domain: media_player

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Media Player~<n>~Power

Follows the state, calls media_player.turn_on / media_player.turn_off.

entity_previous_<n>

Button-Trigger

Input / Output

Media Player~<n>~Previous

Calls media_player.media_previous_track.

entity_play_<n>

Button-Trigger

Input / Output

Media Player~<n>~Play

Calls media_player.media_play.

entity_pause_<n>

Button-Trigger

Input / Output

Media Player~<n>~Pause

Calls media_player.media_pause.

entity_stop_<n>

Button-Trigger

Input / Output

Media Player~<n>~Stop

Calls media_player.media_stop.

entity_next_<n>

Button-Trigger

Input / Output

Media Player~<n>~Next

Calls media_player.media_next_track.

entity_playing_<n>

Indicator-Led

Output

Media Player~<n>~Playing

On when the state is playing.

entity_volume_<n>

Knob-Percent

Input / Output

Media Player~<n>~Volume

Follows the attribute volume_level, calls media_player.volume_set.

entity_volume_down_<n>

Button-Trigger

Input / Output

Media Player~<n>~Volume Down

Calls media_player.volume_down.

entity_volume_up_<n>

Button-Trigger

Input / Output

Media Player~<n>~Volume Up

Calls media_player.volume_up.

entity_mute_<n>

Button-Toggle

Input / Output

Media Player~<n>~Mute

Follows the attribute is_volume_muted, calls media_player.volume_mute.

entity_source_<n>

Text (combo box)

Input / Output

Media Player~<n>~Source

Follows the attribute source, calls media_player.select_source, choices from attribute source_list.

entity_sound_mode_<n>

Text (combo box)

Input / Output

Media Player~<n>~Sound Mode

Follows the attribute sound_mode, calls media_player.select_sound_mode, choices from attribute sound_mode_list.

entity_shuffle_<n>

Button-Toggle

Input / Output

Media Player~<n>~Shuffle

Follows the attribute shuffle, calls media_player.shuffle_set.

entity_repeat_<n>

Text (combo box)

Input / Output

Media Player~<n>~Repeat

Follows the attribute repeat, calls media_player.repeat_set.

entity_media_title_<n>

Indicator-Text

Output

Media Player~<n>~Media Title

Shows the attribute media_title.

entity_media_artist_<n>

Indicator-Text

Output

Media Player~<n>~Media Artist

Shows the attribute media_artist.

entity_media_album_<n>

Indicator-Text

Output

Media Player~<n>~Media Album

Shows the attribute media_album_name.

entity_media_position_<n>

Knob-Float

Output

Media Player~<n>~Media Position

Shows the attribute media_position.

entity_media_duration_<n>

Knob-Float

Output

Media Player~<n>~Media Duration

Shows the attribute media_duration.

entity_seek_<n>

Knob-Percent

Input / Output

Media Player~<n>~Seek

Position of the media as a percentage of its duration, calls media_player.media_seek.

entity_picture_<n>

Indicator-Text

Output

Media Player~<n>~Picture

Shows the attribute entity_picture.

entity_picture_preview_<n>

Button-Trigger

Output

Media Player~<n>~Picture Preview

Shows the picture of the attribute entity_picture, downloaded from Home Assistant each time its URL changes.

entity_media_id_<n>

Text

Input / Output

Media Player~<n>~Media Id

Local field, sent with the actions of the entity.

entity_media_type_<n>

Text

Input / Output

Media Player~<n>~Media Type

Local field, sent with the actions of the entity.

entity_play_media_<n>

Button-Trigger

Input / Output

Media Player~<n>~Play Media

Calls media_player.play_media with media_content_id, media_content_type.

Notify

Home Assistant domain: notify

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_title_<n>

Text

Input / Output

Notify~<n>~Title

Local field, sent with the actions of the entity.

entity_message_<n>

Text

Input / Output

Notify~<n>~Message

Local field, sent with the actions of the entity.

entity_send_<n>

Button-Trigger

Input / Output

Notify~<n>~Send

Calls notify.send_message with message, title.

Number

Home Assistant domain: number

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Number~<n>~Value

Follows the state, calls number.set_value.

entity_level_<n>

Knob-Percent

Input / Output

Number~<n>~Level

Follows the state, calls number.set_value, scaled between the min and max attributes.

entity_unit_<n>

Indicator-Text

Output

Number~<n>~Unit

Shows the attribute unit_of_measurement.

Person

Home Assistant domain: person

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_home_<n>

Indicator-Led

Output

Person~<n>~Home

On when the state is home.

entity_latitude_<n>

Indicator-Text

Output

Person~<n>~Latitude

Shows the attribute latitude.

entity_longitude_<n>

Indicator-Text

Output

Person~<n>~Longitude

Shows the attribute longitude.

Remote

Home Assistant domain: remote

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Remote~<n>~Power

Follows the state, calls remote.turn_on / remote.turn_off.

entity_activity_<n>

Text (combo box)

Input / Output

Remote~<n>~Activity

Follows the attribute current_activity, calls remote.turn_on, choices from attribute activity_list.

entity_device_<n>

Text

Input / Output

Remote~<n>~Device

Local field, sent with the actions of the entity.

entity_command_<n>

Text

Input / Output

Remote~<n>~Command

Local field, sent with the actions of the entity.

entity_send_<n>

Button-Trigger

Input / Output

Remote~<n>~Send

Calls remote.send_command with command, device.

Scene

Controls page of a Scene plugin

Home Assistant domain: scene

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_activate_<n>

Button-Trigger

Input / Output

Scene~<n>~Activate

Calls scene.turn_on.

entity_activated_<n>

Button-Trigger

Output

Scene~<n>~Activated

Triggers each time the state changes to a new value.

Script

Home Assistant domain: script

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_run_<n>

Button-Trigger

Input / Output

Script~<n>~Run

Calls script.turn_on.

entity_stop_<n>

Button-Trigger

Input / Output

Script~<n>~Stop

Calls script.turn_off.

entity_running_<n>

Indicator-Led

Output

Script~<n>~Running

On when the state is on.

Select

Home Assistant domain: select

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_option_<n>

Text (combo box)

Input / Output

Select~<n>~Option

Follows the state, calls select.select_option, choices from attribute options.

entity_previous_<n>

Button-Trigger

Input / Output

Select~<n>~Previous

Calls select.select_previous.

entity_next_<n>

Button-Trigger

Input / Output

Select~<n>~Next

Calls select.select_next.

Sensor

Controls page of a Sensor plugin with three sensors

Home Assistant domain: sensor

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Knob-Float

Output

Sensor~<n>~Value

Shows the state.

entity_unit_<n>

Indicator-Text

Output

Sensor~<n>~Unit

Shows the attribute unit_of_measurement.

entity_device_class_<n>

Indicator-Text

Output

Sensor~<n>~Device Class

Shows the attribute device_class.

Siren

Home Assistant domain: siren

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_tone_<n>

Text (combo box)

Input / Output

Siren~<n>~Tone

Local field, sent with the actions of the entity. Choices from attribute available_tones.

entity_power_<n>

Button-Toggle

Input / Output

Siren~<n>~Power

Follows the state, calls siren.turn_on / siren.turn_off.

Sun

Home Assistant domain: sun

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_above_horizon_<n>

Indicator-Led

Output

Sun~<n>~Above Horizon

On when the state is above_horizon.

entity_elevation_<n>

Knob-Float

Output

Sun~<n>~Elevation

Shows the attribute elevation.

entity_azimuth_<n>

Knob-Float

Output

Sun~<n>~Azimuth

Shows the attribute azimuth.

entity_next_rising_<n>

Indicator-Text

Output

Sun~<n>~Next Rising

Shows the attribute next_rising.

entity_next_setting_<n>

Indicator-Text

Output

Sun~<n>~Next Setting

Shows the attribute next_setting.

Switch

Controls page of a Switch plugin with one unavailable switch

Home Assistant domain: switch

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Switch~<n>~Power

Follows the state, calls switch.turn_on / switch.turn_off.

Text

Home Assistant domain: text

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Text~<n>~Value

Follows the state, calls text.set_value.

Text To Speech

Home Assistant domain: tts

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_media_player_<n>

Text

Input / Output

Text To Speech~<n>~Media Player

Local field, sent with the actions of the entity.

entity_message_<n>

Text

Input / Output

Text To Speech~<n>~Message

Local field, sent with the actions of the entity.

entity_speak_<n>

Button-Trigger

Input / Output

Text To Speech~<n>~Speak

Calls tts.speak with media_player_entity_id, message.

Time

Home Assistant domain: time

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Text

Input / Output

Time~<n>~Value

Follows the state, calls time.set_value.

Timer

Home Assistant domain: timer

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_start_duration_<n>

Text

Input / Output

Timer~<n>~Start Duration

Local field, sent with the actions of the entity.

entity_start_<n>

Button-Trigger

Input / Output

Timer~<n>~Start

Calls timer.start with duration.

entity_pause_<n>

Button-Trigger

Input / Output

Timer~<n>~Pause

Calls timer.pause.

entity_cancel_<n>

Button-Trigger

Input / Output

Timer~<n>~Cancel

Calls timer.cancel.

entity_finish_<n>

Button-Trigger

Input / Output

Timer~<n>~Finish

Calls timer.finish.

entity_active_<n>

Indicator-Led

Output

Timer~<n>~Active

On when the state is active.

entity_paused_<n>

Indicator-Led

Output

Timer~<n>~Paused

On when the state is paused.

entity_duration_<n>

Indicator-Text

Output

Timer~<n>~Duration

Shows the attribute duration.

entity_remaining_<n>

Indicator-Text

Output

Timer~<n>~Remaining

Shows the attribute remaining.

entity_finishes_at_<n>

Indicator-Text

Output

Timer~<n>~Finishes At

Shows the attribute finishes_at.

To-do List

Home Assistant domain: todo

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_item_<n>

Text

Input / Output

To-do List~<n>~Item

Local field, sent with the actions of the entity.

entity_add_<n>

Button-Trigger

Input / Output

To-do List~<n>~Add

Calls todo.add_item with item.

entity_remove_<n>

Button-Trigger

Input / Output

To-do List~<n>~Remove

Calls todo.remove_item with item.

entity_value_<n>

Knob-Float

Output

To-do List~<n>~Value

Shows the state.

Update

Home Assistant domain: update

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_on_<n>

Indicator-Led

Output

Update~<n>~On

On when the state is on.

entity_installed_version_<n>

Indicator-Text

Output

Update~<n>~Installed Version

Shows the attribute installed_version.

entity_latest_version_<n>

Indicator-Text

Output

Update~<n>~Latest Version

Shows the attribute latest_version.

entity_in_progress_<n>

Indicator-Led

Output

Update~<n>~In Progress

On when the attribute in_progress is true.

entity_install_<n>

Button-Trigger

Input / Output

Update~<n>~Install

Calls update.install.

entity_skip_<n>

Button-Trigger

Input / Output

Update~<n>~Skip

Calls update.skip.

Vacuum

Home Assistant domain: vacuum

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_start_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Start

Calls vacuum.start.

entity_pause_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Pause

Calls vacuum.pause.

entity_stop_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Stop

Calls vacuum.stop.

entity_dock_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Dock

Calls vacuum.return_to_base.

entity_locate_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Locate

Calls vacuum.locate.

entity_clean_spot_<n>

Button-Trigger

Input / Output

Vacuum~<n>~Clean Spot

Calls vacuum.clean_spot.

entity_fan_speed_<n>

Text (combo box)

Input / Output

Vacuum~<n>~Fan Speed

Follows the attribute fan_speed, calls vacuum.set_fan_speed, choices from attribute fan_speed_list.

entity_cleaning_<n>

Indicator-Led

Output

Vacuum~<n>~Cleaning

On when the state is cleaning.

entity_docked_<n>

Indicator-Led

Output

Vacuum~<n>~Docked

On when the state is docked.

entity_error_<n>

Indicator-Led

Output

Vacuum~<n>~Error

On when the state is error.

Valve

Home Assistant domain: valve

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_open_<n>

Button-Trigger

Input / Output

Valve~<n>~Open

Calls valve.open_valve.

entity_stop_<n>

Button-Trigger

Input / Output

Valve~<n>~Stop

Calls valve.stop_valve.

entity_close_<n>

Button-Trigger

Input / Output

Valve~<n>~Close

Calls valve.close_valve.

entity_position_<n>

Knob-Percent

Input / Output

Valve~<n>~Position

Follows the attribute current_position, calls valve.set_valve_position.

entity_is_open_<n>

Indicator-Led

Output

Valve~<n>~Is Open

On when the state is open / opening.

entity_moving_<n>

Indicator-Led

Output

Valve~<n>~Moving

On when the state is opening / closing.

Water Heater

Home Assistant domain: water_heater

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_power_<n>

Button-Toggle

Input / Output

Water Heater~<n>~Power

Follows the state, calls water_heater.turn_on / water_heater.turn_off.

entity_operation_mode_<n>

Text (combo box)

Input / Output

Water Heater~<n>~Operation Mode

Follows the state, calls water_heater.set_operation_mode, choices from attribute operation_list.

entity_current_temperature_<n>

Knob-Float

Output

Water Heater~<n>~Current Temperature

Shows the attribute current_temperature.

entity_temperature_<n>

Knob-Float

Input / Output

Water Heater~<n>~Temperature

Follows the attribute temperature, calls water_heater.set_temperature.

entity_away_mode_<n>

Button-Toggle

Input / Output

Water Heater~<n>~Away Mode

Follows the attribute away_mode, calls water_heater.set_away_mode.

Weather

Home Assistant domain: weather

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_temperature_<n>

Knob-Float

Output

Weather~<n>~Temperature

Shows the attribute temperature.

entity_apparent_temperature_<n>

Knob-Float

Output

Weather~<n>~Apparent Temperature

Shows the attribute apparent_temperature.

entity_humidity_<n>

Knob-Float

Output

Weather~<n>~Humidity

Shows the attribute humidity.

entity_pressure_<n>

Knob-Float

Output

Weather~<n>~Pressure

Shows the attribute pressure.

entity_wind_speed_<n>

Knob-Float

Output

Weather~<n>~Wind Speed

Shows the attribute wind_speed.

entity_wind_bearing_<n>

Knob-Float

Output

Weather~<n>~Wind Bearing

Shows the attribute wind_bearing.

entity_visibility_<n>

Knob-Float

Output

Weather~<n>~Visibility

Shows the attribute visibility.

entity_temperature_unit_<n>

Indicator-Text

Output

Weather~<n>~Temperature Unit

Shows the attribute temperature_unit.

Zone

Home Assistant domain: zone

Controls

Controls name

Type

Pin Style

Pin Name

Description

entity_value_<n>

Knob-Float

Output

Zone~<n>~Value

Shows the state.

entity_persons_<n>

Indicator-Text

Output

Zone~<n>~Persons

Shows the attribute persons.

entity_latitude_<n>

Indicator-Text

Output

Zone~<n>~Latitude

Shows the attribute latitude.

entity_longitude_<n>

Indicator-Text

Output

Zone~<n>~Longitude

Shows the attribute longitude.

entity_radius_<n>

Knob-Float

Output

Zone~<n>~Radius

Shows the attribute radius.

Event Mode

Controls Page

Controls page of an Event plugin listening to two event types

One section per event. <n> is the event number.

Event Type

Controls name: event_type_<n>
Type: Text
Pin Style: Input / Output
Pin Name: Event~<n>~Event Type
Description: Type of the Home Assistant event to listen to and to fire, for example state_changed or zha_event. Free text, it must be the exact name of the event. Empty to disable the section.

Select Event

Controls name: event_select_<n>
Type: Text (combo box)
Pin Style: Input / Output
Pin Name: Event~<n>~Select Event
Description: Copies the chosen event type to Event Type, then goes back to empty. The list holds the event types Home Assistant currently listens to, plus state_changed, call_service, automation_triggered and script_started. Event Type stays a free text field for any other type.

Subscribed

Controls name: event_subscribed_<n>
Type: Indicator-Led
Pin Style: Output
Pin Name: Event~<n>~Subscribed
Description: On when Home Assistant accepted the subscription to the event type.

Filter

Controls name: event_filter_<n>
Type: Text
Pin Style: Input / Output
Pin Name: Event~<n>~Filter
Description: Optional JSON object. An event is only kept when its data holds every value of the filter, for example {"device_id": "5f2c9a", "command": "on"}.

Received

Controls name: event_received_<n>
Type: Button-Trigger
Pin Style: Output
Pin Name: Event~<n>~Received
Description: Triggers each time a matching event is received.

Time

Controls name: event_time_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: Event~<n>~Time
Description: Time the last matching event was fired.

Data

Controls name: event_data_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: Event~<n>~Data
Description: Data of the last matching event, as JSON.

Fire Data

Controls name: event_fire_data_<n>
Type: Text
Pin Style: Input / Output
Pin Name: Event~<n>~Fire Data
Description: Optional JSON object sent as the data of the fired event.

Fire

Controls name: event_fire_<n>
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Event~<n>~Fire
Description: Fires an event of the Event Type on Home Assistant.

A JSON field that is not valid, or an event Home Assistant refuses, is reported by the Status with the number of the event.

MQTT Mode

Controls Page

Controls page of an MQTT plugin with two topics

One section per topic. <n> is the topic number.

Topic

Controls name: mqtt_topic_<n>
Type: Text
Pin Style: Input / Output
Pin Name: Topic~<n>~Topic
Description: MQTT topic to subscribe and to publish to. The wildcards + and # are accepted for the subscription.

Subscribed

Controls name: mqtt_subscribed_<n>
Type: Indicator-Led
Pin Style: Output
Pin Name: Topic~<n>~Subscribed
Description: On when Home Assistant accepted the subscription to the topic.

Received

Controls name: mqtt_received_<n>
Type: Button-Trigger
Pin Style: Output
Pin Name: Topic~<n>~Received
Description: Triggers each time a message is received.

Received Topic

Controls name: mqtt_received_topic_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: Topic~<n>~Received Topic
Description: Topic of the last message, useful with wildcards.

Payload

Controls name: mqtt_payload_<n>
Type: Indicator-Text
Pin Style: Output
Pin Name: Topic~<n>~Payload
Description: Payload of the last message.

Value

Controls name: mqtt_value_<n>
Type: Knob-Float
Pin Style: Output
Pin Name: Topic~<n>~Value
Description: Payload of the last message as a number, 0 when it is not numeric.

Publish Payload

Controls name: mqtt_publish_payload_<n>
Type: Text
Pin Style: Input / Output
Pin Name: Topic~<n>~Publish Payload
Description: Payload sent by Publish.

Retain

Controls name: mqtt_retain_<n>
Type: Button-Toggle
Pin Style: Input / Output
Pin Name: Topic~<n>~Retain
Description: Publishes the message as retained.

Publish

Controls name: mqtt_publish_<n>
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Topic~<n>~Publish
Description: Publishes the Publish Payload to the Topic. A topic with wildcards cannot be published.

Assist Mode

Controls Page

Controls page of an Assist plugin with the answer of the agent

Agent

Controls name: assist_agent
Type: Text (combo box)
Pin Style: Input / Output
Pin Name: Assist~Agent
Description: Conversation agent that answers. (Default) uses the agent chosen in Home Assistant.

Language

Controls name: assist_language
Type: Text
Pin Style: Input / Output
Pin Name: Assist~Language
Description: Optional language code of the text, for example en or fr.

Text

Controls name: assist_text
Type: Text
Pin Style: Input / Output
Pin Name: Assist~Text
Description: Sentence sent to the agent. It is sent as soon as it is entered.

Send

Controls name: assist_send
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Assist~Send
Description: Sends the Text again.

Busy

Controls name: assist_busy
Type: Indicator-Led
Pin Style: Output
Pin Name: Assist~Busy
Description: On while the agent has not answered. A request without answer is abandoned after 60 s.

Responded

Controls name: assist_responded
Type: Button-Trigger
Pin Style: Output
Pin Name: Assist~Responded
Description: Triggers each time an answer is received.

Response

Controls name: assist_response
Type: Indicator-Text
Pin Style: Output
Pin Name: Assist~Response
Description: Answer of the agent.

Response Type

Controls name: assist_response_type
Type: Indicator-Text
Pin Style: Output
Pin Name: Assist~Response Type
Description: action_done, query_answer or error.

Continue

Controls name: assist_continue
Type: Indicator-Led
Pin Style: Output
Pin Name: Assist~Continue
Description: On when the agent expects a reply to its answer.

Conversation

Controls name: assist_conversation
Type: Indicator-Text
Pin Style: Output
Pin Name: Assist~Conversation
Description: Identifier of the current conversation, sent with the next text so the agent keeps the context.

New Conversation

Controls name: assist_new
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Assist~New Conversation
Description: Forgets the current conversation.

Setup Page

Setup page shared by the Entity, Event, MQTT and Assist modes

The Entity, Event, MQTT and Assist modes share this page.

Server

Server

Controls name: setup_server
Type: Text (combo box)
Pin Style: Input / Output
Pin Name: Setup~Server
Description: Server plugin used to reach Home Assistant. Selected automatically when the design has only one.

Refresh

Controls name: setup_refresh
Type: Button-Trigger
Pin Style: Input / Output
Pin Name: Setup~Refresh
Description: Rebuilds the list of Server plugins.

Connected

Controls name: setup_connected
Type: Indicator-Led
Pin Style: Output
Pin Name: Setup~Connected
Description: On when the selected Server is connected to Home Assistant.

About Page

Server mode:

About page of the Server with its license

License

License

Controls name: about_license
Type: Indicator-Status
Pin Style: Output
Pin Name: About~License
Description: Validity of the license: Valid, Invalid or Emulating. Only in Server mode.

Plugin Info

Documentation

Controls name: about_doc_url
Type: Indicator-Text
Pin Style: Output
Pin Name: About~Documentation
Description: Link to the plugin's documentation.