Configuration kword - s-allius/tsun-gen3-proxy GitHub Wiki
The keywords defined in the following tables are available for configuring the proxy. Either the TOML or the JSON format can be used for setting. In the Home Assistant add-on, only the values for the devices can be set in a text box. All other values can be set via the UI.
You can find more information and examples of the individual formats here:
keyword | type | mandatory/optional | description |
---|---|---|---|
tsun.enabled | bool | mandatory | false: no connection to TSUN cloud, no updates true: normal proxy operation |
tsun.host | string | mandatory | The hostname or IP address of the TSUN server default: logger.talent-monitoring.com
|
tsun.port | int (1024...65535) |
mandatory | The network port of the TSUN servery default: 5005
|
keyword | type | mandatory/optional | description |
---|---|---|---|
solarman.enabled | bool | mandatory | false: no connection to TSUN cloud, no updates true: normal proxy operation |
solarman.host | string | mandatory | The hostname or IP address of the TSUN server default: iot.talent-monitoring.com
|
solarman.port | int (1024...65535) |
mandatory | The network port of the TSUN servery default: 10000
|
keyword | type | mandatory/optional | description |
---|---|---|---|
mqtt.host | string | mandatory | The hostname or IP address of the MQTT broker default: mqtt
|
mqtt.port | int (1024...65535) |
mandatory | The network port of the remote broker default 1883
|
mqtt.user | string | mandatory | The username to authenticate with default: <empty>
|
mqtt.passwd | string | mandatory | The password to authenticate with default: <empty>
|
keyword | type | mandatory/optional | description |
---|---|---|---|
ha.auto_conf_prefix | string | mandatory | MQTT prefix for subscribing for homeassistant status updates |
ha.discovery_prefix | string | mandatory | MQTT prefix for discovery topic |
ha.entity_prefix | string | mandatory | MQTT topic prefix for publishing inverter values |
ha.proxy_node_id | string | mandatory | MQTT node id, for the proxy_node_id |
ha.proxy_unique_id | string | mandatory | MQTT unique id, to identify a proxy instance |
keyword | type | mandatory/optional | description |
---|---|---|---|
inverters.allow_all | bool | mandatory | true: allow inverters, even if we have no inverter definition block with a matching serial number |
[inverters."<inverters-serial>"] | table | optional | Named index of a inverter definition block |
The inverter definition block must begin with a named index line such as [inverters."<inverters-serial>"]
. All subsequent lines are part of this block until a new block is started with a new index line with square brackets.
keyword | type | gen | mandatory/optional | description |
---|---|---|---|---|
node_id | string | all | mandatory | MQTT replacement for inverters serial number |
suggested_area | string | all | optional | Suggested installation place for home-assistant |
monitor_sn | int | GEN3PLUS | mandatory | The "Monitoring SN:" can be found on a sticker enclosed with the inverter |
modbus_polling | bool | all | optional | false: disable MODBUS polling true: enable MODBUS polling (default) |
client_mode.host | string | GEN3PLUS | optional | Inverter IP addr for client mode |
client_mode.port | int | GEN3PLUS | optional | Inverter TCP port of client-mode connection default: 8899 |
client_mode.forward | bool | GEN3PLUS | optional | false: disable forwarding (default) true: enable forwarding to TSUN cloud |
modbus_scanning.start | int | all | optional | MODBUS scanner: start adress |
modbus_scanning.step | int | all | optional | MODBUS scanner: step width default: 0x400 |
modbus_scanning.bytes | int | all | optional | MODBUS scanner: no of byte to read default: 0x10 |
sensor_list | int | GEN3PLUS | optional | no of the register definition default: 0 (auto-mode) |
pv<1..6>.type | string | all | optional | Type of the PV module 1..6 |
pv<1..6>.manufacturer | string | all | optional | Manufacturer of the PV module 1..6 |
keyword | type | mandatory/optional | description |
---|---|---|---|
[batteries."<serial-number>"] | table | optional | Named index of a batterie definition block |
The batterie definition block must begin with a named index line such as [batteries."<serial-number>"]
. All subsequent lines are part of this block until a new block is started with a new index line with square brackets.
keyword | type | gen | mandatory/optional | description |
---|---|---|---|---|
node_id | string | all | mandatory | MQTT replacement for inverters serial number |
suggested_area | string | all | optional | Suggested installation place for home-assistant |
monitor_sn | int | GEN3PLUS | mandatory | The "Monitoring SN:" can be found on a sticker enclosed with the inverter |
modbus_polling | bool | all | optional | false: disable MODBUS polling true: enable MODBUS polling (default) |
client_mode.host | string | GEN3PLUS | optional | Inverter IP addr for client mode |
client_mode.port | int | GEN3PLUS | optional | Inverter TCP port of client-mode connection default: 8899 |
client_mode.forward | bool | GEN3PLUS | optional | false: disable forwarding (default) true: enable forwarding to TSUN cloud |
modbus_scanning.start | int | all | optional | MODBUS scanner: start adress |
modbus_scanning.step | int | all | optional | MODBUS scanner: step width default: 0x400 |
modbus_scanning.bytes | int | all | optional | MODBUS scanner: no of byte to read default: 0x10 |
sensor_list | int | GEN3PLUS | optional | no of the register definition default: 0 (auto-mode) |
pv<1..2>.type | string | all | optional | Type of the PV module 1..2 |
pv<1..2>.manufacturer | string | all | optional | Manufacturer of the PV module 1..2 |
If this configuration block follows an inverter definition block, you must use an index line with square brackets such as [gen3plus.at_acl]
and must omit the index gen3plus.at_acl.
in the associated lines.
keyword | type | mandatory/optional | description |
---|---|---|---|
gen3plus.at_acl.tsun.allow | string | mandatory | List of AT commands, which are allowed |
gen3plus.at_acl.tsun.block | string | optional | List of AT commands, which will be blocked |
gen3plus.at_acl.mqtt.allow | string | mandatory | List of AT commands, which are allowed |
gen3plus.at_acl.mqtt.block | string | optional | List of AT commands, which will be blocked |