| Name | unipi-control JSON |
| Version |
3.1.0
JSON |
| download |
| home_page | |
| Summary | Control Unipi I/O directly with MQTT commands. |
| upload_time | 2023-10-03 03:45:28 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Apache-2.0 license |
| keywords |
mqtt
modbus
unipi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/superbox-dev/unipi-control/actions/workflows/ci.yml)
[](https://opensource.org/license/apache-2-0/)
<!-- pitch start -->
# 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.
<!-- pitch end -->
---
For more information please read the documentation at:
[docs.superbox.one](https://docs.superbox.one)
---
<!-- quickstart start -->
## 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
```
<!-- quickstart end -->
## 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 start -->
## 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)
<!-- donation end -->
## Extras
We have a Home Assistant blueprint automation to control covers with binary sensors. Take a look in the [extras](data/extras) directory.
<!-- additional_info start -->
## 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).
<!-- additional_info end -->
Raw data
{
"_id": null,
"home_page": "",
"name": "unipi-control",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Michael Hacker <mh@superbox.one>",
"keywords": "mqtt,modbus,unipi",
"author": "",
"author_email": "Michael Hacker <mh@superbox.one>",
"download_url": "https://files.pythonhosted.org/packages/d6/bf/fabf61377515723b9be8d4340979deaf69a462bf81ffa783a2a93f6fe3bf/unipi-control-3.1.0.tar.gz",
"platform": null,
"description": "\n[](https://github.com/superbox-dev/unipi-control/actions/workflows/ci.yml)\n\n\n\n\n\n\n[](https://opensource.org/license/apache-2-0/)\n\n\n\n\n\n<!-- pitch start -->\n# Unipi Control\n\nUnipi 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.\n<!-- pitch end -->\n\n---\n\nFor more information please read the documentation at:\n[docs.superbox.one](https://docs.superbox.one)\n\n---\n\n<!-- quickstart start -->\n## Getting started\n\n### Recommended installation (only for Unipi Neuron)\n\nWe have a ready to use SD card image called [Unipi Control OS](https://github.com/superbox-dev/unipi-control-os).\n\n### Alternative installation with pip (Debian based systems)\n\n**Requirements:**\n\n* Unipi Neuron Kernel Module and Unipi tools (Use the officially APT mirror (https://repo.unipi.technology/debian/) from Unipi Technology)\n* Python >= 3.8\n\nCreate a virtual environment:\n\n```bash\npython3 -m venv PATH_TO_VENV\n```\n\nActivate the virtual environment:\n\n```bash\nsource PATH_TO_VENV/bin/activate\n```\n\nInstall `unipi-control` with pip:\n\n```bash\npip install unipi-control\n```\n\nCopy 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`.\n\nCreate the systemd service `/etc/systemd/system/unipi-control.service` with following content:\n\n```ini\n[Unit]\nDescription=Unipi Control\nAfter=multi-user.target\n\n[Service]\nType=simple\nExecStart=PATH_TO_VENV/bin/unipi-control --log systemd\nEnvironment=PYTHONUNBUFFERED=1\n\n[Install]\nWantedBy=multi-user.target\n```\n\nEnable and start the systemd service:\n\n```bash\nsystemctl --system daemon-reload\nsystemctl enable unipi-control.service\nsystemctl start unipi-control.service\n```\n<!-- quickstart end -->\n\n## Changelog\n\nThe changelog lives in the [CHANGELOG.md](CHANGELOG.md) document. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).\n\n## Contributing\n\nWe're happy about your contributions to the project!\n\nYou can get started by reading the [CONTRIBUTING.md](CONTRIBUTING.md).\n\n<!-- donation start -->\n## Donation\n\nWe put a lot of time into this project. If you like it, you can support us with a donation.\n\n[](https://ko-fi.com/F2F0KXO6D)\n<!-- donation end -->\n\n## Extras\n\nWe have a Home Assistant blueprint automation to control covers with binary sensors. Take a look in the [extras](data/extras) directory.\n\n<!-- additional_info start -->\n## Additional information\n\nThis 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). \n<!-- additional_info end -->\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Control Unipi I/O directly with MQTT commands.",
"version": "3.1.0",
"project_urls": {
"Issue tracker": "https://github.com/superbox-dev/unipi-control/issues",
"Source code": "https://github.com/superbox-dev/unipi-control"
},
"split_keywords": [
"mqtt",
"modbus",
"unipi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a6298d7da71e3f9dcce20a935d236b9ce0968535171a97e5a93870321d74321",
"md5": "08e885ff8fe5c27c31c3002633b5004e",
"sha256": "275374f6cec147d0d415ce1b868b60baae06ff35f7fc460704dffff6cb0af119"
},
"downloads": -1,
"filename": "unipi_control-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08e885ff8fe5c27c31c3002633b5004e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49692,
"upload_time": "2023-10-03T03:45:27",
"upload_time_iso_8601": "2023-10-03T03:45:27.037940Z",
"url": "https://files.pythonhosted.org/packages/9a/62/98d7da71e3f9dcce20a935d236b9ce0968535171a97e5a93870321d74321/unipi_control-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6bffabf61377515723b9be8d4340979deaf69a462bf81ffa783a2a93f6fe3bf",
"md5": "f8f9792711d56f80b9bed519180b25a1",
"sha256": "afd5f6e7ac71ba2a896e0aca27ef70c3a57ae8d430782a2de8312b12e36c3822"
},
"downloads": -1,
"filename": "unipi-control-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f8f9792711d56f80b9bed519180b25a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 77442,
"upload_time": "2023-10-03T03:45:28",
"upload_time_iso_8601": "2023-10-03T03:45:28.841495Z",
"url": "https://files.pythonhosted.org/packages/d6/bf/fabf61377515723b9be8d4340979deaf69a462bf81ffa783a2a93f6fe3bf/unipi-control-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-03 03:45:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "superbox-dev",
"github_project": "unipi-control",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "unipi-control"
}
