unlobito / ha-hildebrandglow

PRE-RELEASE. HomeAssistant integration for the Hildebrand Glow smart meter HAN for UK SMETS meters.
MIT License
54 stars 31 forks source link

Archived

This repository was archived on 30 April 2022 (see https://github.com/unlobito/ha-hildebrandglow/discussions/55 for details).

HandyHat/ha-hildebrandglow-dcc is maintained as a fork for DCC users.

ha-hildebrandglow

HomeAssistant integration for the Hildebrand Glow smart meter HAN for UK SMETS meters.

You'll need to have an active Glow account (usable through the Bright app), a Consumer Access Device, and MQTT access enabled before using this integration. If you haven't been given MQTT connection details by Hildebrand, you'll need to contact them and request MQTT access be enabled for your account.

This integration will currently emit one sensor for the current usage of each detected smart meter.

Installation

Automated installation through HACS

You can install this component through HACS and receive automatic updates.

After installing HACS, visit the HACS Settings pane and add https://github.com/unlobito/ha-hildebrandglow as an Integration. You'll then be able to install it through the Integrations pane.

Manual installation

Copy the custom_components/hildebrandglow/ directory and all of its files to your config/custom_components directory. You'll then need to restart Home Assistant for it to detect the new integration.

Configuration

Visit the Integrations section within Home Assistant's Configuration panel and click the Add button in the bottom right corner. After searching for "Hildebrand Glow", you'll be asked for your application ID and Glow credentials.

Once you've authenticated, the integration will automatically set up a sensor for each of the smart meters on your account.

Development

GNU Make is used to assist with common tasks during development. The following is a list of all supported commands on the Makefile.

$ make
Usage: make [command]

  install-dev    Install dependencies required for development via pip
  format         Run linters on the codebase and attempt to fix any issues found
  lint           Dry-run linters on the codebase without making any changes

Code Style

This project makes use of black, flake8, isort, and mypy to automatically enforce a consistent code style across the codebase.

make format should be run before committing to automatically format the codebase.

make lint is used by Continuous Integration to validate the codebase's formatting without making any changes to it.