← All products
New

Home Assistant

Version 3.0.0.0

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.

US$50.00

Overview

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

Requirements

If you are upgrading this plugin to version 3 or above from any version prior to v3, you will need to recalculate your license key through our licensing portal and update it within your design.

Release notes

Version 3.0.0.0Latest

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

New versions

Get an email when a new version comes out — at the address you sign in to the customer portal with.

Documentation

Downloads