Sign inSign up

fligneul/hyponcloud2mqtt

By fligneul

•Updated 9 months ago

Python app that syncs Hypon Cloud data to MQTT for Home Assistant integration.

Image
Internet of things
0

340

fligneul/hyponcloud2mqtt repository overview

⁠hyponcloud2mqtt

A bridge to connect the Hypon Cloud API to an MQTT broker. This application periodically fetches data from your Hypon system and publishes it to your MQTT broker, allowing for easy integration with home automation systems like Home Assistant.

Note

This project was developed and tested using data from an HMS800-C inverter.

⁠Quick Start

⁠Docker Run
docker run -d \
  --name hyponcloud2mqtt \
  --restart unless-stopped \
  -e HTTP_URL="http://192.168.1.100" \
  -e SYSTEM_IDS="12345,67890" \
  -e API_USERNAME="your_username" \
  -e API_PASSWORD="your_password" \
  -e MQTT_BROKER="192.168.1.10" \
  -e MQTT_TOPIC="solar/inverter" \
  fligneul/hyponcloud2mqtt:latest
⁠Docker Compose
services:
  hyponcloud2mqtt:
    image: fligneul/hyponcloud2mqtt:latest
    container_name: hyponcloud2mqtt
    restart: unless-stopped
    environment:
      HTTP_URL: "http://192.168.1.100"
      SYSTEM_IDS: "your_system_id_1"
      API_USERNAME: "your_username"
      API_PASSWORD: "your_password"
      MQTT_BROKER: "mosquitto"
      MQTT_TOPIC: "solar/inverter"

⁠Configuration

⁠Environment Variables

Note

Variables marked as Config* are required only if they are not provided in the `config.yaml` file. If no configuration file is used, these environment variables must be set.
VariableRequiredDefaultDescription
CONFIG_FILENoconfig.yamlPath to config file
HTTP_URLConfig*-Base URL of the API (e.g., http://192.168.1.100)
SYSTEM_IDSConfig*-Comma-separated list of system IDs to monitor
API_USERNAMEConfig*-API username for authentication
API_PASSWORDConfig*-API password for authentication
VERIFY_SSLNotrueVerify SSL certificates of the API (set to false for self-signed certs)
HTTP_INTERVALNo60Fetch interval in seconds
MQTT_BROKERNolocalhostMQTT broker address
MQTT_PORTNo1883MQTT broker port
MQTT_TOPICNohome/dataMQTT topic to publish to
MQTT_USERNAMENo-MQTT username (optional)
MQTT_PASSWORDNo-MQTT password (optional)
MQTT_CLIENT_IDNohyponcloud2mqttMQTT client ID (optional)
MQTT_TLS_ENABLEDNofalseEnable MQTT TLS
MQTT_TLS_INSECURENofalseDisable TLS certificate verification
MQTT_CA_PATHNo-Path to custom CA certificate for MQTT
MQTT_AVAILABILITY_TOPICNo{MQTT_TOPIC}/statusMQTT availability topic
HA_DISCOVERY_ENABLEDNotrueEnable Home Assistant discovery
HA_DISCOVERY_PREFIXNohomeassistantHome Assistant discovery prefix
DEVICE_NAMENohyponcloud2mqttDevice name for Home Assistant
DRY_RUNNofalseIf true, log MQTT messages instead of publishing
LOG_LEVELNoINFOLogging level (DEBUG, INFO, WARNING, ERROR)

⁠License

This project is licensed under the GNU Affero General Public License v3.0.

Tag summary

Content type

Image

Digest

sha256:beb54d0dd…

Size

47.5 MB

Last updated

9 months ago

docker pull fligneul/hyponcloud2mqtt