victron_mqtt

Victron MQTT Protocol Overview

The Victron MQTT protocol is used by Victron Energy devices to publish and subscribe to real-time data over an MQTT broker. This protocol enables seamless integration of Victron devices—such as inverters, chargers, battery monitors, and solar controllers—into home automation, monitoring, and energy management systems.

How It Works

Supported Victron Devices

Note: To use the Victron MQTT protocol, you must have a Cerbo GX, Venus GX, or Color Control GX device (collectively known as GX devices). These GX devices act as gateways, exposing data from connected Victron products via MQTT. Other Victron devices (such as inverters, solar controllers, and battery monitors) do not expose MQTT directly—they must be connected to a GX device, which then publishes their data to the MQTT broker.

Common MQTT Topics

Each device type publishes to a set of standardized topics. For example:

MQTT Topics

Topic Short ID Name Unit Message Type Metric Type Metric Nature Device Type Value Type Precision Enum Min Max
N/{installation_id}/system/{device_id}/Ac/Grid/NumberOfPhases system_grid_phases Grid phases SENSOR NONE INSTANTANEOUS INT_DEFAULT_0
N/{installation_id}/grid/{device_id}/Ac/{phase}/Voltage grid_voltage_{phase} Grid voltage on {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/grid/{device_id}/Ac/{phase}/Current grid_current_{phase} Grid current on {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/{phase}/Power grid_power_{phase} Grid power on {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/{phase}/Energy/Forward grid_energy_forward_{phase} Grid consumption on {phase} kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/{phase}/Energy/Reverse grid_energy_reverse_{phase} Grid feed-in on {phase} kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/PENVoltage grid_voltage_pen Grid voltage on PEN V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/grid/{device_id}/Ac/N/Current grid_current_n Grid current on N A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/Frequency grid_frequency Grid frequency Hz SENSOR FREQUENCY INSTANTANEOUS FLOAT 2
N/{installation_id}/grid/{device_id}/Ac/{phase}/VoltageLineToLine grid_voltage_{phase}_{next_phase} Grid voltage {phase} to {next_phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/grid/{device_id}/Ac/Voltage grid_voltage Grid voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/grid/{device_id}/Ac/Current grid_current Grid current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/Power grid_power Grid power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/Energy/Forward grid_energy_forward Grid consumption kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/grid/{device_id}/Ac/Energy/Reverse grid_energy_reverse Grid feed-in kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Dc/0/Voltage solarcharger_dc_voltage DC (Batt) Bus voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/solarcharger/{device_id}/Dc/0/Current solarcharger_dc_current DC (Batt) Bus current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Load/I solarcharger_load_current Load Bus current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Pv/V solarcharger_voltage PV Bus Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/solarcharger/{device_id}/State solarcharger_state Solar Charger State SENSOR NONE NONE ENUM State
N/{installation_id}/solarcharger/{device_id}/ErrorCode solarcharger_error_code Solar Charger Error Code SENSOR NONE NONE ENUM ErrorCode
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MinBatteryVoltage solarcharger_min_battery_voltage_today Solar Charger Min Battery Voltage Today V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MaxBatteryVoltage solarcharger_max_battery_voltage_today Solar Charger Max Battery Voltage Today V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInAbsorption solarcharger_time_in_absorption_today Solar Charger Time in Absorption Today s SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInFloat solarcharger_time_in_float_today Solar Charger Time in Float Today s SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInBulk solarcharger_time_in_bulk_today Solar Charger Time in Bulk Today s SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/system/{device_id}/Dc/Pv/Power solarcharger_power PV Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/PV/Current solarcharger_current PV Bus current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Yield/Power solarcharger_yield_power PV Yield Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Yield/User solarcharger_yield_total Total Yield kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/Yield solarcharger_yield_today Yield Today kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/solarcharger/{device_id}/History/Daily/1/Yield solarcharger_yield_yesterday Yield Yesterday kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MaxPower solarcharger_max_power_today Max Power Today W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/History/Daily/1/MaxPower solarcharger_max_power_yesterday Max Power Yesterday W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/solarcharger/{device_id}/Load/State solarcharger_load_state Solar Charger Load State BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/solarcharger/{device_id}/Mode solarcharger_mode Solar Charger Mode SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/solarcharger/{device_id}/MppOperationMode solarcharger_mppt_operation_mode Solar Charger MPPT Operation Mode SENSOR NONE NONE ENUM MultiState
N/{installation_id}/solarcharger/{device_id}/Relay/0/State solarcharger_relay_state Solar Charger Relay State SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/battery/{device_id}/Dc/0/Voltage battery_voltage DC Bus voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/battery/{device_id}/Dc/0/Current battery_current DC Bus current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/Dc/0/Power battery_power Battery power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/Dc/0/Temperature battery_temperature Battery temperature °C SENSOR TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/Dc/1/Voltage auxiliary_battery_voltage Auxiliary battery voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/battery/{device_id}/History/DischargedEnergy battery_discharged_energy Discharged energy kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/battery/{device_id}/History/ChargedEnergy battery_charged_energy Charged energy kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/battery/{device_id}/History/AutomaticSyncs battery_automatic_syncs Automatic syncs count SENSOR NONE CUMULATIVE INT
N/{installation_id}/battery/{device_id}/Capacity battery_capacity Battery capacity Ah SENSOR ELECTRIC_STORAGE_CAPACITY INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/InstalledCapacity battery_installed_capacity Battery installed capacity Ah SENSOR ELECTRIC_STORAGE_CAPACITY INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/Soc battery_soc Battery charge % SENSOR ELECTRIC_STORAGE_PERCENTAGE INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/System/MinCellVoltage battery_min_cell_voltage Battery minimum cell voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/battery/{device_id}/System/MaxCellVoltage battery_max_cell_voltage Battery maximum cell voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/battery/{device_id}/Soh battery_soh Battery State of Health % SENSOR PERCENTAGE NONE FLOAT 2
N/{installation_id}/battery/{device_id}/System/NrOfModulesBlockingCharge battery_nr_modules_blocking_charge Battery number of modules blocking charge SENSOR NONE NONE INT
N/{installation_id}/battery/{device_id}/System/NrOfModulesBlockingDischarge battery_nr_modules_blocking_discharge Battery number of modules blocking discharge SENSOR NONE NONE INT
N/{installation_id}/battery/{device_id}/System/NrOfModulesOnline battery_nr_modules_online Battery number of modules online SENSOR NONE NONE INT
N/{installation_id}/battery/{device_id}/System/NrOfModulesOffline battery_nr_modules_offline Battery number of modules offline SENSOR NONE NONE INT
N/{installation_id}/battery/{device_id}/System/MinCellTemperature battery_min_cell_temperature Battery minimum cell temperature °C SENSOR TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/System/MaxCellTemperature battery_max_cell_temperature Battery maximum cell temperature °C SENSOR TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/TimeToGo battery_time_to_go Battery time to go s SENSOR TIME INSTANTANEOUS INT
N/{installation_id}/battery/{device_id}/Info/ChargeMode charge_mode Battery charge mode SENSOR NONE NONE STRING
N/{installation_id}/battery/{device_id}/ConsumedAmphours battery_consumed_amphours Battery consumed amp-hours Ah SENSOR ELECTRIC_STORAGE_CAPACITY INSTANTANEOUS FLOAT 1
N/{installation_id}/battery/{device_id}/Voltages/Cell{cell_id(1-8)} battery_cell_{cell_id}_voltage Battery cell {cell_id} voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/battery/{device_id}/Alarms/HighChargeCurrent battery_high_charge_current Battery high charge current SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/HighDischargeCurrent battery_high_discharge_current Battery high discharge current SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/CellImbalance battery_cell_imbalance Battery cell imbalance SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/InternalFailure battery_internal_failure Battery internal failure SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/HighChargeTemperature battery_high_charge_temperature Battery high charge temperature SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/LowChargeTemperature battery_low_charge_temperature Battery low charge temperature SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/battery/{device_id}/Alarms/LowCellVoltage battery_low_cell_voltage Battery low cell voltage SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/vebus/{device_id}/Mode vebus_inverter_mode Inverter mode SELECT NONE NONE ENUM InverterMode
N/{installation_id}/vebus/{device_id}/State vebus_inverter_state Inverter state SENSOR NONE NONE ENUM State
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/V vebus_inverter_input_voltage_{phase} Inverter input voltage {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/P vebus_inverter_input_power_{phase} Inverter input power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/F vebus_inverter_input_frequency_{phase} Inverter input frequency {phase} Hz SENSOR FREQUENCY INSTANTANEOUS FLOAT 2
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/S vebus_inverter_input_apparent_power_{phase} Inverter input apparent power {phase} VA SENSOR APPARENT_POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/P vebus_inverter_output_power_{phase} Inverter output power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/F vebus_inverter_output_frequency_{phase} Inverter output frequency {phase} Hz SENSOR FREQUENCY INSTANTANEOUS FLOAT 2
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/S vebus_inverter_output_apparent_power_{phase} Inverter output apparent power {phase} VA SENSOR APPARENT_POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/vebus/{device_id}/Connected vebus_inverter_connected Inverter connected BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/vebus/{device_id}/Alarms/Overload vebus_inverter_alarm_overload Inverter overload alarm SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/CurrentLimit vebus_inverter_current_limit Inverter current limit A NUMBER CURRENT INSTANTANEOUS INT 1 0 16
N/{installation_id}/inverter/{device_id}/Mode inverter_mode Inverter mode SELECT NONE NONE ENUM PhoenixInverterMode
N/{installation_id}/inverter/{device_id}/State inverter_state Inverter state SENSOR NONE NONE ENUM State
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/V inverter_output_voltage_{phase} Inverter output voltage {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/P inverter_output_power_{phase} Inverter output power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/S inverter_output_apparent_power_{phase} Inverter output apparent power {phase} VA SENSOR APPARENT_POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/I inverter_output_current_{phase} Inverter output current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/inverter/{device_id}/Alarms/Ripple inverter_alarm_ripple Inverter alarm Ripple BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/LowVoltageAcOut inverter_alarm_low_voltage_ac_out Inverter alarm LowVoltageAcOut BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/LowVoltage inverter_alarm_low_voltage Inverter alarm LowVoltage BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/HighVoltageAcOut inverter_alarm_high_voltage_ac_out Inverter alarm HighVoltageAcOut BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/HighTemperature inverter_alarm_high_temperature Inverter alarm HighTemperature BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/HighVoltage inverter_alarm_high_voltage Inverter alarm HighVoltage BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/LowTemperature inverter_alarm_low_temperature Inverter alarm LowTemperature BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/inverter/{device_id}/Alarms/Overload inverter_alarm_overload Inverter alarm Overload BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/vebus/{device_id}/Settings/AssistCurrentBoostFactor multiplus_assist_current_boost_factor Assist Current Boost Factor NUMBER NONE NONE FLOAT 3 0.25 3.5
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnOutput/{phase}/Power system_critical_loads_{phase} Critical loads on {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnInput/{phase}/Power system_ac_loads_{phase} AC loads on {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Dc/System/Power system_dc_consumption DC Consumption W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Dc/Battery/Soc system_dc_battery_soc DC Battery Charge % SENSOR ELECTRIC_STORAGE_PERCENTAGE INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Dc/Battery/Power system_dc_battery_power DC Battery Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Dc/Battery/Voltage system_dc_battery_voltage DC Battery Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/system/{device_id}/Dc/Battery/Current system_dc_battery_current DC Battery Current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Relay/{relay}/State system_relay_{relay} Relay {relay} state SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/system/{device_id}/DynamicEss/Available system_dynamicess_available Dynamic ESS Available BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/system/{device_id}/DynamicEss/Active system_dynamicess_active Dynamic ESS Active BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/system/{device_id}/DynamicEss/AllowGridFeedIn system_dynamicess_allow_gridfeedin Dynamic ESS Allow Grid Feed In BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/system/{device_id}/DynamicEss/AvailableOverhead system_dynamicess_available_overhead Dynamic ESS Available Overhead W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/DynamicEss/ErrorCode system_dynamicess_error Dynamic ESS Error SENSOR NONE NONE ENUM DESSErrorCode
N/{installation_id}/system/{device_id}/DynamicEss/NumberOfSchedules system_dynamicess_schedule_count Dynamic ESS Number Of Schedules SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/system/{device_id}/DynamicEss/TargetSoc system_dynamicess_target_soc Dynamic ESS Target SOC % SENSOR ELECTRIC_STORAGE_PERCENTAGE INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/DynamicEss/MinimumSoc system_dynamicess_minimum_soc Dynamic ESS Minimum SOC % SENSOR ELECTRIC_STORAGE_PERCENTAGE INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/DynamicEss/LastScheduledStart system_dynamicess_last_scheduled_start Dynamic ESS Last Scheduled Start SENSOR NONE NONE EPOCH
N/{installation_id}/system/{device_id}/DynamicEss/LastScheduledEnd system_dynamicess_last_scheduled_end Dynamic ESS Last Scheduled End SENSOR NONE NONE EPOCH
N/{installation_id}/system/{device_id}/DynamicEss/Restrictions system_dynamicess_restrictions Dynamic ESS Restrictions SENSOR NONE NONE ENUM DESSRestrictions
N/{installation_id}/system/{device_id}/DynamicEss/Strategy system_dynamicess_strategy Dynamic ESS Strategy SENSOR NONE NONE ENUM DESSStrategy
N/{installation_id}/system/{device_id}/DynamicEss/ReactiveStrategy system_dynamicess_reactive_strategy Dynamic ESS Reactive Strategy SENSOR NONE NONE ENUM DESSReactiveStrategy
N/{installation_id}/system/{device_id}/Ac/Genset/{phase}/Power system_generator_load_{phase} Genset Load {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/Grid/{phase}/Power system_grid_power_{phase} Grid Power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/NumberOfPhases system_pv_on_output_phases PV on Output phases SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/{phase}/Power system_pv_on_output_power_{phase} PV on Output Power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/{phase}/Current system_pv_on_output_current_{phase} PV on Output Current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnOutput/NumberOfPhases system_consumption_on_output_phases Consumption On Output phases SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/system/{device_id}/Ac/Consumption/NumberOfPhases system_consumption_phases Consumption phases SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/system/{device_id}/Ac/Consumption/{phase}/Power system_consumption_power_{phase} Consumption Power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/Consumption/{phase}/Current system_consumption_current_{phase} Consumption Current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/system/{device_id}/Ac/Grid/{phase}/Current system_grid_current_{phase} Grid Current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/evcharger/{device_id}/Mode evcharger_mode EV charger mode SELECT NONE NONE ENUM EvChargerMode
N/{installation_id}/evcharger/{device_id}/StartStop evcharger_charge EV charger charge SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/evcharger/{device_id}/Connected evcharger_connected EV charger connected BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/evcharger/{device_id}/Current evcharger_current EV charger current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/evcharger/{device_id}/Ac/{phase}/Power evcharger_power_{phase} EV charger power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/evcharger/{device_id}/SetCurrent evcharger_set_current EV charger set current A NUMBER CURRENT INSTANTANEOUS INT 1 0 16
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Voltage pvinverter_voltage_{phase} Voltage {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Current pvinverter_current_{phase} Current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/pvinverter/{device_id}/Ac/Power pvinverter_power_total Power Total W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Power pvinverter_power_{phase} Power {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/pvinverter/{device_id}/Ac/Energy/Forward pvinverter_yield_total Total Yield kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Energy/Forward pvinverter_yield_{phase} Yield {phase} kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/temperature/{device_id}/Temperature temperature_temperature Temperature °C SENSOR TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/temperature/{device_id}/Status temperature_status Temperature sensor status SENSOR NONE NONE ENUM TemperatureStatus
N/{installation_id}/temperature/{device_id}/TemperatureType temperature_type Temperature sensor type SENSOR NONE NONE ENUM TemperatureType
N/{installation_id}/temperature/{device_id}/BatteryVoltage temperature_battery_voltage Temperature sensor battery voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/temperature/{device_id}/Humidity temperature_humidity Humidity % SENSOR PERCENTAGE INSTANTANEOUS FLOAT 1
N/{installation_id}/temperature/{device_id}/Offset temperature_offset Temperature offset °C NUMBER TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/temperature/{device_id}/Scale temperature_scale Temperature scale factor NUMBER NONE INSTANTANEOUS FLOAT 2
N/{installation_id}/tank/{device_id}/Level tank_level Level % SENSOR PERCENTAGE INSTANTANEOUS INT
N/{installation_id}/tank/{device_id}/BatteryVoltage tank_battery_voltage Tank sensor battery voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/tank/{device_id}/Remaining tank_remaining Remaining SENSOR LIQUID_VOLUME CUMULATIVE FLOAT 2
N/{installation_id}/tank/{device_id}/Temperature tank_temperature Temperature °C SENSOR TEMPERATURE INSTANTANEOUS FLOAT 1
N/{installation_id}/tank/{device_id}/FluidType tank_fluid_type Fluid Type SENSOR NONE NONE ENUM FluidType
N/{installation_id}/multi/{device_id}/Ac/NumberOfPhases multirssolar_phases Phases SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/V multirssolar_acin_voltage_{phase} Voltage on {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/I multirssolar_acin_current_{phase} Current {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/P multirssolar_acin_power_{phase} Power on {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/V multirssolar_acout_{output}_voltage_{phase} AC Out {output} Voltage on {phase} V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/I multirssolar_acout_{output}_current_{phase} AC Out {output} Current on {phase} A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/P multirssolar_acout_{output}_power_{phase} AC Out {output} Power on {phase} W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/State multirssolar_state State SENSOR NONE NONE ENUM State
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/V multirssolar_mppt_{mpptnumber}_voltage MPPT {mpptnumber} PV Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/P multirssolar_mppt_{mpptnumber}_power MPPT {mpptnumber} Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/MppOperationMode multirssolar_mppt_{mpptnumber}_state MPPT {mpptnumber} state SENSOR NONE NONE ENUM MultiState
N/{installation_id}/multi/{device_id}/Yield/Power multirssolar_pv_power_total PV Power Total W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Yield/User multirssolar_total_pv_yield Total PV Yield kWh SENSOR ENERGY CUMULATIVE FLOAT 1
N/{installation_id}/multi/{device_id}/Settings/Ess/Mode multirssolar_ess_mode ESS Mode SENSOR NONE NONE ENUM ESSMode
N/{installation_id}/multi/{device_id}/Ess/AcPowerSetpoint multirssolar_ess_ac_power_set_point ESS AC Power Setpoint W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/multi/{device_id}/Ess/InverterPowerSetpoint multirssolar_inverter_power_setpoint Inverter Power Setpoint W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/alternator/{device_id}/Dc/0/Voltage alternator_dc_voltage DC Output Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/alternator/{device_id}/Dc/0/Current alternator_dc_current DC Output Current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/alternator/{device_id}/Dc/0/Power alternator_dc_power DC Output Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/alternator/{device_id}/In/V alternator_input_voltage Input Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/alternator/{device_id}/In/I alternator_input_current Input Current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/alternator/{device_id}/In/P alternator_input_power Input Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/settings/{device_id}/Settings/CGwacs/AcPowerSetPoint system_ac_power_set_point AC Power Setpoint W NUMBER POWER INSTANTANEOUS INT 1 -10000 10000
N/{installation_id}/settings/{device_id}/Settings/CGwacs/OvervoltageFeedIn system_settings_overvoltage_feedin PV DC Overvoltage FeedIn SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/MinimumSocLimit system_ess_min_soc_limit ESS min SOC limit % NUMBER ELECTRIC_STORAGE_PERCENTAGE INSTANTANEOUS INT 1
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/MaxChargeCurrent system_ess_max_charge_current ESS max charge current A NUMBER CURRENT INSTANTANEOUS INT 1
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/MaxChargeVoltage system_ess_max_charge_voltage ESS max charge voltage V NUMBER VOLTAGE INSTANTANEOUS FLOAT 2
N/{installation_id}/dcload/{device_id}/Dc/0/Voltage dcload_voltage DC load voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/dcload/{device_id}/Dc/0/Current dcload_current DC load current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/dcload/{device_id}/Dc/0/Power dcload_power DC load power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/switch/{device_id}/SwitchableOutput/output_{output(1-4)}/State switch_{output}_state Switch {output} State SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/switch/{device_id}/SwitchableOutput/output_{output(1-4)}/Dimming switch_{output}_dimming Switch {output} Dimming NUMBER NONE NONE INT 0 100
N/{installation_id}/gps/{device_id}/Altitude gps_altitude GPS Altitude SENSOR NONE INSTANTANEOUS FLOAT
N/{installation_id}/gps/{device_id}/Connected gps_connected GPS Connected BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/gps/{device_id}/Course gps_course GPS Course SENSOR HEADING INSTANTANEOUS FLOAT 2
N/{installation_id}/gps/{device_id}/Fix gps_fix GPS Fix BINARY_SENSOR NONE NONE ENUM GenericOnOff
N/{installation_id}/gps/{device_id}/Speed gps_speed GPS Speed SENSOR SPEED INSTANTANEOUS FLOAT 2
N/{installation_id}/gps/{device_id}/NrOfSatellites gps_nrofsatellites GPS Nr Of Satellites SENSOR NONE INSTANTANEOUS INT
N/{installation_id}/gps/{device_id}/Position/Latitude gps_latitude GPS Latitude SENSOR LOCATION INSTANTANEOUS FLOAT
N/{installation_id}/gps/{device_id}/Position/Longitude gps_longitude GPS Longitude SENSOR LOCATION INSTANTANEOUS FLOAT
N/{installation_id}/settings/{device_id}/Settings/CGwacs/MaxDischargePower system_ess_max_inverter_power_limit ESS max inverter power limit W NUMBER POWER INSTANTANEOUS INT 1
W/{installation_id}/generator/{device_id}/ServiceCounterReset generator_service_counter_reset Generator service counter reset SERVICE NONE NONE INT
N/{installation_id}/generator/{device_id}/TodayRuntime generator_today_runtime Generator today runtime h SENSOR TIME INSTANTANEOUS INT_SECONDS_TO_HOURS
N/{installation_id}/generator/{device_id}/AccumulatedRuntime generator_total_runtime Generator total runtime h SENSOR TIME CUMULATIVE INT_SECONDS_TO_HOURS
N/{installation_id}/generator/{device_id}/ServiceCounter generator_service_counter Generator service counter h SENSOR TIME CUMULATIVE INT_SECONDS_TO_HOURS
N/{installation_id}/generator/{device_id}/RunningByConditionCode generator_run_state Generator run state SENSOR NONE NONE ENUM GeneratorRunningByConditionCode
N/{installation_id}/generator/{device_id}/AutoStartEnabled generator_autorun Generator auto start enabled SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/generator/{device_id}/ManualStart generator_manual_start Generator manual start SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/QuietHours/Enabled generator_{gen_id}_quiet_hours_enabled Generator quiet hours enabled SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/Enabled generator_{gen_id}_start_on_soc_enabled Generator start on SOC enabled SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/Enabled generator_{gen_id}_start_on_voltage_enabled Generator start on voltage enabled SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/Enabled generator_{gen_id}_start_on_temp_enabled Generator start on high temp enabled SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StartValue generator_{gen_id}_start_on_soc Generator start on SOC NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StopValue generator_{gen_id}_stop_on_soc Generator stop on SOC NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/QuietHoursStartValue generator_{gen_id}_qh_start_on_soc Generator QH start on SOC NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/QuietHoursStopValue generator_{gen_id}_qh_stop_on_soc Generator QH stop on SOC NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StartTimer generator_{gen_id}_start_on_soc_timer Generator start on SOC timer s NUMBER NONE NONE INT 0 10000
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StopTimer generator_{gen_id}_stop_on_soc_timer Generator stop on SOC timer s NUMBER NONE NONE INT 0 10000
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StartValue generator_{gen_id}_start_on_voltage Generator start on voltage V NUMBER VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StopValue generator_{gen_id}_stop_on_voltage Generator stop on voltage V NUMBER VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/QuietHoursStartValue generator_{gen_id}_qh_start_on_voltage Generator QH start on voltage V NUMBER VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/QuietHoursStopValue generator_{gen_id}_qh_stop_on_voltage Generator QH stop on voltage V NUMBER VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StartTimer generator_{gen_id}_start_on_voltage_timer Generator start on voltage timer s NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StopTimer generator_{gen_id}_stop_on_voltage_timer Generator stop on voltage timer s NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/StartTimer generator_{gen_id}_start_on_temp_timer Generator start on temp timer s NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/StopTimer generator_{gen_id}_stop_on_temp_timer Generator stop on temp timer s NUMBER NONE NONE INT
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/CoolDownTime generator_{gen_id}_cool_down_timer Generator cool down timer s NUMBER NONE NONE INT 0 600
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/WarmUpTime generator_{gen_id}_warm_up_timer Generator warm up timer s NUMBER NONE NONE INT 0 1800
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/GeneratorStopTime generator_{gen_id}_shut_down_timer Generator shut down timer s NUMBER NONE NONE INT 0 600
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/ServiceInterval generator_{gen_id}_service_interval Generator service interval h NUMBER NONE NONE INT_SECONDS_TO_HOURS 0 500
N/{installation_id}/settings/{device_id}/Settings/TransferSwitch/GeneratorCurrentLimit transfer_switch_generator_current_limit Generator AC current limit A NUMBER CURRENT INSTANTANEOUS INT 1 0 60
N/{installation_id}/digitalinput/{device_id}/InputState digitalinput_input_state_raw Digital input raw state SENSOR NONE NONE ENUM DigitalInputInputState
N/{installation_id}/digitalinput/{device_id}/Type digitalinput_type Digital input type SENSOR NONE NONE ENUM DigitalInputType
N/{installation_id}/digitalinput/{device_id}/State digitalinput_state Digital input state SENSOR NONE NONE ENUM DigitalInputState
N/{installation_id}/digitalinput/{device_id}/Alarm digitalinput_alarm Digital input alarm SENSOR NONE NONE ENUM GenericAlarmEnum
N/{installation_id}/digitalinput/{device_id}/Settings/InvertTranslation digitalinput_settings_invert_translation Digital input settings invert translation SWITCH NONE NONE ENUM GenericOnOff
N/{installation_id}/dcsystem/{device_id}/Dc/0/Voltage dcsystem_voltage DC System Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3
N/{installation_id}/dcsystem/{device_id}/Dc/0/Current dcsystem_current DC System Current A SENSOR CURRENT INSTANTANEOUS FLOAT 1
N/{installation_id}/dcsystem/{device_id}/Dc/0/Power dcsystem_power DC System Power W SENSOR POWER INSTANTANEOUS FLOAT 1
N/{installation_id}/dcsystem/{device_id}/Dc/1/Voltage dcsystem_aux_voltage DC System Auxiliary Voltage V SENSOR VOLTAGE INSTANTANEOUS FLOAT 3

Enums

Enums represent the possible states or values for certain device properties, such as operational modes, alarm states, or relay statuses. These are useful for interpreting numeric codes in MQTT payloads.

DESSErrorCode

IdValueDisplay Name
NO_ERROR 0 No Error
NO_ESS 1 No ESS
ESS_MODE 2 ESS Mode
NO_SCHEDULE 3 No Matching Schedule
SOC_LOW 4 SOC low
BATTRY_CAPACITY_NOT_CONFIGURED 5 Battery Capacity Not Configured

DESSReactiveStrategy

IdValueDisplay Name
SCHEDULED_SELFCONSUME 1 Scheduled Self-Consume
SCHEDULED_CHARGE_ALLOW_GRID 2 Scheduled Charge Allow Grid
SCHEDULED_CHARGE_ENHANCED 3 Scheduled Charge Enhanced
SELFCONSUME_ACCEPT_CHARGE 4 Self-Consume Accept Charge
IDLE_SCHEDULED_FEEDIN 5 Idle Scheduled Feed-In
SCHEDULED_DISCHARGE 6 Scheduled Discharge
SELFCONSUME_ACCEPT_DISCHARGE 7 Self-Consume Accept Discharge
IDLE_MAINTAIN_SURPLUS 8 Idle Maintain Surplus
IDLE_MAINTAIN_TARGETSOC 9 Idle Maintain Target SOC
SCHEDULED_CHARGE_SMOOTH_TRANSITION 10 Scheduled Charge Smooth Transition
SCHEDULED_CHARGE_FEEDIN 11 Scheduled Charge Feed-In
SCHEDULED_CHARGE_NO_GRID 12 Scheduled Charge No Grid
SCHEDULED_MINIMUM_DISCHARGE 13 Scheduled Minimum Discharge
SELFCONSUME_NO_GRID 14 Self-Consume No Grid
IDLE_NO_OPPORTUNITY 15 Idle No Opportunity
UNSCHEDULED_CHARGE_CATCHUP_TARGETSOC 16 Unscheduled Charge Catch-Up Target SOC
SELFCONSUME_INCREASED_DISCHARGE 17 Self-Consume Increased Discharge
KEEP_BATTERY_CHARGED 18 Keep Battery Charged
SCHEDULED_DISCHARGE_SMOOTH_TRANSITION 19 Scheduled Discharge Smooth Transition
DESS_DISABLED 92 DESS Disabled
SELFCONSUME_UNEXPECTED_EXCEPTION 93 Self-Consume Unexpected Exception
SELFCONSUME_FAULTY_CHARGERATE 94 Self-Consume Faulty Charge Rate
UNKNOWN_OPERATING_MODE 95 Unknown Operating Mode
ESS_LOW_SOC 96 ESS Low SOC
SELFCONSUME_UNMAPPED_STATE 97 Self-Consume Unmapped State
SELFCONSUME_UNPREDICTED 98 Self-Consume Unpredicted
NO_WINDOW 99 No Window

DESSRestrictions

IdValueDisplay Name
NO_RESTRICTIONS 0 No Restrictions between battery and the grid
GRID_TO_BATTERY_RESTRICTED 1 Grid to battey energy flow restricted
BATTERY_TO_GRID_RESTRICTED 2 Battery to grid energy flow restricted
NO_FLOW 3 No energy flow between battery and grid

DESSStrategy

IdValueDisplay Name
TARGETSOC 0 Target SOC
SELFCONSUME 1 Self-Consume
PROBATTERY 2 Pro Battery
PROGRID 3 Pro Grid

DeviceType

IdValueDisplay Name
SYSTEM system System
SOLAR_CHARGER solarcharger Solar Charger
INVERTER inverter Inverter
BATTERY battery Battery
GRID grid Grid
VEBUS vebus VE.Bus
EVCHARGER evcharger EV Charging Station
PVINVERTER pvinverter PV Inverter
TEMPERATURE temperature Temperature
GENERATOR generator Generator
GENERATOR0 Generator0 Generator 0 Settings
GENERATOR1 Generator1 Generator 1 Settings
TANK tank Liquid Tank
MULTI_RS_SOLAR multi Multi RS Solar
CGWACS CGwacs
DC_LOAD dcload DC Load
ALTERNATOR alternator Charger (Orion/Alternator)
SWITCH switch Switch
GPS gps Gps
SYSTEM_SETUP SystemSetup System Setup
TRANSFER_SWITCH TransferSwitch Transfer Switch
DIGITAL_INPUT digitalinput Digital Input
DC_SYSTEM dcsystem DC System

DigitalInputInputState

IdValueDisplay Name
High_Open 0 High/Open
Low_Closed 1 Low/Closed

DigitalInputState

IdValueDisplay Name
Low 0 Low
High 1 High
Off 2 Off
On 3 On
No 4 No
Yes 5 Yes
Open 6 Open
Closed 7 Closed
Ok 8 Ok
Alarm 9 Alarm
Running 10 Running
Stopped 11 Stopped

DigitalInputType

IdValueDisplay Name
Disabled 0 Disabled
PulseMeter 1 Pulse meter
DoorAlarm 2 Door alarm
BilgePump 3 Bilge pump
BilgeAlarm 4 Bilge alarm
BurglarAlarm 5 Burglar alarm
SmokeAlarm 6 Smoke alarm
FireAlarm 7 Fire alarm
CO2Alarm 8 CO2 alarm
Generator 9 Generator
TouchInputControl 10 Touch input control

ESSMode

IdValueDisplay Name
SelfConsumptionBatterylife 0 self consumption (batterylife)
SelfConsumption 1 self consumption
KeepCharged 2 keep charged
ExternalControl 3 External control

ErrorCode

IdValueDisplay Name
NO_ERROR 0 No error
BATTERY_VOLTAGE_TOO_HIGH 2 Battery voltage too high
CHARGER_TEMPERATURE_TOO_HIGH 17 Charger temperature too high
CHARGER_OVER_CURRENT 18 Charger over current
CHARGER_CURRENT_REVERSED 19 Charger current reversed
BULK_TIME_LIMIT_EXCEEDED 20 Bulk time limit exceeded
CURRENT_SENSOR_ISSUE 21 Current sensor issue
TERMINALS_OVERHEATED 26 Terminals overheated
CONVERTER_ISSUE 28 Converter issue
INPUT_VOLTAGE_TOO_HIGH 33 Input voltage too high (solar panel)
INPUT_CURRENT_TOO_HIGH 34 Input current too high (solar panel)
INPUT_SHUTDOWN_BATTERY_VOLTAGE_TOO_HIGH 38 Input shutdown (battery voltage too high)
INPUT_SHUTDOWN_REVERSE_CURRENT 39 Input shutdown (reverse current)
LOST_COMMUNICATION_WITH_DEVICE 65 Lost communication with device
SYNCHRONIZED_CHARGING_CONFIG_ISSUE 66 Synchronized charging config issue
BMS_CONNECTION_LOST 67 BMS connection lost
NETWORK_MISCONFIGURED 68 Network misconfigured
FACTORY_CALIBRATION_DATA_LOST 116 Factory calibration data lost
INVALID_INCOMPATIBLE_FIRMWARE 117 Invalid/incompatible firmware
USER_SETTINGS_INVALID 119 User settings invalid

EvChargerMode

IdValueDisplay Name
Manual 0 Manual
Auto 1 Auto
ScheduledCharge 2 Scheduled Charge

FluidType

IdValueDisplay Name
Fuel 0 Fuel
FreshWater 1 Fresh Water
WasteWater 2 Waste Water
LiveWell 3 Live Well
Oil 4 Oil
BlackWater 5 Black water (sewage)
Gasoline 6 Gasoline
Diesel 7 Diesel
LPG 8 Liquid Petroleum Gas (LPG)
LNG 9 Liquid Natural Gas (LNG)
HydraulicOil 10 Hydraulic oil
RawWater 11 Raw water

GeneratorRunningByConditionCode

IdValueDisplay Name
Stopped 0 Stopped
Manual 1 Manual
TestRun 2 Test Run
LostComms 3 Lost Comms
SOC 4 SOC
ACLoad 5 AC Load
BatteryCurrent 6 Battery Current
BatteryVolts 7 Battery Volts
InvTemp 8 Inv Temp
InvOverload 9 Inv Overload
StopOnAC1 10 Stop On AC1

GenericAlarmEnum

IdValueDisplay Name
NoAlarm 0 No Alarm
Warning 1 Warning
Alarm 2 Alarm

GenericOnOff

IdValueDisplay Name
Off 0 Off
On 1 On

InverterMode

IdValueDisplay Name
ChargerOnly 1 Charger Only
InverterOnly 2 Inverter Only
On 3 On
Off 4 Off

MultiState

IdValueDisplay Name
Off 0 Off
VoltageCurrentLimited 1 Voltage/current limited
MPPTActive 2 MPPT active
NotAvailable 255 Not available

PhoenixInverterMode

IdValueDisplay Name
INVERTER 2 Inverter
OFF 4 Off
ECO 4 Eco

State

IdValueDisplay Name
Off 0 Off
LowPower 1 Low Power
Fault 2 Fault
Bulk 3 Bulk
Absorption 4 Absorption
Float 5 Float
Storage 6 Storage
Equalize 7 Equalize
Passthrough 8 Passthrough
Inverting 9 Inverting
PowerAssist 10 Power Assist
PowerSupply 11 Power Supply
Sustain 244 Sustain
StartingUp 245 Starting Up
RepeatedAbsorption 246 Repeated Absorption
AutoEqualize 247 Auto Equalize / Recondition
BatterySafe 248 Battery Safe
ExternalControl 252 External Control

TemperatureStatus

IdValueDisplay Name
Ok 0 Ok
Disconnected 1 Disconnected
ShortCircuited 2 Short circuited
ReversePolarity 3 Reverse polarity
Unknown 4 Unknown

TemperatureType

IdValueDisplay Name
Battery 0 Battery
Fridge 1 Fridge
Generic 2 Generic
Room 3 Room
Outdoor 4 Outdoor
WaterHeater 5 Water Heater
Freezer 6 Freezer

VictronDeviceEnum

IdValueDisplay Name