integration-home-assistant

KO | EN

gitlite — search

#javascript #python #hacktoberfest #android #rust #docker #macos #nodejs #windows #awesome #cli #vue #security #ios

integration-home-assistant

(★ 48)

Home-Assistant Integration for Remote Two/3

integration-home-assistant Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Rust](https://github.com/unfoldedcircle/integration-home-assistant/actions/workflows/build.yml/badge.svg)](https://github.com/unfoldedcircle/integration-home-assistant/actions/workflows/build.yml)

# Home-Assistant Integration for Remote Two/3

This integration connects [Home Assistant](https://www.home-assistant.io/) (HA) with the
[Remote Two/3](https://www.unfoldedcircle.com/) and allows to interact with most Home Assistant entities on the remote.
Only a single HA server is supported.

The integration is included in the Remote firmware and no external service must be run to connect Home Assistant
with Remote Two/3. It can be run as an external integration for development or connecting multiple servers.

The integration requires WebSocket API access to communicate with Home Assistant.
See [Home Assistant documentation](https://www.home-assistant.io/docs/authentication/) for more information on how to
create a long-lived access token.

When using the 3rd party [Unfolded Circle for Home Assistant component](https://github.com/JackJPowell/hass-unfoldedcircle),
the connection parameters are automatically configured, and you don't need to manually set an access token.

The integration implements the Remote Two [Integration-API](https://github.com/unfoldedcircle/core-api) which
communicates with JSON messages over WebSocket. The WebSocket server and client uses [Actix Web](https://actix.rs/)
with the Actix actor system for internal service communication.

## Supported Home Assistant entities

The following HA entities are supported in the Unfolded Circle Remote:

- [Button](https://developers.home-assistant.io/docs/core/entity/button/)
- [Climate](https://developers.home-assistant.io/docs/core/entity/climate)
  - Supported: on/off, heat, cool, current temperature, target temperature.
  - Fan modes are planned, but not yet supported.
- [Cover](https://developers.home-assistant.io/docs/core/entity/cover)
  - Supported: open, close, stop, set position.
  - Tilt features are planned, but not yet supported.
- [Light](https://developers.home-assistant.io/docs/core/entity/light)
  - Supported: on/off, dimming, set color, set color temperature.
  - Color effects are not supported.
- [Media player](https://developers.home-assistant.io/docs/core/entity/media-player)
  - Media browsing and searching (if supported by the entity) were added in version 0.16.0.
  - Group members are not supported.
- [Remote](https://developers.home-assistant.io/docs/core/entity/remote)
  - Supported: on, off, toggle, command, sequence.
  - Activities and command learning / deleting are not supported.
- [Select](https://developers.home-assistant.io/docs/core/entity/select)
  - Requires core / Simulator version 0.68.0 or newer. Not yet available in a public firmware release.
- [Sensor](https://developers.home-assistant.io/docs/core/entity/sensor)
- [Binary sensor](https://www.home-assistant.io/integrations/binary_sensor/): mapped to sensor
  - Sensor entity device class: `binary`.
  - The Home Assistant device class is stored in the `unit` attribute.
  - The `value` attribute contains the `on` and `off` sensor text values from Home Assistant.
- [Switch](https://developers.home-assistant.io/docs/core/entity/switch)
- [Input boolean](https://www.home-assistant.io/integrations/input_boolean/): mapped to switch
- [Input select](https://www.home-assistant.io/integrations/input_select/): mapped to select

The following HA integrations are mapped to a button. The functionality is limited to trigger the default action and no
further interactions are possible:

- [Input button](https://www.home-assistant.io/integrations/input_button/)
- [Scripts](https://www.home-assistant.io/integrations/script/)
- [Scenes](https://www.home-assistant.io/integrations/scene/)

## Home Assistant Assist

Home Assistant Assist voice commands are supported with Remote Two/3 firmware release 2.8.1 and newer.

- [Using voice assistants](https://support.unfoldedcircle.com/hc/en-us/articles/24061019101596)
- [Home Assistant voice support](https://support.unfoldedcircle.com/hc/en-us/articles/24064298749724)

## Network requirements

- The [Home Assistant WebSocket API](https://www.home-assistant.io/integrations/websocket_api/) endpoint must be
  accessible by the Remote.
  - The default url is: `ws://homeassistant.local:8123/api/websocket`
- 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.
    - As a workaround the certificate validation can be disabled in the enhanced options of the setup flow. 
  - 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.

## 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.  
  How to increase the message size:
  1. Start the Home Assistant integration setup in the web-configurator.
  2. Select the *Configure enhanced options* checkbox in the first screen and press *Next.*
  3. Increase the “Max. WebSocket frame size”.
  4. Save the new setting by finishing the setup.

## Usage

### Container Image

See [Docker image](./docker/README.md) for more information.

### Configuration

- Optional read-only configuration file to override defaults: [configuration.yaml](configuration.yaml)
- User provided Home Integration server settings are written to `$UC_CONFIG_HOME/$UC_USER_CFG_FILENAME`
  once the driver setup flow is run.

Configuration file handling uses the Rust Crate [config](https://docs.rs/config/latest/config/#) which allows
loading configuration values from multiple sources and overwrite default values.

The configuration values can be overwritten with ENV variables.

- Keys containing `_` cannot be overridden. E.g. `websocket.heartbeat.interval_sec`.
- ENV prefix: `UC_`
  - Example: `integration.interface` configuration setting: `UC_INTEGRATION_INTERFACE=127.0.0.1`

#### Environment Variables

The following environment variables exist in addition to the configuration file:

| Variable | Values | Description |
|------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------|
| UC_CONFIG_HOME | _directory path_ | Configuration directory to save the user configuration from the driver setup. Default: current directory |
| UC_DISABLE_MDNS_PUBLISH | `true` / `false` | Disables mDNS service advertisement. Default: `false` |
| UC_USER_CFG_FILENAME | _filename_ | JSON configuration filename for the user settings. Default: `home-assistant.json` |
| UC_DISABLE_CERT_VERIFICATION | `true` / `false` | Disables certificate verification for the Home Assistant WS connection. Default: `false` |
| UC_API_MSG_TRACING | `all` / `in` / `out` | Enables incoming and outgoing WS Core-API message tracing Default: no tracing |
| UC_HASS_MSG_TRACING | `all` / `in` / `out` | Enables incoming and outgoing Home Assistant WS message tracing Default: no tracing |

On the Unfolded Remote device, the integration is configured for the embedded runtime environment with several environment
variables. Mainly `UC_DISABLE_MDNS_PUBLISH=true`, `UC_CONFIG_HOME` and some `UC_INTEGRATION_*` to listen on the local
interface only.

## How to Build and Run

If you don't have Rust installed yet: <https://www.rust-lang.org/tools/install>

### Build

Without mDNS advertisement support:

```shell
cargo build
```

With [zeroconf](https://crates.io/crates/zeroconf) library, wrapping underlying ZeroConf/mDNS implementations such as
Bonjour on macOS or Avahi on Linux:
```shell
cargo build --features zeroconf
```

With pure Rust [mdns-sd](https://crates.io/crates/mdns-sd) library:

⚠️ Use at own risk, this library can cause package flooding with Apple devices in the same network!

```shell
cargo build --features mdns-sd
```
This will run on any platform, but with limited functionality (no IPv6 support) and potential incompatibilities.

### Run

To start the integration driver:
```shell
cargo run
```

## Home Assistant WebSocket API test tool

The [bin/ha_test.rs](src/bin/ha_test.rs) tool is a simple CLI tool to test the Home Assistant WebSocket API connectivity
with the exact same code & logic as the HA integration for Remote Two/3.

The main purpose of this tool is to troubleshoot connectivity issues from a PC. Linux, macOS and Windows x86 binaries
are automatically built with a GitHub action and attached to [GitHub releases](https://github.com/unfoldedcircle/integration-home-assistant/releases).

### Functionality

1. Connect to the HA server and authenticate with the token
2. Subscribe to entity state events: `subscribe_events`
3. Request the entity states: `get_states`
4. Disconnect

The debug log including HA message communication is printed to the console.

### Required parameters

- HA long-lived access token.
- HA WebSocket URL. Default if not provided: `ws://homeassistant.local:8123/api/websocket`

The configuration can either be provided in a `home-assistant.json` file in the current directory
(see [./resources/home-assistant.json](resources/home-assistant.json) template), or through command line parameters.

### Usage

```
./ha-test --help
Home Assistant server communication test

Usage: ha-test [OPTIONS]

Options:
 -u <url> Home Assistant WebSocket API URL (overrides home-assistant.json)
 --disable-cert-validation Disable SSL certificate verification (overrides home-assistant.json)
 -t <token> Home Assistant long lived access token (overrides home-assistant.json)
 -c <connection_timeout> TCP connection timeout in seconds (overrides home-assistant.json)
 -r <request_timeout> Request timeout in seconds (overrides home-assistant.json)
 --trace <MESSAGES> Message tracing for HA server communication
 [default: all] [possible values: in, out, all, none]
 -h, --help Print help
 -V, --version Print version
```

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute and submit pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags and releases on this repository](https://github.com/unfoldedcircle/integration-home-assistant/releases).

The major changes found in each new release are listed in the [changelog](./CHANGELOG.md) and
under the GitHub [releases](https://github.com/unfoldedcircle/integration-home-assistant/releases).

## License

This project is licensed under the [**Mozilla Public License 2.0**](https://choosealicense.com/licenses/mpl-2.0/).
See the [LICENSE](LICENSE) file for details.

### Project dependencies

A license report of the projects dependencies can be generated with the
[cargo-about](https://crates.io/crates/cargo-about) tool:

```shell
cargo install cargo-about
cargo about generate about.hbs > integration-hass_licenses.html
```

integration-home-assistant

integration-home-assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

integration-home-assistant

integration-home-assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README