Helpers to send periodic information via MQTT to Home Assistant
Project description
ha_services
Helpers to send periodic information via MQTT to Home Assistant
Use by:
- https://github.com/jedie/tinkerforge2mqtt
- https://github.com/jedie/victron-ble2mqtt
- https://github.com/jedie/energymeter2mqtt
- https://github.com/jedie/pysmartmeter
start development
~$ git clone https://github.com/jedie/ha-services.git
~$ cd inverter-connect
~/ha-services$ ./dev-cli.py --help
dev CLI
Usage: ./dev-cli.py [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ check-code-style Check code style by calling darker + flake8 │
│ coverage Run tests and show coverage report. │
│ fix-code-style Fix code style of all ha_services source code files via darker │
│ install Run pip-sync and install 'ha_services' via pip as editable. │
│ mypy Run Mypy (configured in pyproject.toml) │
│ publish Build and upload this project to PyPi │
│ safety Run safety check against current requirements files │
│ test Run unittests │
│ tox Run tox │
│ update Update "requirements*.txt" dependencies files │
│ update-test-snapshot-files Update all test snapshot files (by remove and recreate all snapshot │
│ files) │
│ version Print version and exit │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
DEMO app CLI
Usage: ./cli.py [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ edit-settings Edit the settings file. On first call: Create the default one. │
│ print-settings Display (anonymized) MQTT server username and password │
│ publish-loop Publish data via MQTT for Home Assistant (endless loop) │
│ systemd-debug Print Systemd service template + context + rendered file content. │
│ systemd-remove Write Systemd service file, enable it and (re-)start the service. (May │
│ need sudo) │
│ systemd-setup Write Systemd service file, enable it and (re-)start the service. (May │
│ need sudo) │
│ systemd-status Display status of systemd service. (May need sudo) │
│ systemd-stop Stops the systemd service. (May need sudo) │
│ test-mqtt-connection Test connection to MQTT Server │
│ version Print version and exit │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
Backwards-incompatible changes
v2.0.0
Complete refactor of mqtt4homeassistant
module.
New usage, see: ha_services/example.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ha-services-2.5.0.tar.gz
(66.8 kB
view details)
Built Distribution
File details
Details for the file ha-services-2.5.0.tar.gz
.
File metadata
- Download URL: ha-services-2.5.0.tar.gz
- Upload date:
- Size: 66.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fab10eacd2cb910b29b64fe6d8708f255da98d12f53ce08f5293790ab13b5e16 |
|
MD5 | 7c9de62220387178c14eb322201373b0 |
|
BLAKE2b-256 | 9acaa70f5ccc7774e48f35075cd9bc5137a6b9504cc810669faf8dd10ab71895 |
Provenance
File details
Details for the file ha_services-2.5.0-py3-none-any.whl
.
File metadata
- Download URL: ha_services-2.5.0-py3-none-any.whl
- Upload date:
- Size: 38.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dce3cb3804f52aa66b5b737661b0f6618a8af24ceb7575574ac03f56d371248 |
|
MD5 | c65f32051e3fe915273aae8ee1c92682 |
|
BLAKE2b-256 | 7f1953126957f6a6d00b0b7d859d7f7170a83ceef734cdd46e2646cc9f00257f |