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.3.0.tar.gz
(62.8 kB
view details)
Built Distribution
File details
Details for the file ha-services-2.3.0.tar.gz
.
File metadata
- Download URL: ha-services-2.3.0.tar.gz
- Upload date:
- Size: 62.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 | 0be20b5cf7de574069da56dc34637e9bc4bd3953ffddbd8f672f1993562d8208 |
|
MD5 | a5445b745aa007b9b71df67687ee999c |
|
BLAKE2b-256 | dfd3fad625997379e8c910056ae5d55b9f8eb542507c0c7e73b78a9e74389ea2 |
Provenance
File details
Details for the file ha_services-2.3.0-py3-none-any.whl
.
File metadata
- Download URL: ha_services-2.3.0-py3-none-any.whl
- Upload date:
- Size: 32.5 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 | e3eda1d446fd13aafc6c37b02a8aae3ba54cb0b447628368c7c2e7f64e40c07f |
|
MD5 | b38b1fe3bf80a7d5324f0bfb1299b0f8 |
|
BLAKE2b-256 | d97c06e15139cb6309864943da98c1eca149a50a73d0b5321e88583c753de174 |