Skip to main content

Publish Modbus data from Sigenergy to MQTT, with optional Home Assistant Auto-Discovery and PVOutput updating

Project description

sigenergy2mqtt
License Python Version from PEP 621 TOML Dynamic YAML Badge Docker Image Version PyPI - Version Maintenance
Dynamic JSON Badge Dynamic JSON Badge Docker Pulls PyPI - Downloads

sigenergy2mqtt is a bridge between the Modbus interface of the Sigenergy energy system and the MQTT lightweight publish/subscribe messaging protocol.

In addition, sigenergy2mqtt has several optional features:

  1. It can publish the appropriate messages to allow Home Assistant to automatically discover the Sigenergy devices, simplifying Home Assistant configuration.
  2. Production and consumption data can automatically be uploaded to PVOutput.
  3. It can auto-discover Sigenergy devices and their device IDs without having to specify the host IP address.

Installation

Follow the installation guides for supported environments:

Configuration

When parsing configuration options, sigenergy2mqtt looks at the configuration sources in the following order:

  1. Configuration File
  2. Environment Variables*
  3. Command Line Options*
  4. Home Assistant Add-On UI

This means, for example, that the options specified in the configuration file can be overridden by environment variables and command line options.

Click on the links above to see the configuration options available.

* Not applicable to the Home Assistant Add-On

Modbus Auto-Discovery

You can automatically discover Sigenergy devices on your network. Auto-discovery is triggered when you do not configure a Modbus host, or if you specify the command line option --modbus-auto-discovery, the environment variable SIGENERGY2MQTT_MODBUS_AUTO_DISCOVERY, or you can force it through the Home Assistant Add-on Configuration. The command line option and the environment variables take a value of either once or force: If once is specified, auto-discovery will only occur if no existing auto-discovery results are found. If force, auto-discovery will overwrite any previously discovered Modbus hosts and device IDs.

Auto-discovery is a lengthy process because your local network has to be scanned for potential Modbus hosts, and once detected there are 247 potential device IDs to be scanned on each host.

MQTT Publish and Subscribe Topics

The topics that are published and subscribed to by sigenergy2mqtt can be found here.

Disclaimer

sigenergy2mqtt was developed for my own use, and as such has only been tested in my single-phase environment without AC or DC chargers. In addition, there has been only cursory testing of the write functions. If you find a problem, please raise an issue.

Thanks

sigenergy2mqtt was inspired the Home Assistant integrations developed by TypQxQ.

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

sigenergy2mqtt-2026.1.3.tar.gz (104.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sigenergy2mqtt-2026.1.3-py3-none-any.whl (131.1 kB view details)

Uploaded Python 3

File details

Details for the file sigenergy2mqtt-2026.1.3.tar.gz.

File metadata

  • Download URL: sigenergy2mqtt-2026.1.3.tar.gz
  • Upload date:
  • Size: 104.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sigenergy2mqtt-2026.1.3.tar.gz
Algorithm Hash digest
SHA256 6efefc485acf8cedc62c09fe11242c15811a2a65ae20862c4c1c67eaf107ec84
MD5 fe75c4c96112fe9afad3fae2d515409b
BLAKE2b-256 553dfc730bd7fcc806c62e0e4a58a9b724a4ec315c5c4e479ada704539e0c6ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigenergy2mqtt-2026.1.3.tar.gz:

Publisher: publish-pypi.yml on seud0nym/sigenergy2mqtt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigenergy2mqtt-2026.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for sigenergy2mqtt-2026.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d54e3129c5b3699bd00e0170dc0aa5a8e1bdd7590d15b60bb4f821756a1afc79
MD5 67e9d8f2946f48d6a71d724fb109f9b0
BLAKE2b-256 f9aa4c2f4e8c976e033c9a12e7bffc1e2e1f6ac81cca989af8895e8de29eac47

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigenergy2mqtt-2026.1.3-py3-none-any.whl:

Publisher: publish-pypi.yml on seud0nym/sigenergy2mqtt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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