Read data from SolarEdge Inverter and publish it to MQTT
Project description
SolarEdge 2 MQTT Service
The SolarEdge2MQTT service is a project designed to read data from a SolarEdge inverter and publish it to an MQTT broker. The service is useful for integrating SolarEdge inverters into home automation systems or other applications that use MQTT for data exchange. It provides real-time monitoring of power flow and other parameters from the inverter. The project is open-source and can be customized to suit specific needs.
The SolarEdge2MQTT service is currently in an early stage of development. While it is functional and can be used to read data from a SolarEdge inverter and publish it to an MQTT broker, it is still undergoing active development. Features may be added, removed, or changed, and there may be bugs. Users should be aware of this and use the service with caution. Despite its early state, the project is open-source and contributions are welcome.
Installation and Configuration
Install and update using pip.
pip install -U solaredge2mqtt
Install and update using docker
docker pull ghcr.io/deroetzi/solaredge2mqtt:latest
Service configuration
The service is configured by environment variables. The following options can be set:
Environment Variable | default (production/development) | description |
---|---|---|
SE2MQTT_ENVIRONMENT | production | Choose the default environment settings: production or development. |
SE2MQTT_MODBUS_HOST | None | IP address of your inverter |
SE2MQTT_MODBUS_PORT | 1502 | Modbus port of your inverter |
SE2MQTT_MODBUS_TIMEOUT | 1 | Timeout for the modbus connection |
SE2MQTT_MODBUS_UNIT | 1 | Modbus unit address |
SE2MQTT_CLIENT_ID | solaredge2mqtt | MQTT client id |
SE2MQTT_BROKER | None | IP address of your MQTT broker |
SE2MQTT_PORT | 1883 | Port of your MQTT broker |
SE2MQTT_USERNAME | None | Username to authenticate to your MQTT broker |
SE2MQTT_PASSWORD | None | Password to authenticate to your MQTT broker |
SE2MQTT_TOPIC_PREFIX | solaredge | SolarEdge2MQTT will use this as prefix topic |
SE2MQTT_INTERVAL | 5 | Interval between requests in seconds |
SE2MQTT_LOGGING_LEVEL | INFO | Set logging level to DEBUG, INFO, WARNING, ERROR, CRITICAL |
Example configuration
You can download .env.example and rename it to .env
. Inside, you can modify the default configuration values to meet your needs in this file.
Run the service
In the console
Copy the .env.example file to .env and modify it according to your needs.
Then, simply run solaredge2mqtt
to start the service.
With docker:
docker run --name solaredge2mqtt --rm \
-e "SE2MQTT_MODBUS_HOST=<INVERTER_IP>" \
-e "SE2MQTT_BROKER=<BROKER_IP>" \
-e "SE2MQTT_USERNAME=<MQTT_USERNAME>" \
-e "SE2MQTT_PASSWORD=<MQTT_PASSWORD>" \
-e "TZ=Europe/Berlin" \
ghcr.io/deroetzi/solaredge2mqtt:latest
Add optional environment arguments from above to fit to your setup.
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
Built Distribution
Hashes for solaredge2mqtt-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5dc4239fe847dbfc89b360c677b3c045e855021801844e81a7aace764f20db2 |
|
MD5 | 11b9c3f9ba398e4a655c332734d2bef8 |
|
BLAKE2b-256 | a2ecc25d9166d8022196d805bdf489a50a9bc63f2c5f004a20ac1e84ef411931 |