planbnet / livisi_unofficial

Unofficial fork of the home assistant livisi integration without dependencies on the abandoned aiolivisi lib
Apache License 2.0
34 stars 4 forks source link
home-assistant

Livisi Unofficial Fork

This project is in "works for me" state, but it's in use by multiple people and probably more robust than the official implementation. It can be added as a custom repo to HACS and then installed as an integration. This will override the existing livisi integration and add the following features:

Caution

This is not a drop-in replacement anymore. As entities in the original implementation were uniquely identified by the device id, only one entity per device was supported. This does not scale, so this integration migrates the old entities and changes the unique id to the capability id (which should be unique for every functionality of a device in the livisi controller). So once you install this integration via HACS, you cannot go back to the official implementation without recreating your Livisi devices.

Installation

Using HACS (preferred)

Add this repository in HACS as a custom repository and install it from there

This way you will get automatic updates

Manual

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called livisi.
  4. Download all the files from the custom_components/livisi/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "livisi"

Configuration

All configuration in done in the UI. See the official documentation

Notes

Development

  1. Clone this repository and open it in a devcontainer.
  2. cd scripts
  3. Only run the first time or on updates: ./setup
  4. ./develop

You can also use the VSCode launch configuration Home Assistant.