SolarEdge 2 MQTT Service
The SolarEdge2MQTT service is a project designed to read power 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 via Modbus.
You can also gather the panels' energy production data from the SolarEdge monitoring site. This feature is optional and does not use the API, but rather your monitoring platform account.
The SolarEdge Wallbox can be monitored as well via REST API.
Additionally all values can be saved for visualization into a InfluxDB.
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 (for security reason use secrets with docker) |
| 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 |
If you want to get panel energy values from the SolarEdge monitoring platform, add additional parameters.
| Environment Variable | description |
|---|---|
| SE2MQTT_API_SITE_ID | Your site id from the SolarEdge monitoring plattform |
| SE2MQTT_API_USERNAME | Your username for your account on the SolarEdge monitoring platform |
| SE2MQTT_API_PASSWORD | Your password for your account on the SolarEdge monitoring plattform (for security reason use secrets with docker) |
If you want to monitor the power values of your SolarEdge Wallbox, add additional parameters. The Wallbox needs to have firmware version >= 1.15.0 and activated REST API.
| Environment Variable | description |
|---|---|
| SE2MQTT_WALLBOX_HOST | The IP adress of your wallbox |
| SE2MQTT_WALLBOX_PASSWORD | The password of user admin you use to login the Web UI of your Wallbox |
| SE2MQTT_WALLBOX_SERIAL | The serial number of your wallbox |
If you want to save the monitoring data to a InfluxDB you have to generate a full access token, because the service will generate two buckets and a task for you.
The first bucket (raw) is used to store every interval the data of the components inverter, meters, batteries and wallbox to a measurement called component and the current powerflow state. This can be useful for debugging reasons. The generated aggregation task will store the energy values of every minute to this bucket. By default this bucket holds the values for 24h.
The second bucket is used by the aggregation task to store the powerflow states and energy values aggregated by 1 hour intervals. By default this bucket holds the values for 2 years.
| Environment Variable | default (production/development) | description |
|---|---|---|
| SE2MQTT_INFLUXDB_HOST | None | Set your host (for example: http://localhost) |
| SE2MQTT_INFLUXDB_PORT | 8086 | Set your port |
| SE2MQTT_INFLUXDB_TOKEN | None | Set your token (for security reasons use a secret with docker) The token must have full access because the service manages the needed buckets and tasks |
| SE2MQTT_INFLUXDB_ORG | None | Set your organization ID |
| SE2MQTT_INFLUXDB_PREFIX | solaredge/solaredgedev | Set a prefix for bucket and task names |
| SE2MQTT_INFLUXDB_RETENTION_RAW | 90000 = 25h | Set a retention policy in seconds for bucket raw |
| SE2MQTT_INFLUXDB_RETENTION_AGGREGATED | 63072000 = 2 years | Set a retention policy in seconds for bucket aggegrated |
| SE2MQTT_INFLUXDB_AGGREGATED_INTERVAL | 10m | Aggregate power and energy valuse in InfluxDB set a interval for the task should be between 10m and 1h |
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.
With docker-compose
Copy the .env.example file to .env and modify it according to your needs.
Get the docker-compose.yml file.
Generate a .secrets directory and put at least a file called mqtt_password inside with your MQTT broker password.
If you want to use module energy values additionally, uncomment the secrets parts for the se2mqtt_api_password secret inside the docker-compose.yml and put a api_password file in the .secrets directory as well. Same applies for wallbox_password and influxdb_token
Run the docker container
docker-compose up -d
Stop the docker container
docker-compose down
Metadata
Release files for solaredge2mqtt 0.7.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| solaredge2mqtt-0.7.2.tar.gz | 44.2 kB | Without provenance | Details for solaredge2mqtt-0.7.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| solaredge2mqtt-0.7.2-py3-none-any.whl | Python 3 | none | any | Details for solaredge2mqtt-0.7.2-py3-none-any.whl |
Total release size: 73.3 kB
Release files / solaredge2mqtt-0.7.2.tar.gz
| Download URL | solaredge2mqtt-0.7.2.tar.gz |
|---|---|
| Size | 44.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bb6cd65c64ac5952300236ad6388b382f58708889097808936978a0d7e16d569
|
|
BLAKE2b-256 checksum How to use checksums |
7ae5956d99348d9d29f3939fc732b40938636fce101564466095ce7a3afd836d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / solaredge2mqtt-0.7.2-py3-none-any.whl
| Download URL | solaredge2mqtt-0.7.2-py3-none-any.whl |
|---|---|
| Size | 29.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2af20cbbd7f20e6e82dc82a24c259ccdaeb698e081e4b5e76e5c3da155aca3e5
|
|
BLAKE2b-256 checksum How to use checksums |
c935db0770009184da9da10374069f15b14828c253b22501ff1d44478e632d2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for solaredge2mqtt 0.7.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.