Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superbox-dev/unipi-control
Control Unipi I/O directly with MQTT commands.
https://github.com/superbox-dev/unipi-control
home-assistant home-automation homeassistant internet-of-things iot modbus mqtt python smarthome unipi
Last synced: 3 months ago
JSON representation
Control Unipi I/O directly with MQTT commands.
- Host: GitHub
- URL: https://github.com/superbox-dev/unipi-control
- Owner: superbox-dev
- License: apache-2.0
- Created: 2021-08-15T08:59:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T19:59:10.000Z (4 months ago)
- Last Synced: 2024-10-01T05:07:50.145Z (3 months ago)
- Topics: home-assistant, home-automation, homeassistant, internet-of-things, iot, modbus, mqtt, python, smarthome, unipi
- Language: Python
- Homepage:
- Size: 1.32 MB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Support: docs/supported-hardware.md
Awesome Lists containing this project
README
[](https://github.com/superbox-dev/unipi-control/actions/workflows/ci.yml)
[](https://pypi.python.org/pypi/unipi-control)
[](https://github.com/superbox-dev/unipi-control/blob/main/LICENSE)
# 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](https://docs.superbox.one)
---
## Getting started
### Recommended installation (only for Unipi Neuron)
We have a ready to use SD card image called [Unipi Control OS](https://github.com/superbox-dev/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:
```bash
python3 -m venv PATH_TO_VENV
```
Activate the virtual environment:
```bash
source PATH_TO_VENV/bin/activate
```
Install `unipi-control` with pip:
```bash
pip install unipi-control
```
Copy the [config files](https://github.com/superbox-dev/unipi-control/data/opkg/data/local/etc/unipi) to `/etc/unipi` and configurate the `/etc/unipi/control.yaml`.
Create the systemd service `/etc/systemd/system/unipi-control.service` with following content:
```ini
[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:
```bash
systemctl --system daemon-reload
systemctl enable unipi-control.service
systemctl start unipi-control.service
```
## Changelog
The changelog lives in the [CHANGELOG.md](CHANGELOG.md) document. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Contributing
We're happy about your contributions to the project!
You can get started by reading the [CONTRIBUTING.md](CONTRIBUTING.md).
## Donation
We put a lot of time into this project. If you like it, you can support us with a donation.
[](https://ko-fi.com/F2F0KXO6D)
## Extras
We have a Home Assistant blueprint automation to control covers with binary sensors. Take a look in the [extras](data/extras) directory.
## Additional information
This is a third-party software for [Unipi Neuron](https://www.unipi.technology). This software **is NOT** from [Unipi Technology s.r.o.](https://www.unipi.technology).