unipi-control 3.1.0

Control Unipi I/O directly with MQTT commands.

Unipi Control

Unipi Control use Modbus for fast access to the I/O and provide MQTT topics for reading and writing the circuits. Optionally you can enable the Home Assistant MQTT discovery for binary sensors, sensors, switches and covers.

---

For more information please read the documentation at: docs.superbox.one

---

Getting started

Recommended installation (only for Unipi Neuron)

We have a ready to use SD card image called Unipi Control OS.

Alternative installation with pip (Debian based systems)

Requirements:

• Unipi Neuron Kernel Module and Unipi tools (Use the officially APT mirror (https://repo.unipi.technology/debian/) from Unipi Technology)
• Python >= 3.8

Create a virtual environment:

python3 -m venv PATH_TO_VENV

Activate the virtual environment:

source PATH_TO_VENV/bin/activate

Install unipi-control with pip:

pip install unipi-control

Copy the config files to /etc/unipi and configurate the /etc/unipi/control.yaml.

Create the systemd service /etc/systemd/system/unipi-control.service with following content:

[Unit]
Description=Unipi Control
After=multi-user.target

[Service]
Type=simple
ExecStart=PATH_TO_VENV/bin/unipi-control --log systemd
Environment=PYTHONUNBUFFERED=1

[Install]
WantedBy=multi-user.target

Enable and start the systemd service:

systemctl --system daemon-reload
systemctl enable unipi-control.service
systemctl start unipi-control.service

Changelog

The changelog lives in the CHANGELOG.md document. The format is based on Keep a Changelog.

Contributing

We're happy about your contributions to the project!

You can get started by reading the CONTRIBUTING.md.

Donation

We put a lot of time into this project. If you like it, you can support us with a donation.

Extras

We have a Home Assistant blueprint automation to control covers with binary sensors. Take a look in the extras directory.

Additional information

This is a third-party software for Unipi Neuron. This software is NOT from Unipi Technology s.r.o..