Reads Deye solar inverter metrics using Modbus over TCP and publishes them over MQTT.

Tested with:

• Deye SUN-4K-G05 and Logger S/N 23xxxxxxxx
• Deye SUN1300G3 and Logger S/N 41xxxxxxxx
• Deye SUN600G3 and Logger S/N 41xxxxxxxx

The meaning of certain registers depends on the inverter type. For example, string inverters use registers 0x46 - 0x4e to report AC phase voltage/current. On the other hand, micro inverters use this same registers to report pv1-pv4 cumulative energy. Generally there are three types of inverters documented in the specification: string, micro and hybrid. In the table below you can see, that the metrics are assigned to specific groups. You should specify the set of groups that is appropriate for your inverter in DEYE_METRIC_GROUPS environment variable. Typically you should set it to either string or micro. Additional groups may be added in the future.

Reports deye-inverter-mqtt service status (not the inverter/logger status):

• online - when the service is connected to the MQTT broker
• offline - when the service is disconnected from the MQTT broker

The default topic name is status and can be changed in the configuration.

Reports solar inverter's logger connectivity status

• online - when the service connect to the logger successfully
• offline - when the service can't connect to the logger

The default topic name is logger_status and can be changed in the configuration.

1. Copy config.env.example as config.env

2. Fill in values in config.env

3. Run the container

   docker run --rm --env-file config.env ghcr.io/kbialek/deye-inverter-mqtt
   

All configuration options are controlled through environment variables.

• LOG_LEVEL - application log level, can be any of DEBUG, INFO, WARN, ERROR
• DEYE_DATA_READ_INTERVAL - interval between subsequent data reads, in seconds, defaults to 60
• DEYE_METRIC_GROUPS - a comma delimited set of:
  • string - set when connecting to a string inverter
  • micro - set when connecting to a micro inverter
• DEYE_LOGGER_SERIAL_NUMBER - inverter data logger serial number
• DEYE_LOGGER_IP_ADDRESS - inverter data logger IP address
• DEYE_LOGGER_PORT - inverter data logger communication port, typically 8899
• MQTT_HOST
• MQTT_PORT
• MQTT_USERNAME
• MQTT_PASSWORD
• MQTT_TOPIC_PREFIX - mqtt topic prefix used for all inverter metrics
• MQTT_AVAILIBILITY_TOPIC - mqtt availability topic, defaults to status
• MQTT_LOGGER_STATUS_TOPIC - logger connectivity status topic, defaults to logger_status

The tool allows reading and writing raw register values directly in the terminal.

USE AT YOUR OWN RISK! Be sure to know what you are doing. Writing invalid values may damage the inverter. By using this tool you accept this risk and you take full responsiblity for the consequences.

• To read register value execute:

  docker run --rm --env-file config.env ghcr.io/kbialek/deye-inverter-mqtt r <reg_address>
  

  where <reg_address> is register address (decimal)

• To write register value execute:

  docker run --rm --env-file config.env ghcr.io/kbialek/deye-inverter-mqtt w <reg_address> <reg_value>
  

  where <reg_address> is register address (decimal), and <reg_value> is a value to set (decimal)

1. Install python dependencies

   pip install -r requirements.txt
   

2. Running the code
   1. Option 1 - Run the code locally without using Docker
      1. Fill in config.env file
      2. Execute make run
   2. Option 2 - Build a new docker image locally (for amd64 architecture)
      1. Execute make docker-build-local
      2. Fill in config.env file
      3. Execute make docker-run
3. To run the tests use:
   1. make test
   2. make test-mqtt - requires mosquitto MQTT broker binary