Configuration

Driver

The DRIVER can be umodbus or pymodbus or solarman.

The READ_SENSOR_BATCH_SIZE option allows you to customize how many registers may be read in a single request. Devices like the USR only allows 8 registers to be read. When using mbusd this can be much higher.

The READ_ALLOW_GAP option allows you to set the amount of gap between requested registers. In some cases it makes more sense to read a couple of additional registers in 1 or two requests, than trying to read exactly what you are looking for in multiple requests.

Inverters

The INVERTERS option contains a list of inverters

The following options are required per inverter:

• SERIAL_NR

  The serial number of your inverter. When you start the add-on the connected serial will be displayed in the log.

  The add-on will not run if the expected/configured serial number is not found.

  TIP

  This must be a string. So if your serial is a number only surround it with quotes '1000'

• HA_PREFIX

  A prefix to add to all the MQTT Discovered Home Assistant Sensors (default: SS).

• MODBUS_ID

  The Modbus Server ID is a number typically 1. Might be different in multi-inverter setups.

• DONGLE_SERIAL_NUMBER

  Only required for the solarman driver.

• PORT

  The port used for communications. Format depends on the driver. See Port

Port

The port for RS485 communications, which can be either:

• A tcp:// port toward a Modbus TCP gateway. Either mbusd or one of the hardware options

  INVERTERS:
    - PORT: tcp://homeassistant.local:502

  If your gateway do not support Modbus TCP to Modbus RTU conversion, you can try using serial-tcp:// or serial-udp:// as the port protocol. This will send Modbus RTU framed data over TCP/UDP (RTU-over-TCP).

  Solarman driver details

  The Solarman driver typically uses tcp://, with a port value of 8899. You will need to find the dongle's local IP on your network. You can find the IP on your router, or use a utility like netscan.

  You probably want to set a fixed IP for the dongle on your router.

  DRIVER: solarman
  INVERTER:
    - PORT: tcp://192.168.1.182:8899

  Refer to the Schedules section for recommended schedule overrides.

• A serial port. List of available ports under Supervisor -> System tab -> Host card ⋮ -> Hardware (You can also use the text in the DEBUG_PORT as reference)

  DRIVER: pymodbus
  INVERTERS:
    - PORT: /dev/ttyUSB0

  TIP

  This repository contains a mbusd add-on, a very reliable Modbus TCP to Modbus RTU gateway.

  If you have any issues connecting directly to a serial port, please try mbusd - also see this issue

  TIP

  umodbus requires a serial:// prefix

  DRIVER: umodbus
  INVERTERS:
    - PORT: serial:///dev/ttyUSB0

• For the first inverter in the list, you can use an empty string. The serial port selected under DEBUG_DEVICE will be used (located at the bottom of you config)*

  INVERTERS:
    - PORT: ""

• umodbus support an RFC2217 compatible port (e.g. tcp://homeassistant.local:6610)

Sensors

The SENSOR_DEFINITION option allows you to select between single-phase, three-phase and three-phase-hv sensor definitions.

The SENSORS accepts a list of sensors to poll. Refer to the single and three docs

The SENSORS_FIRST_INVERTER accepts a list of sensors that will only be applied to the first inverter

Schedules

Refer to Schedules

Home Assistant Discovery options

The per-inverter HA_PREFIX will be used for the Device (the Inverter) name and the prefix to all the entity Ids in Home Assistant

The MANUFACTURER option allows you to rename the inverter manufacturer that will be displayed on the Home Assistant device. It does not have to be Sunsynk 😉

The NUMBER_ENTITY_MODE option allows you to change how read/write sensors which present as number entities in Home Assistant behave. The default display mode is auto. This setting controls how the number entity should be displayed in the UI. Can be set to box or slider to force a display mode.

The PROG_TIME_INTERVAL option allows you to change the time interval in the lists for setting the program time. Be aware that if you set this to 5 mnutes you will have a very long select list of times to scroll through.

MQTT Settings

You will need a working MQTT server since all values will be sent via MQTT toward Home Assistant.

The default configuration assumes the Mosquitto broker add-on and you simply have to fill in your password.

MQTT_HOST: core-mosquitto
MQTT_PORT: 1883
MQTT_USERNAME: hass
MQTT_PASSWORD: my-secure-password

Debug options

• DEBUG

  The values received will continuously be printed to the add-on's log. This will confirm that you receive values.

  Value	Description
  0	No debug messages.
  1	Messages for filter changes.
  2	Debug level logging.

• DEBUG_DEVICE allows you to select the USB port in the UI. It will only be used if PORT is empty. But you have to select something.