Skip to main content

Helpers to send periodic information via MQTT to Home Assistant

Project description

ha_services

tests codecov ha_services @ PyPi Python Versions License GPL-3.0-or-later

Helpers to send periodic information via MQTT to Home Assistant

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


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.2.0rc0.tar.gz (58.6 kB view details)

Uploaded Source

Built Distribution

ha_services-2.2.0rc0-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

Details for the file ha-services-2.2.0rc0.tar.gz.

File metadata

  • Download URL: ha-services-2.2.0rc0.tar.gz
  • Upload date:
  • Size: 58.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for ha-services-2.2.0rc0.tar.gz
Algorithm Hash digest
SHA256 ba4ebe6bef0ef6a80c7e9c7f7f309552ec018131aef2eb233234627345dcfae7
MD5 928a95a404e396f65604c816b48fc0c1
BLAKE2b-256 8088c42c7b154b77045e252ef0026ee4e928414f53ffa88eebd912054748adb8

See more details on using hashes here.

Provenance

File details

Details for the file ha_services-2.2.0rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for ha_services-2.2.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ecd3cbcac3faeb63b41cae7565c53b69eba161bf1532ec25577371366a97534
MD5 440e265e64773963e99af9137c53f818
BLAKE2b-256 87d0164b5011dafbf3e9767f9d9732f105998e2af52edcd8f4bf0735b6b3f7ca

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page