This integrated integration connects to a Home Assistant server in your network. Only a single server is supported.
The integration requires WebSocket API access to communicate with Home Assistant. See Home Assistant documentation for more information on how to create a long-lived access token.
When using the 3rd party Unfolded Circle for Home Assistant component, the connection parameters are automatically configured, and you don't need to manually set an access token.
Supported Home Assistant entities
The following HA entities are supported in the Unfolded Circle Remote:
- Button
-
Climate
- Supported: on/off, heat, cool, current temperature, target temperature.
- Fan modes are planned, but not yet supported.
-
Cover
- Supported: open, close, stop, set position.
- Tilt features are planned, but not yet supported.
-
Light
- Supported: on/off, dimming, set color, set color temperature.
- Color effects are not supported.
-
Media player
- Media browsing, playlist handling, group members are not supported.
-
Remote
- Supported: on, off, toggle, command, sequence.
- Activities and command learning / deleting are not supported.
- Sensor
- Switch
- Input boolean: mapped to switch
- Binary sensor: mapped to sensor
The following HA integrations are mapped to a button. The functionality is limited to trigger the default action and no further interactions are possible:
Network requirements
- The Home Assistant WebSocket API endpoint must be accessible by the Remote.
- The default url is:
ws://homeassistant.local:8123/api/websocket
- The default url is:
- A direct connection without SSL (
ws://connection) from the Remote to the Home Assistant API is recommended when used in same internal network.- We cannot provide support for custom installations with reverse proxy, SSL setups, changed endpoints or URLs.
- Self-signed certificates are not supported and don’t work.
- If only an SSL endpoint is exposed, then the
wss://connection URL must be used in the integration!- Please note, that not all certificates or SSL setups seem to work.
- It has been successfully tested with Let’s Encrypt certificates and a nginx reverse proxy.
- See general Network requirements for further information.
Home Assistant requirements
- A long-lived access token is required for the integration to connect to the Home Assistant server.
- Very large Home Assistant setups require either to increase the message size or use the 3rd party HACS component (see below).
How to increase the message size:- Start the Home Assistant integration setup in the web-configurator.
- Select the Configure enhanced options checkbox in the first screen and press Next.
- Increase the “Max. WebSocket frame size”.
- Save the new setting by finishing the setup.
3rd Party Unfolded Circle HACS Component
If you have a very large Home Assistant setup with over a thousand entities, the Home Assistant WebSocket API might no longer be usable and timeouts can occur. The reason is that the API doesn’t allow filtering for the selected entities in the Remote and always sends all available entities in Home Assistant. If for example you’d only like to control a handful of entities on the Remote, Home Assistant still sends the data and updates of all hundreds or thousands of entities it knows about.
That’s where the great 3rd party Unfolded Circle HACS Component from Jack Powell comes into the picture! It enhances the WebSocket API and allows filtering. Please check it out!
Important: if you use this component, the available entities in the Remote are no longer pulled by the Remote, but offered by the Unfolded Circle HACS Component! If you want to expose more HA entities to the Remote, then this needs to be done in the Unfolded Circle HACS Component.
Please note that we cannot provide support for this 3rd party component.
More information
This integration is open sourced. It can also be run on a PC on your network and used as an external integration.