List of settings

The firmware offers configurable settings. These settings are grouped into namespaces corresponding to different firmware components.

Settings can be configured via the web configuration menu, the MQTT API, and some settings can be changed indirectly via Modbus.

The following namespaces and settings are available:

mqtt namespace

The following settings are available for the mqtt component:

broker_uri

Type: string
Default: empty
Products: All

The brokers URI, e.g. mqtts://broker.hivemq.com:8883

base_topic

Type: string
Default: {serial}
Products: All

The topic to run the MQTT API under. All topics the device subscribes/posts to are relative to this topic. The tokens {serial} and {default_username} are replaced with the devices serial number and the factory-assigned default username, respectively.

client_id

Type: string
Default: {serial}
Products: All

Client ID to use when connecting to the broker. The tokens {serial} and {default_username} are replaced with the devices serial number and the factory-assigned default username, respectively.

username

Type: string
Default: {default_username}
Products: All

Username to authenticate to the broker with. The tokens {serial} and {default_username} are replaced with the devices serial number and the factory-assigned default username, respectively.

password

Type: string, sensitive
Default: {default_password}
Products: All

Password to authenticate to the broker with. The token {default_password} is replaced with the factory-assigned default password.

ha_discovery

Type: string
Default: empty
Products: All

HomeAssistant MQTT discovery prefix (usually homeassistant). If set, the MQTT client sends a discovery message to {configured prefix}/device/{serial number}/config to tell HomeAssistant about the device and make it available without any HomeAssistant-side configuration. Leave empty to disable HomeAssistant discovery.

heat_msmt_ivl

Type: int, min: 5
Default: 5
Products: P2300(G)/P3000(G)

Interval in seconds for publishing measurements to the {base_topic}/heating/measurements topic. The actual interval can vary to match the internal sensor interval of 5s.

legacy_info_ivl

Type: int, min: 0
Default: 0
Products: P2300(G)/P3000(G)

Interval in seconds for publishing legacy API {base_topic}/info topic. Set to 0 to disable legacy API publishing.

device_temp_ivl

Type: int, min: 0
Default: 0
Products: P2300(G)/P3000(G)

Interval in seconds for publishing measurements to the {base_topic}/device/temperature topic. Set to 0 to disable publishing device temperature measurements. The actual interval can vary to match the internal sensor interval of 15s.

meter_data_ivl

Type: int, min: 0
Default: 5
Products: Sense

Interval in seconds for publishing meter data to the {base_topic}/meter/data topic. Meter data that arrives faster than this interval is not posted. The actual post interval can vary based on the interval the electricity meter provides data. Set to 0 to post all meter data.

meter_raw_data

Type: boolean
Default: false
Products: Sense

Post raw received meter data. For debugging purposes.

wifi namespace

The following settings are available for the wifi component:

ssid

Type: string
Default: empty
Products: All

SSID of the access point to connect to.

pw

Type: string, sensitive
Default: empty
Products: All

Password of the access point to connect to.

heating namespace

The following settings are available for the heating component:

mode

Type: enum, one of off, manual
Default: off
Products: P2300(G)/P3000(G)

The mode of the heating system. off disables heating, manual enables heating.

target_temp

Type: int, min: 0, max: 80
Default: 0
Products: P2300(G)/P3000(G)

The target water temperature for the heating system in °C. Heating will attempt to reach and maintain this temperature.

temp_hyst

Type: int, min: 4, max: 10
Default: 5
Products: P2300(G)/P3000(G)

Hysteresis around the target temperature in °C. Controls distance between where heating turns off due to high temperature, and where heating turns back on due to low temperature. Lower values increase how often the heater switches on and off, potentially increasing hardware wear.

temp_hyst_mode

Type: enum, one of symmetric, below_target
Default: symmetric
Products: P2300(G)/P3000(G)

Where hysteresis on and off temperatures should be located. If set to symmetric, heating turns on below target_temp - temp_hyst/2, and off above target_temp + temp_hyst/2. If set to below_target, heating turns on below target_temp - temp_hyst, and off above target_temp.

target_power

Type: int, min: 0, max: 3000
Default: 0
Products: P2300(G)/P3000(G)

The target power for the heating system in watts.

require_mqtt

Type: boolean
Default: true
Products: P2300(G)/P3000(G)

Only perform heating if connected to an MQTT broker. Enabling this can avoid heating continuing forever if the network or MQTT broker goes down. However, it does not disable heating if the controller stops posting control messages to the MQTT broker.

meter namespace

The following settings are available for the meter component:

autodetect

Type: boolean
Default: true
Products: Sense

Attempt to automatically detect baud rate and protocol. Common combinations of protocols and baud rates will be attempted. Other combinations must be configured manually.

baud_rate

Type: int, min: 0
Default: 9600
Products: Sense

The baud rate used by the meter if autodetection is disabled.

protocol

Type: enum, one of sml, d0
Default: sml
Products: Sense

The protocol used by the meter if autodetection is disabled.