Connect through a broker
GX devices connect to Venus OS MQTT or another compatible broker and act as the gateway for connected products.
Open source protocol reference
Explore the MQTT topics, measurements, value types, and enums published by Victron GX devices. Search the complete specification and quickly find the data your integration needs.
Protocol overview
Victron devices publish real-time energy data through an MQTT broker, making it available to automation, monitoring, and energy management systems.
GX devices connect to Venus OS MQTT or another compatible broker and act as the gateway for connected products.
Standard topic paths expose voltages, currents, operating states, alarms, and other measurements.
Payloads contain numbers, strings, or JSON objects. Metric metadata and enums describe how each value should be handled.
A GX device is required. Cerbo GX, Venus GX, and Color Control GX devices expose data from connected Victron products through MQTT. Inverters, solar controllers, and battery monitors do not expose MQTT directly.
Data catalogue
Search every field or combine filters to narrow the specification. Your current search is stored in the page URL so it can be shared.
| Topic | Device Type | Short ID | Name | Description | Unit | Metric Type | Metric Nature | Value Type | Precision | Enum | Min | Max |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
N/{installation_id}/acload/{device_id}/Ac/Current
|
AC load | acload_current | Load current | Measured load current for the AC load. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/Energy/Forward
|
AC load | acload_energy_forward | Consumption | Energy recorded as consumption for the AC load. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/Frequency
|
AC load | acload_frequency | Frequency | Measured frequency for the AC load. |
Hz
|
FREQUENCY | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/Power
|
AC load | acload_power | Power | Measured power for the AC load. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/Voltage
|
AC load | acload_voltage | Voltage | Measured voltage for the AC load. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/{phase}/Current
|
AC load | acload_current_{phase} | Current on {phase} | Measured current on an AC phase for the AC load. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/{phase}/Energy/Forward
|
AC load | acload_energy_forward_{phase} | Consumption on {phase} | Energy recorded as consumption on an AC phase for the AC load. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/{phase}/Power
|
AC load | acload_power_{phase} | Power on {phase} | Measured power on an AC phase for the AC load. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/acload/{device_id}/Ac/{phase}/Voltage
|
AC load | acload_voltage_{phase} | Voltage on {phase} | Measured voltage on an AC phase for the AC load. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/acsystem/{device_id}/Mode
|
AC system | acsystem_mode | Mode | Selected operating mode for the AC system. |
|
ENUM | NONE | ENUM | — | ACSystemMode | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/0/Current
|
Alternator charger | alternator_dc_current | DC output current | Measured DC output current for the alternator charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/0/Power
|
Alternator charger | alternator_dc_power | DC output power | Measured DC output power for the alternator charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/0/Voltage
|
Alternator charger | alternator_dc_voltage | DC output voltage | Measured DC output voltage for the alternator charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/In/I
|
Alternator charger | alternator_input_current | Input current | Measured input current for the alternator charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/In/P
|
Alternator charger | alternator_input_power | Input power | Measured input power for the alternator charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Dc/In/V
|
Alternator charger | alternator_input_voltage | Input voltage | Measured input voltage for the alternator charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/alternator/{device_id}/Mode
|
Alternator charger | alternator_mode | Mode | Controls mode for the alternator charger. |
|
ENUM | NONE | ENUM | — | ChargerMode | — | — |
|
N/{installation_id}/alternator/{device_id}/Settings/ChargeCurrentLimit
|
Alternator charger | alternator_charge_current_limit | Charge current limit | Configured charge current limit for the alternator charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | {"capability"=>"max_charge_current", "default"=>200} |
|
N/{installation_id}/alternator/{device_id}/State
|
Alternator charger | alternator_state | State | Current operating state of the alternator charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/BmsCable
|
Battery | battery_bms_cable | BMS cable | Current severity of the BMS cable alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/CellImbalance
|
Battery | battery_cell_imbalance | Cell imbalance | Current severity of the cell imbalance alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/FuseBlown
|
Battery | battery_fuse_blown | Fuse blown | Current severity of the fuse blown alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighCellVoltage
|
Battery | battery_high_cell_voltage | High cell voltage | Current severity of the high cell voltage alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighChargeCurrent
|
Battery | battery_high_charge_current | High charge current | Current severity of the high charge current alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighChargeTemperature
|
Battery | battery_high_charge_temperature | High charge temperature | Current severity of the high charge temperature alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighDischargeCurrent
|
Battery | battery_high_discharge_current | High discharge current | Current severity of the high discharge current alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighInternalTemperature
|
Battery | battery_high_internal_temperature | High internal temperature | Current severity of the high internal temperature alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighTemperature
|
Battery | battery_high_temperature | High temperature | Current severity of the high temperature alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/HighVoltage
|
Battery | battery_high_voltage | High voltage | Current severity of the high voltage alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/InternalFailure
|
Battery | battery_internal_failure | Internal failure | Current severity of the internal failure alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/LowCellVoltage
|
Battery | battery_low_cell_voltage | Low cell voltage | Current severity of the low cell voltage alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/LowChargeTemperature
|
Battery | battery_low_charge_temperature | Low charge temperature | Current severity of the low charge temperature alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/LowSoc
|
Battery | battery_low_soc | Low state of charge | Current severity of the low state of charge alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/LowTemperature
|
Battery | battery_low_temperature | Low temperature | Current severity of the low temperature alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/LowVoltage
|
Battery | battery_low_voltage | Low voltage | Current severity of the low voltage alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Alarms/StateOfHealth
|
Battery | battery_state_of_health_alarm | State of health alarm | Current severity of the state of health alarm for the battery. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/battery/{device_id}/Capacity
|
Battery | battery_capacity | Capacity | Reports capacity for the battery. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/ConsumedAmphours
|
Battery | battery_consumed_amphours | Consumed amp-hours | Reports consumed amp-hours for the battery. Always negative (to have the same sign as the current). |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/Current
|
Battery | battery_current | DC bus current | Measured DC bus current for the battery. Positive values indicate charging; negative values indicate discharging. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/MidVoltage
|
Battery | battery_mid_voltage | DC bus mid voltage | Measured DC bus mid voltage for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/MidVoltageDeviation
|
Battery | battery_mid_voltage_deviation | DC bus mid voltage deviation | Reports DC bus mid voltage deviation for the battery. |
%
|
PERCENTAGE | NONE | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/Power
|
Battery | battery_power | Power | Measured power for the battery. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/Temperature
|
Battery | battery_temperature | Temperature | Measured temperature for the battery. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/0/Voltage
|
Battery | battery_voltage | DC bus voltage | Measured DC bus voltage for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Dc/1/Voltage
|
Auxiliary battery | auxiliary_battery_voltage | Auxiliary battery voltage | Measured auxiliary battery voltage for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/AutomaticSyncs
|
Battery | battery_automatic_syncs | Automatic syncs | Reports automatic syncs for the battery. Not supported by CAN-bus BMS batteries. |
syncs
|
NONE | TOTAL_INCREASING | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/AverageDischarge
|
Battery | battery_average_discharge | Average discharge | Reports average discharge for the battery. Not supported by CAN-bus BMS batteries. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/ChargeCycles
|
Battery | battery_total_charge_cycles | Total charge cycles | Reports total charge cycles for the battery. Not supported by CAN-bus BMS batteries. |
cycles
|
NONE | TOTAL_INCREASING | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/ChargedEnergy
|
Battery | battery_charged_energy | Charged energy | Energy recorded as charged energy for the battery. Not supported by CAN-bus BMS batteries. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/DeepestDischarge
|
Battery | battery_deepest_discharge | Deepest discharge | Reports deepest discharge for the battery. Not supported by CAN-bus BMS batteries. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/DischargedEnergy
|
Battery | battery_discharged_energy | Discharged energy | Energy recorded as discharged energy for the battery. Not supported by CAN-bus BMS batteries. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/LastDischarge
|
Battery | battery_last_discharge | Last discharge | Reports last discharge for the battery. Not supported by CAN-bus BMS batteries. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/MaximumVoltage
|
Battery | battery_maximum_voltage | Maximum voltage | Measured maximum voltage for the battery. Not supported by CAN-bus BMS batteries. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/MinimumVoltage
|
Battery | battery_minimum_voltage | Minimum voltage | Measured minimum voltage for the battery. Not supported by CAN-bus BMS batteries. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/TimeSinceLastFullCharge
|
Battery | battery_time_since_last_full_charge | Time since last full charge | Reports time since last full charge for the battery. Not supported by CAN-bus BMS batteries. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/History/TotalAhDrawn
|
Battery | battery_cumulative_ah_drawn | Cumulative Ah drawn | Reports cumulative Ah drawn for the battery. Not supported by CAN-bus BMS batteries. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | TOTAL | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Info/ChargeMode
|
Battery charging | charge_mode | Charge mode | Reports charge mode for the battery. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/Info/MaxChargeCurrent
|
Battery | battery_max_charge_current | Maximum allowed charge current | Measured maximum allowed charge current for the battery. Not supported by all Victron products. Supported by third-party CAN-bus batteries and Lynx NG. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Info/MaxChargeVoltage
|
Battery | battery_max_charge_voltage | Maximum allowed charging voltage | Measured maximum allowed charging voltage for the battery. Not supported by all Victron products. Supported by third-party CAN-bus batteries and Lynx NG. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Info/MaxDischargeCurrent
|
Battery | battery_max_discharge_current | Maximum allowed discharge current | Measured maximum allowed discharge current for the battery. Not supported by all Victron products. Supported by third-party CAN-bus batteries and Lynx NG. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/InstalledCapacity
|
Battery | battery_installed_capacity | Installed capacity | Reports installed capacity for the battery. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Io/AllowToCharge
|
Battery | battery_allow_to_charge | Allow to charge | Indicates whether the BMS allows the battery to charge. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/battery/{device_id}/Io/AllowToDischarge
|
Battery | battery_allow_to_discharge | Allow to discharge | Indicates whether the BMS allows the battery to discharge. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/battery/{device_id}/Mode
|
Battery | battery_bms_mode | BMS mode | Selected BMS mode for the battery. |
|
ENUM | NONE | ENUM | — | BMSMode | — | — |
|
N/{installation_id}/battery/{device_id}/Soc
|
Battery | battery_soc | Charge | Reports charge for the battery. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/battery/{device_id}/Soh
|
Battery | battery_soh | State of health | Reports state of health for the battery. Not supported by all Victron products. Supported by third-party CAN-bus batteries and Lynx NG. |
%
|
PERCENTAGE | NONE | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MaxCellTemperature
|
Battery | battery_max_cell_temperature | Maximum cell temperature | Measured maximum cell temperature for the battery. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MaxCellVoltage
|
Battery | battery_max_cell_voltage | Maximum cell voltage | Measured maximum cell voltage for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MaxTemperatureCellId
|
Battery | battery_max_temperature_cell_id | Maximum temperature cell ID | Reports maximum temperature cell ID for the battery. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MaxVoltageCellId
|
Battery | battery_max_voltage_cell_id | Maximum voltage cell ID | Reports maximum voltage cell ID for the battery. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MinCellTemperature
|
Battery | battery_min_cell_temperature | Minimum cell temperature | Measured minimum cell temperature for the battery. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MinCellVoltage
|
Battery | battery_min_cell_voltage | Minimum cell voltage | Measured minimum cell voltage for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MinTemperatureCellId
|
Battery | battery_min_temperature_cell_id | Minimum temperature cell ID | Reports minimum temperature cell ID for the battery. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/MinVoltageCellId
|
Battery | battery_min_voltage_cell_id | Minimum voltage cell ID | Reports minimum voltage cell ID for the battery. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/NrOfModulesBlockingCharge
|
Battery | battery_nr_modules_blocking_charge | Number of modules blocking charge | Reports number of modules blocking charge for the battery. |
modules
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/NrOfModulesBlockingDischarge
|
Battery | battery_nr_modules_blocking_discharge | Number of modules blocking discharge | Reports number of modules blocking discharge for the battery. |
modules
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/NrOfModulesOffline
|
Battery | battery_nr_modules_offline | Number of modules offline | Reports number of modules offline for the battery. |
modules
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/System/NrOfModulesOnline
|
Battery | battery_nr_modules_online | Number of modules online | Reports number of modules online for the battery. |
modules
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/TimeToGo
|
Battery | battery_time_to_go | Time to go | Reports time to go for the battery. Special value: 0 = charging. Not supported by CAN-bus BMS batteries. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/battery/{device_id}/Voltages/Cell{cell_id(1-16)}
|
Battery | battery_cell_{cell_id}_voltage | Cell {cell_id} voltage | Measured voltage for an individual battery cell. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/battery/{device_id}/Voltages/Diff
|
Battery | battery_cell_voltage_deviation | Cell voltage deviation | Measured cell voltage deviation for the battery. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/charger/{device_id}/Ac/In/CurrentLimit
|
Charger | charger_ac_in_current_limit | AC input current limit | Configured AC input current limit for the AC charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | 32 |
|
N/{installation_id}/charger/{device_id}/Ac/In/{phase}/I
|
Charger | charger_ac_in_current_{phase} | AC input current {phase} | Measured AC input current for an AC phase of the charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/charger/{device_id}/Dc/{output}/Current
|
Charger | charger_dc_current_{output} | DC output {output} current | Measured current for a numbered DC output of the AC charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/charger/{device_id}/Dc/{output}/Voltage
|
Charger | charger_dc_voltage_{output} | DC output {output} voltage | Measured voltage for a numbered DC output of the AC charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/charger/{device_id}/ErrorCode
|
Charger | charger_error_code | Error code | Current error condition of the AC charger. |
|
ENUM | NONE | ENUM | — | ErrorCode | — | — |
|
N/{installation_id}/charger/{device_id}/Mode
|
Charger | charger_mode | Mode | Controls mode for the AC charger. |
|
ENUM | NONE | ENUM | — | ChargerMode | — | — |
|
N/{installation_id}/charger/{device_id}/NrOfOutputs
|
Charger | charger_nr_of_outputs | Number of outputs | Reports number of outputs for the AC charger. |
outputs
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/charger/{device_id}/State
|
Charger | charger_state | State | Current operating state of the AC charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/0/Current
|
DC/DC charger | dcdc_dc_current | DC output current | Measured DC output current for the DC/DC charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/0/Power
|
DC/DC charger | dcdc_dc_power | DC output power | Measured DC output power for the DC/DC charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/0/Voltage
|
DC/DC charger | dcdc_dc_voltage | DC output voltage | Measured DC output voltage for the DC/DC charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/In/I
|
DC/DC charger | dcdc_input_current | Input current | Measured input current for the DC/DC charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/In/P
|
DC/DC charger | dcdc_input_power | Input power | Measured input power for the DC/DC charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Dc/In/V
|
DC/DC charger | dcdc_input_voltage | Input voltage | Measured input voltage for the DC/DC charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/dcdc/{device_id}/Mode
|
DC/DC charger | dcdc_mode | Mode | Controls mode for the DC/DC charger. |
|
ENUM | NONE | ENUM | — | ChargerMode | — | — |
|
N/{installation_id}/dcdc/{device_id}/State
|
DC/DC charger | dcdc_state | State | Current operating state of the DC/DC charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/dcload/{device_id}/Dc/0/Current
|
DC load | dcload_current | Current | Measured current for the DC load. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcload/{device_id}/Dc/0/Power
|
DC load | dcload_power | Power | Measured power for the DC load. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcload/{device_id}/Dc/0/Voltage
|
DC load | dcload_voltage | Voltage | Measured voltage for the DC load. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/dcsource/{device_id}/Dc/0/Current
|
DC source | dcsource_current | Current | Measured current for the DC source. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcsource/{device_id}/Dc/0/Power
|
DC source | dcsource_power | Power | Measured power for the DC source. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcsource/{device_id}/Dc/0/Temperature
|
DC source | dcsource_temperature | Temperature | Measured temperature for the DC source. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcsource/{device_id}/Dc/0/Voltage
|
DC source | dcsource_voltage | Voltage | Measured voltage for the DC source. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/dcsystem/{device_id}/Dc/0/Current
|
DC system | dcsystem_current | Current | Measured current for the DC system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcsystem/{device_id}/Dc/0/Power
|
DC system | dcsystem_power | Power | Measured power for the DC system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/dcsystem/{device_id}/Dc/0/Voltage
|
DC system | dcsystem_voltage | Voltage | Measured voltage for the DC system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/dcsystem/{device_id}/Dc/1/Voltage
|
DC system | dcsystem_aux_voltage | Auxiliary voltage | Measured auxiliary voltage for the DC system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/digitalinput/{device_id}/Alarm
|
Digital input | digitalinput_alarm | Alarm | Current severity of the alarm for the digital input. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/digitalinput/{device_id}/InputState
|
Digital input | digitalinput_input_state_raw | Raw state | Current operating state of the digital input. |
|
ENUM | NONE | ENUM | — | DigitalInputInputState | — | — |
|
N/{installation_id}/digitalinput/{device_id}/Settings/InvertTranslation
|
Digital input | digitalinput_settings_invert_translation | Invert digital input | Controls invert digital input for the digital input. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/digitalinput/{device_id}/State
|
Digital input | digitalinput_state | State | Current operating state of the digital input. |
|
ENUM | NONE | ENUM | — | DigitalInputState | — | — |
|
N/{installation_id}/digitalinput/{device_id}/Type
|
Digital input | digitalinput_type | Type | Configured type for the digital input. |
|
ENUM | NONE | ENUM | — | DigitalInputType | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/Current
|
Electric vehicle | ev_ac_current | AC current | Measured AC current for the electric vehicle. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/Energy/Forward
|
Electric vehicle | ev_ac_energy_forward | Total energy | Energy recorded as total energy for the electric vehicle. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/MaxChargeCurrent
|
Electric vehicle | ev_ac_max_charge_current | Max charge current | Measured max charge current for the electric vehicle. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/MinChargeCurrent
|
Electric vehicle | ev_ac_min_charge_current | Min charge current | Measured min charge current for the electric vehicle. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/NrOfPhases
|
Electric vehicle | ev_ac_nr_of_phases | Number of phases | Reports number of phases for the electric vehicle. |
—
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/Power
|
Electric vehicle | ev_ac_power | AC power | Measured AC power for the electric vehicle. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Ac/Voltage
|
Electric vehicle | ev_ac_voltage | AC voltage | Measured AC voltage for the electric vehicle. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Alarms/StarterBatteryLow
|
Electric vehicle | ev_alarm_starter_battery_low | Starter battery low | Current severity of the starter battery low alarm for the electric vehicle. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/ev/{device_id}/AtSite
|
Electric vehicle | ev_at_site | At site | Indicates whether the electric vehicle is at the configured site. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/ev/{device_id}/BatteryCapacity
|
Electric vehicle | ev_battery_capacity | Battery capacity | Reports battery capacity for the electric vehicle. |
Ah
|
ELECTRIC_STORAGE_CAPACITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/BatteryTemperature
|
Electric vehicle | ev_battery_temperature | Battery temperature | Measured battery temperature for the electric vehicle. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/ChargingStarted
|
Electric vehicle | ev_charging_started | Charging started | Reports charging started for the electric vehicle. |
—
|
TIMESTAMP | NONE | EPOCH_DEFAULT_NA | — | — | — | — |
|
N/{installation_id}/ev/{device_id}/ChargingState
|
Electric vehicle | ev_charging_state | Charging state | Current operating state of the electric vehicle. |
|
ENUM | NONE | ENUM | — | EvChargingState | — | — |
|
N/{installation_id}/ev/{device_id}/Dc/Current
|
Electric vehicle | ev_dc_current | DC current | Measured DC current for the electric vehicle. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Dc/Power
|
Electric vehicle | ev_dc_power | DC power | Measured DC power for the electric vehicle. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Dc/Voltage
|
Electric vehicle | ev_dc_voltage | DC voltage | Measured DC voltage for the electric vehicle. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/ev/{device_id}/LastEvContact
|
Electric vehicle | ev_last_ev_contact | Last EV contact | Reports last EV contact for the electric vehicle. |
—
|
TIMESTAMP | NONE | EPOCH | — | — | — | — |
|
N/{installation_id}/ev/{device_id}/Odometer
|
Electric vehicle | ev_odometer | Odometer | Measured odometer for the electric vehicle. |
km
|
DISTANCE | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Position/Latitude
|
Electric vehicle | ev_latitude | Latitude | Reports latitude for the electric vehicle. |
lat
|
LATITUDE | NONE | FLOAT | — | — | — | — |
|
N/{installation_id}/ev/{device_id}/Position/Longitude
|
Electric vehicle | ev_longitude | Longitude | Reports longitude for the electric vehicle. |
long
|
LONGITUDE | NONE | FLOAT | — | — | — | — |
|
$$func/ev/gps_location
|
Electric vehicle | ev_gps_location | Location | Combines the electric vehicle latitude and longitude into a geographic location. |
—
|
LOCATION | NONE | GPS_LOCATION | — | — | — | — |
|
N/{installation_id}/ev/{device_id}/RangeToGo
|
Electric vehicle | ev_range_to_go | Range to go | Measured range to go for the electric vehicle. |
km
|
DISTANCE | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/ev/{device_id}/Soc
|
Electric vehicle | ev_soc | State of charge | Reports state of charge for the electric vehicle. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/ev/{device_id}/TargetSoc
|
Electric vehicle | ev_target_soc | Target state of charge | Reports target state of charge for the electric vehicle. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/ev/{device_id}/VIN
|
Electric vehicle | ev_vin | VIN | Reports vIN for the electric vehicle. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/Ac/Energy/Forward
|
EV charging station | evcharger_total_energy | Total energy | Energy recorded as total energy for the EV charging station. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/Ac/Power
|
EV charging station | evcharger_power | Power | Measured power for the EV charging station. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/Ac/{phase}/Power
|
EV charging station | evcharger_power_{phase} | Power {phase} | Measured power for an AC phase of the EV charging station. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/AutoStart
|
EV charging station | evcharger_auto_start | Auto start | Controls auto start for the EV charging station. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/evcharger/{device_id}/Connected
|
EV charging station | evcharger_connected | Connected | Indicates whether an electric vehicle is connected to the charging station. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/evcharger/{device_id}/Current
|
EV charging station | evcharger_current | Current | Measured current for the EV charging station. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/MaxCurrent
|
EV charging station | evcharger_max_set_current | Max charging current | Configured max charging current for the EV charging station. |
A
|
CURRENT | MEASUREMENT | INT | — | — | evcharger_min_set_current:6 | 32 |
|
N/{installation_id}/evcharger/{device_id}/MinCurrent
|
EV charging station | evcharger_min_set_current | Min charging current | Configured min charging current for the EV charging station. |
A
|
CURRENT | MEASUREMENT | INT | — | — | 6 | evcharger_max_set_current:32 |
|
N/{installation_id}/evcharger/{device_id}/Mode
|
EV charging station | evcharger_mode | Mode | Selected operating mode for the EV charging station. |
|
ENUM | NONE | ENUM | — | EvChargerMode | — | — |
|
N/{installation_id}/evcharger/{device_id}/Position
|
EV charging station | evcharger_position | Position | Current position for the EV charging station. |
|
ENUM | NONE | ENUM | — | EvChargerPosition | — | — |
|
N/{installation_id}/evcharger/{device_id}/Session/Cost
|
EV charging station | evcharger_session_cost | Last session cost | Reports last session cost for the EV charging station. |
—
|
COST | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/Session/Energy
|
EV charging station | evcharger_session_energy | Last session energy | Energy recorded as last session energy for the EV charging station. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/Session/Time
|
EV charging station | evcharger_session_time | Last session time | Reports last session time for the EV charging station. |
min
|
DURATION | MEASUREMENT | INT_SECONDS_TO_MINUTES | 0 | — | — | — |
|
N/{installation_id}/evcharger/{device_id}/SetCurrent
|
EV charging station | evcharger_set_current | Charge current setpoint | Configured charge current setpoint for the EV charging station. |
A
|
CURRENT | MEASUREMENT | INT | — | — | evcharger_min_set_current:0 | evcharger_max_set_current:32 |
|
N/{installation_id}/evcharger/{device_id}/StartStop
|
EV charging station | evcharger_charge | EV charging | Controls eV charging for the EV charging station. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/evcharger/{device_id}/Status
|
EV charging station | evcharger_status | Status | Current status of the EV charging station. |
|
ENUM | NONE | ENUM | — | EvChargerStatus | — | — |
|
N/{installation_id}/generator/{device_id}/AccumulatedRuntime
|
Generator | generator_total_runtime | Total runtime | Reports total runtime for the generator. |
h
|
DURATION | TOTAL_INCREASING | INT_SECONDS_TO_HOURS | 1 | — | — | — |
|
N/{installation_id}/generator/{device_id}/AutoStartEnabled
|
Generator | generator_autorun | Auto-start enabled | Controls auto-start enabled for the generator. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/generator/{device_id}/ManualStart
|
Generator | generator_manual_start | Manual start | Controls manual start for the generator. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/generator/{device_id}/NextTestRun
|
Generator | generator_next_test_run | Next test run | Reports next test run for the generator. |
—
|
TIMESTAMP | NONE | EPOCH | — | — | — | — |
|
N/{installation_id}/generator/{device_id}/RunningByConditionCode
|
Generator | generator_run_state | Run state | Current operating state of the generator. |
|
ENUM | NONE | ENUM | — | GeneratorRunningByConditionCode | — | — |
|
N/{installation_id}/generator/{device_id}/ServiceCounter
|
Generator | generator_service_counter | Service counter | Reports service counter for the generator. |
h
|
DURATION | TOTAL_INCREASING | INT_SECONDS_TO_HOURS | 0 | — | — | — |
|
N/{installation_id}/generator/{device_id}/TodayRuntime
|
Generator | generator_today_runtime | Today runtime | Reports today runtime for the generator. |
h
|
DURATION | TOTAL_INCREASING | INT_SECONDS_TO_HOURS | 1 | — | — | — |
|
N/{installation_id}/gps/{device_id}/Altitude
|
GPS | gps_altitude | Altitude | Reports altitude for the GPS receiver. |
—
|
ALTITUDE | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/gps/{device_id}/Connected
|
GPS | gps_connected | Connected | Indicates whether the GPS receiver is connected. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/gps/{device_id}/Course
|
GPS | gps_course | Course | Reports course for the GPS receiver. Direction of movement 0-360 degrees. |
°
|
HEADING | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/gps/{device_id}/Fix
|
GPS | gps_fix | Fix | Indicates whether the GPS receiver has a valid position fix. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/gps/{device_id}/NrOfSatellites
|
GPS | gps_nrofsatellites | Number of satellites | Reports number of satellites for the GPS receiver. |
satellites
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/gps/{device_id}/Position/Latitude
|
GPS | gps_latitude | Latitude | Reports latitude for the GPS receiver. |
lat
|
LATITUDE | NONE | FLOAT | — | — | — | — |
|
N/{installation_id}/gps/{device_id}/Position/Longitude
|
GPS | gps_longitude | Longitude | Reports longitude for the GPS receiver. |
long
|
LONGITUDE | NONE | FLOAT | — | — | — | — |
|
N/{installation_id}/gps/{device_id}/Speed
|
GPS | gps_speed | Speed | Measured speed for the GPS receiver. |
m/s
|
SPEED | NONE | FLOAT | 2 | — | — | — |
|
$$func/gps/gps_location
|
GPS | gps_location | Location | Combines the GPS latitude and longitude into a geographic location. |
—
|
LOCATION | NONE | GPS_LOCATION | — | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Current
|
Grid | grid_current | Current | Measured current for the grid meter. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Energy/Forward
|
Grid | grid_energy_forward | Consumption | Energy recorded as consumption for the grid meter. Depending on the energy summation method used by the meter, this may be different to the sum of the individual counters. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Energy/Reverse
|
Grid | grid_energy_reverse | Feed-in | Energy recorded as feed-in for the grid meter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Frequency
|
Grid | grid_frequency | Frequency | Measured frequency for the grid meter. |
Hz
|
FREQUENCY | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/N/Current
|
Grid | grid_current_n | Current on N | Measured current on N for the grid meter. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/PENVoltage
|
Grid | grid_voltage_pen | Voltage on PEN | Measured voltage on PEN for the grid meter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Power
|
Grid | grid_power | Power | Measured power for the grid meter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/PowerFactor
|
Grid | grid_power_factor | Power factor | Measured power factor for the grid meter. |
—
|
POWER_FACTOR | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/Voltage
|
Grid | grid_voltage | Voltage | Measured voltage for the grid meter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/Current
|
Grid | grid_current_{phase} | Current on {phase} | Measured current on an AC phase for the grid meter. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/Energy/Forward
|
Grid | grid_energy_forward_{phase} | Grid consumption on {phase} | Energy recorded as grid consumption on an AC phase for the grid meter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/Energy/Reverse
|
Grid | grid_energy_reverse_{phase} | Feed-in on {phase} | Energy recorded as feed-in on an AC phase for the grid meter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/Power
|
Grid | grid_power_{phase} | Power on {phase} | Measured power on an AC phase for the grid meter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/PowerFactor
|
Grid | grid_power_factor_{phase} | Power factor on {phase} | Measured power factor on an AC phase for the grid meter. |
—
|
POWER_FACTOR | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/Voltage
|
Grid | grid_voltage_{phase} | Voltage on {phase} | Measured line-to-neutral voltage on an AC phase for the grid meter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/grid/{device_id}/Ac/{phase}/VoltageLineToLine
|
Grid | grid_voltage_{phase}_{next_phase} | Voltage {phase} to {next_phase} | Measured line-to-line voltage between adjacent AC phases for the grid meter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/heartbeat
|
Victron Venus | system_heartbeat | GX system heartbeat | Reports gX system heartbeat for the heartbeat. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/Current
|
Heat pump | heatpump_current | Current | Measured current for the heat pump. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/Energy/Forward
|
Heat pump | heatpump_energy_forward | Consumption | Energy recorded as consumption for the heat pump. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/Frequency
|
Heat pump | heatpump_frequency | Frequency | Measured frequency for the heat pump. |
Hz
|
FREQUENCY | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/Power
|
Heat pump | heatpump_power | Power | Measured power for the heat pump. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/Voltage
|
Heat pump | heatpump_voltage | Voltage | Measured voltage for the heat pump. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/{phase}/Current
|
Heat pump | heatpump_current_{phase} | Current on {phase} | Measured current on an AC phase for the heat pump. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/{phase}/Energy/Forward
|
Heat pump | heatpump_energy_forward_{phase} | Consumption on {phase} | Energy recorded as consumption on an AC phase for the heat pump. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/{phase}/Power
|
Heat pump | heatpump_power_{phase} | Power on {phase} | Measured power on an AC phase for the heat pump. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/heatpump/{device_id}/Ac/{phase}/Voltage
|
Heat pump | heatpump_voltage_{phase} | Voltage on {phase} | Measured voltage on an AC phase for the heat pump. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/hub4/{device_id}/Overrides/ForceCharge
|
Hub4 | hub4_force_charge | Force charge | Controls force charge for the ESS controller. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/hub4/{device_id}/Overrides/MaxChargePower
|
Hub4 | hub4_max_charge_power | Maximum charge power | Configured maximum charge power for the ESS controller. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | -1 | 1000000 |
|
N/{installation_id}/hub4/{device_id}/Overrides/MaxDischargePower
|
Hub4 | hub4_max_discharge_power | Maximum discharge power | Configured maximum discharge power for the ESS controller. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | -1 | 1000000 |
|
N/{installation_id}/hub4/{device_id}/Overrides/Setpoint
|
Hub4 | hub4_ac_grid_setpoint | AC grid setpoint | Configured AC grid setpoint for the ESS controller. This can not be used together with DynamicEss. |
W
|
POWER | MEASUREMENT | INT | — | — | -32767 | 32767 |
|
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/I
|
Inverter | inverter_output_current_{phase} | Output current {phase} | Measured output current for an AC phase of the inverter. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/P
|
Inverter | inverter_output_power_{phase} | Output power {phase} | Measured output power for an AC phase of the inverter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/S
|
Inverter | inverter_output_apparent_power_{phase} | Output apparent power {phase} | Measured output apparent power for an AC phase of the inverter. |
VA
|
APPARENT_POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Ac/Out/{phase}/V
|
Inverter | inverter_output_voltage_{phase} | Output voltage {phase} | Measured output voltage for an AC phase of the inverter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/HighTemperature
|
Inverter | inverter_alarm_high_temperature | High temperature alarm | Indicates whether the high temperature alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/HighVoltage
|
Inverter | inverter_alarm_high_voltage | High voltage alarm | Indicates whether the high voltage alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/HighVoltageAcOut
|
Inverter | inverter_alarm_high_voltage_ac_out | High voltage AC-out alarm | Indicates whether the high voltage AC-out alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/LowTemperature
|
Inverter | inverter_alarm_low_temperature | Low temperature alarm | Indicates whether the low temperature alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/LowVoltage
|
Inverter | inverter_alarm_low_voltage | Low voltage alarm | Indicates whether the low voltage alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/LowVoltageAcOut
|
Inverter | inverter_alarm_low_voltage_ac_out | Low voltage AC-out alarm | Indicates whether the low voltage AC-out alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/Overload
|
Inverter | inverter_alarm_overload | Overload alarm | Indicates whether the overload alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Alarms/Ripple
|
Inverter | inverter_alarm_ripple | Ripple alarm | Indicates whether the ripple alarm is active for the inverter. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/inverter/{device_id}/Mode
|
Inverter | inverter_mode | Mode | Selected operating mode for the inverter. |
|
ENUM | NONE | ENUM | — | PhoenixInverterMode | — | — |
|
N/{installation_id}/inverter/{device_id}/Pv/V
|
Inverter | inverter_pv_voltage | PV bus voltage | Measured PV bus voltage for the inverter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/State
|
Inverter | inverter_state | State | Current operating state of the inverter. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/inverter/{device_id}/Yield/Power
|
Inverter | inverter_pv_power_total | PV power total | Measured PV power total for the inverter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Yield/System
|
Inverter | inverter_total_pv_yield_system | Total PV yield system | Energy recorded as total PV yield system for the inverter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/inverter/{device_id}/Yield/User
|
Inverter | inverter_total_pv_yield_user | Total PV yield user | Energy recorded as total PV yield user for the inverter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/meteo/{device_id}/Alarms/LowBattery
|
Irradiance sensor | meteo_alarm_low_battery | Low battery alarm | Current severity of the low battery alarm for the irradiance sensor. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/meteo/{device_id}/BatteryVoltage
|
Irradiance sensor | meteo_battery_voltage | Battery voltage | Measured battery voltage for the irradiance sensor. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/meteo/{device_id}/CellTemperature
|
Irradiance sensor | meteo_cell_temperature | Cell temperature | Measured cell temperature for the irradiance sensor. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/meteo/{device_id}/InstallationPower
|
Irradiance sensor | meteo_installation_power | Installation power | Measured installation power for the irradiance sensor. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/meteo/{device_id}/Irradiance
|
Irradiance sensor | meteo_irradiance | Irradiance | Measured irradiance for the irradiance sensor. |
W/m²
|
IRRADIANCE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/meteo/{device_id}/TimeSinceLastSun
|
Irradiance sensor | meteo_time_since_last_sun | Time since last sun | Reports time since last sun for the irradiance sensor. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/meteo/{device_id}/TodaysYield
|
Irradiance sensor | meteo_todays_yield | Today's yield | Energy recorded as today's yield for the irradiance sensor. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/ActiveIn/ActiveInput
|
Multi RS Solar | multi_active_input | Active AC input | Current active AC input for the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | ActiveInputEnum | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/In/1/CurrentLimit
|
Multi RS Solar | multi_shore_current_limit | Shore current limit | Configured shore current limit for the Multi RS inverter/charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | 200 |
|
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/I
|
Multi RS Solar | multi_acin_current_{phase} | Input current on {phase} | Measured input current on an AC phase for the Multi RS inverter/charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/P
|
Multi RS Solar | multi_acin_power_{phase} | Input power on {phase} | Measured input power on an AC phase for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/In/1/{phase}/V
|
Multi RS Solar | multi_acin_voltage_{phase} | Input voltage on {phase} | Measured input voltage on an AC phase for the Multi RS inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/NumberOfPhases
|
Multi RS Solar | multi_phases | Phases | Reports phases for the Multi RS inverter/charger. |
phases
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/I
|
Multi RS Solar | multi_acout_{output}_current_{phase} | AC-out-{output} current on {phase} | Measured current on an AC phase of a numbered Multi RS AC output. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/P
|
Multi RS Solar | multi_acout_{output}_power_{phase} | AC-out-{output} power on {phase} | Measured power on an AC phase of a numbered Multi RS AC output. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{output}/{phase}/V
|
Multi RS Solar | multi_acout_{output}_voltage_{phase} | AC-out-{output} voltage on {phase} | Measured voltage on an AC phase of a numbered Multi RS AC output. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{phase}/I
|
Multi RS Solar | multi_acout_current_{phase} | Output current on {phase} | Measured output current on an AC phase for the Multi RS inverter/charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{phase}/P
|
Multi RS Solar | multi_acout_power_{phase} | Output power on {phase} | Measured output power on an AC phase for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ac/Out/{phase}/V
|
Multi RS Solar | multi_acout_voltage_{phase} | Output voltage on {phase} | Measured output voltage on an AC phase for the Multi RS inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Dc/0/Temperature
|
Multi RS Solar | multi_dc_temperature | DC temperature | Measured DC temperature for the Multi RS inverter/charger. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/AcIn1ToAcOut
|
Multi RS Solar | multi_acin1_to_acout | AC-in-1 to AC-out | Energy recorded as AC-in-1 to AC-out for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/AcIn1ToInverter
|
Multi RS Solar | multi_acin1_to_inverter | AC-in-1 to inverter | Energy recorded as AC-in-1 to inverter for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/AcOutToAcIn1
|
Multi RS Solar | multi_acout_to_acin1 | AC-out to AC-in-1 | Energy recorded as AC-out to AC-in-1 for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/InverterToAcIn1
|
Multi RS Solar | multi_inverter_to_acin1 | Inverter to AC-in-1 | Energy recorded as inverter to AC-in-1 for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/InverterToAcOut
|
Multi RS Solar | multi_inverter_to_acout | Inverter to AC-out | Energy recorded as inverter to AC-out for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/OutToInverter
|
Multi RS Solar | multi_acout_to_inverter | AC-out to inverter | Energy recorded as AC-out to inverter for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/SolarToAcIn1
|
Multi RS Solar | multi_solar_to_acin1 | Solar to AC-in-1 | Energy recorded as solar to AC-in-1 for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/SolarToAcOut
|
Multi RS Solar | multi_solar_to_acout | Solar to AC-out | Energy recorded as solar to AC-out for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Energy/SolarToBattery
|
Multi RS Solar | multi_solar_to_battery | Solar to battery | Energy recorded as solar to battery for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ess/AcPowerSetpoint
|
Multi RS Solar | multi_ess_ac_power_setpoint | ESS AC power setpoint | Measured ESS AC power setpoint for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | INT_DEFAULT_0 | — | — | — | — |
|
N/{installation_id}/multi/{device_id}/Ess/DisableCharge
|
Multi RS Solar | multi_disable_charge | ESS disable charge | Controls ESS disable charge for the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/multi/{device_id}/Ess/DisableFeedIn
|
Multi RS Solar | multi_disable_feed_in | ESS disable feed-in | Controls ESS disable feed-in for the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/multi/{device_id}/Ess/InverterPowerSetpoint
|
Multi RS Solar | multi_inverter_power_setpoint | Inverter power setpoint | Measured inverter power setpoint for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/0/MaxPower
|
Multi RS Solar | multi_max_power_today | Max power today | Measured max power today for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/0/Pv/{mppt_id}/Yield
|
Multi RS Solar | multi_mppt_{mppt_id}_yield_today | MPPT {mppt_id} yield today | Energy recorded as today's yield for an MPPT tracker of the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/0/Yield
|
Multi RS Solar | multi_yield_today | Yield today | Energy recorded as yield today for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/1/MaxPower
|
Multi RS Solar | multi_max_power_yesterday | Max power yesterday | Measured max power yesterday for the Multi RS inverter/charger. |
W
|
POWER | NONE | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/1/Pv/{mppt_id}/Yield
|
Multi RS Solar | multi_mppt_{mppt_id}_yield_yesterday | MPPT {mppt_id} yield yesterday | Energy recorded as yesterday's yield for an MPPT tracker of the Multi RS inverter/charger. |
kWh
|
ENERGY | NONE | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/History/Daily/1/Yield
|
Multi RS Solar | multi_yield_yesterday | Yield yesterday | Energy recorded as yield yesterday for the Multi RS inverter/charger. |
kWh
|
ENERGY | NONE | FLOAT | 3 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/MppOperationMode
|
Multi RS Solar | multi_mppt_{mpptnumber}_state | MPPT {mpptnumber} state | Current operating mode of an MPPT tracker in the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | MppOperationMode | — | — |
|
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/P
|
Multi RS Solar | multi_mppt_{mpptnumber}_power | MPPT {mpptnumber} power | Measured power for an MPPT tracker of the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Pv/{mpptnumber}/V
|
Multi RS Solar | multi_mppt_{mpptnumber}_voltage | MPPT {mpptnumber} PV voltage | Measured PV voltage for an MPPT tracker of the Multi RS inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
$$func/multi/pv_current
|
Multi RS Solar | multi_mppt_{mpptnumber}_current | MPPT {mpptnumber} current | Calculates current for an MPPT tracker of the Multi RS inverter/charger from PV power and voltage. |
A
|
CURRENT | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Relay/0/State
|
Multi RS Solar | multi_relay0_state | Relay on Multi RS state | Controls relay on Multi RS state for the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/multi/{device_id}/Settings/Ess/MinimumSocLimit
|
Multi RS Solar | multi_ess_min_soc_limit | ESS minimum SoC limit | Configured ESS minimum SoC limit for the Multi RS inverter/charger. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/multi/{device_id}/Settings/Ess/Mode
|
Multi RS Solar | multi_ess_mode | ESS mode | Current operating mode of the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | ESSMode | — | — |
|
N/{installation_id}/multi/{device_id}/State
|
Multi RS Solar | multi_state | State | Current operating state of the Multi RS inverter/charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/multi/{device_id}/Yield/Power
|
Multi RS Solar | multi_pv_power_total | PV power total | Measured PV power total for the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/multi/{device_id}/Yield/User
|
Multi RS Solar | multi_total_pv_yield | Total PV yield user | Energy recorded as total PV yield user for the Multi RS inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/platform/{device_id}/Device/Reboot
|
Platform | platform_device_reboot | Device reboot | Triggers device reboot on the GX device. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/platform/{device_id}/Firmware/Installed/Version
|
Platform | platform_venus_firmware_installed_version | Installed version | Reports installed version for the GX device. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/platform/{device_id}/Firmware/Online/AvailableVersion
|
Platform | platform_venus_firmware_available_version | Available version | Reports available version for the GX device. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/platform/{device_id}/Firmware/Progress
|
Platform | platform_venus_firmware_progress | Firmware update progress | Reports firmware update progress for the GX device. |
%
|
PERCENTAGE | NONE | INT | — | — | — | — |
|
N/{installation_id}/platform/{device_id}/Firmware/State
|
Platform | platform_venus_firmware_state | Firmware update state | Current operating state of the GX device. |
|
ENUM | NONE | ENUM | — | FirmwareUpdateState | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/Energy/Forward
|
PV inverter | pvinverter_yield_total | Total yield | Energy recorded as total yield for the PV inverter. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/Power
|
PV inverter | pvinverter_power_total | Power total | Measured power total for the PV inverter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/PowerLimit
|
PV inverter | pvinverter_power_limit | Power limit | Configured power limit for the PV inverter. For use in ESS mode 3. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | 0 | 10000 |
|
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Current
|
PV inverter | pvinverter_current_{phase} | Current {phase} | Measured current for an AC phase of the PV inverter. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Energy/Forward
|
PV inverter | pvinverter_yield_{phase} | Yield {phase} | Energy recorded as yield for an AC phase of the PV inverter. Deprecated. Use 1046 instead. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Power
|
PV inverter | pvinverter_power_{phase} | Power {phase} | Measured power for an AC phase of the PV inverter. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/pvinverter/{device_id}/Ac/{phase}/Voltage
|
PV inverter | pvinverter_voltage_{phase} | Voltage {phase} | Measured voltage for an AC phase of the PV inverter. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/AcExportLimit
|
Victron Venus | system_ac_export_limit | AC export limit | Configured AC export limit for the GX system. |
A
|
CURRENT | MEASUREMENT | INT | — | — | -1 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/AcInputLimit
|
Victron Venus | system_ac_input_limit | AC input limit | Configured AC input limit for the GX system. |
A
|
CURRENT | MEASUREMENT | INT | — | — | -1 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/AcPowerSetPoint
|
Victron Venus | system_ac_power_set_point | AC power setpoint | Configured AC power setpoint for the GX system. ESS Mode 2 - Setpoint for the ESS control-loop in the GX device. The control-loop will increase/decrease the Multi charge/discharge power to get the grid reading to this setpoint. |
W
|
POWER | MEASUREMENT | INT | — | — | -10000 | 10000 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/AlwaysPeakShave
|
Victron Venus | system_ess_always_peak_shave | ESS always peak shave | Controls ESS always peak shave for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/MinimumSocLimit
|
Victron Venus | system_ess_min_soc_limit | ESS min SoC limit | Configured ESS min SoC limit for the GX system. Same as the setting in the GUI. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/Schedule/Charge/{slot}/Day
|
Victron Venus | system_ess_schedule_charge_{slot}_days | ESS BatteryLife schedule charge {slot} days | Selected days for an ESS BatteryLife scheduled-charge slot on the GX system. |
|
ENUM | NONE | ENUM | — | ChargeSchedule | — | — |
|
$$func/system/schedule_charge_enabled:schedule_charge_enabled_set
|
Victron Venus | system_ess_schedule_charge_{slot}_enabled | ESS BatteryLife schedule charge {slot} enabled | Controls whether an ESS scheduled-charge slot is enabled. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/Schedule/Charge/{slot}/Duration
|
Victron Venus | system_ess_schedule_charge_{slot}_duration | ESS BatteryLife schedule charge {slot} duration | Configured duration for an ESS BatteryLife scheduled-charge slot on the GX system. |
min
|
DURATION | MEASUREMENT | INT_SECONDS_TO_MINUTES | 0 | — | 0 | 1440 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/Schedule/Charge/{slot}/Soc
|
Victron Venus | system_ess_schedule_charge_{slot}_soc | ESS BatteryLife schedule charge {slot} SoC | Configured target state of charge for an ESS BatteryLife scheduled-charge slot on the GX system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/Schedule/Charge/{slot}/Start
|
Victron Venus | system_ess_schedule_charge_{slot}_start | ESS BatteryLife schedule charge {slot} start | Configured start time for an ESS BatteryLife scheduled-charge slot on the GX system. |
min
|
TIME | MEASUREMENT | INT_SECONDS_TO_MINUTES | 0 | — | 0 | 86400 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryLife/State
|
Victron Venus | system_ess_batterylife_state_full | ESS BatteryLife state (full) | Selected ESS BatteryLife state (full) for the GX system. |
|
ENUM | NONE | ENUM | — | ESSState | — | — |
|
$$func/system/ess_batterylife_state
|
Victron Venus | system_ess_batterylife_state_sensor | ESS BatteryLife state | Current internal BatteryLife state used by ESS. |
|
ENUM | NONE | ENUM | — | ESSState | — | — |
|
$$func/system/ess_user_mode:ess_user_mode_set
|
Victron Venus | system_ess_batterylife_state | ESS mode | Derived user-facing ESS operating mode, such as optimized operation, keeping batteries charged, or external control. |
|
ENUM | NONE | ENUM | — | ESSUserMode | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/BatteryUse
|
Victron Venus | system_ess_battery_use | ESS only critical loads from battery | Controls ESS only critical loads from battery for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/Hub4Mode
|
Victron Venus | system_ess_mode | ESS mode (Hub4) | Selected ESS mode (Hub4) for the GX system. |
|
ENUM | NONE | ENUM | — | ESSModeHub4 | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/MaxChargePower
|
Victron Venus | system_ess_max_charge_power | ESS max charge power limit | Configured ESS max charge power limit for the GX system. |
W
|
POWER | MEASUREMENT | INT | — | — | -1 | 1000000 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/MaxDischargePower
|
Victron Venus | system_ess_max_inverter_power_limit | ESS max inverter power limit | Configured ESS max inverter power limit for the GX system. ESS Mode 2 – similar to 2702, but as an absolute value instead of a percentage. |
W
|
POWER | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/MaxFeedInPower
|
Victron Venus | system_ess_max_feed_in_power | ESS max feed-in power | Configured ESS max feed-in power for the GX system. -1: No limit, >=0: limited system feed-in. Applies to DC-coupled and AC-coupled feed-in. |
W
|
POWER | MEASUREMENT | INT | — | — | -1 | 1000000 |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/OvervoltageFeedIn
|
Victron Venus | system_settings_overvoltage_feedin | DC-coupled PV - feed in excess | Controls DC-coupled PV - feed in excess for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/CGwacs/PreventFeedback
|
Victron Venus | system_settings_prevent_ac_feedin | AC-coupled PV - feed in excess | Controls AC-coupled PV - feed in excess for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOffInverted | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/DynamicEss/Mode
|
Victron Venus | system_settings_dess_mode | DESS mode | Selected DESS mode for the GX system. |
|
ENUM | NONE | ENUM | — | DESSMode | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/Enabled
|
Generator | generator_{gen_id}_start_on_voltage_enabled | Generator start on voltage enabled | Controls generator start on voltage enabled for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/QuietHoursStartValue
|
Generator | generator_{gen_id}_qh_start_on_voltage | Generator QH start on voltage | Configured generator QH start on voltage for the GX system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/QuietHoursStopValue
|
Generator | generator_{gen_id}_qh_stop_on_voltage | Generator QH stop on voltage | Configured generator QH stop on voltage for the GX system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StartTimer
|
Generator | generator_{gen_id}_start_on_voltage_timer | Generator start on voltage timer | Configured generator start on voltage timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StartValue
|
Generator | generator_{gen_id}_start_on_voltage | Generator start on voltage | Configured generator start on voltage for the GX system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StopTimer
|
Generator | generator_{gen_id}_stop_on_voltage_timer | Generator stop on voltage timer | Configured generator stop on voltage timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/BatteryVoltage/StopValue
|
Generator | generator_{gen_id}_stop_on_voltage | Generator stop on voltage | Configured generator stop on voltage for the GX system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/CoolDownTime
|
Generator | generator_{gen_id}_cool_down_timer | Generator cooldown timer | Configured generator cooldown timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | 0 | 600 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/GeneratorStopTime
|
Generator | generator_{gen_id}_shut_down_timer | Generator shutdown timer | Configured generator shutdown timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | 0 | 600 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/Enabled
|
Generator | generator_{gen_id}_start_on_temp_enabled | Generator start on high temp enabled | Controls generator start on high temp enabled for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/StartTimer
|
Generator | generator_{gen_id}_start_on_temp_timer | Generator start on temp timer | Configured generator start on temp timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/InverterHighTemp/StopTimer
|
Generator | generator_{gen_id}_stop_on_temp_timer | Generator stop on temp timer | Configured generator stop on temp timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/QuietHours/Enabled
|
Generator | generator_{gen_id}_quiet_hours_enabled | Generator quiet hours enabled | Controls generator quiet hours enabled for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/ServiceInterval
|
Generator | generator_{gen_id}_service_interval | Generator service interval | Configured generator service interval for the GX system. |
h
|
DURATION | MEASUREMENT | INT_SECONDS_TO_HOURS | 0 | — | 0 | 500 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/Enabled
|
Generator | generator_{gen_id}_start_on_soc_enabled | Generator start on SoC enabled | Controls generator start on SoC enabled for the GX system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/QuietHoursStartValue
|
Generator | generator_{gen_id}_qh_start_on_soc | Generator QH start on SoC | Configured generator QH start on SoC for the GX system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/QuietHoursStopValue
|
Generator | generator_{gen_id}_qh_stop_on_soc | Generator QH stop on SoC | Configured generator QH stop on SoC for the GX system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StartTimer
|
Generator | generator_{gen_id}_start_on_soc_timer | Generator start on SoC timer | Configured generator start on SoC timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | 0 | 10000 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StartValue
|
Generator | generator_{gen_id}_start_on_soc | Generator start on SoC | Configured generator start on SoC for the GX system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StopTimer
|
Generator | generator_{gen_id}_stop_on_soc_timer | Generator stop on SoC timer | Configured generator stop on SoC timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | 0 | 10000 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/Soc/StopValue
|
Generator | generator_{gen_id}_stop_on_soc | Generator stop on SoC | Configured generator stop on SoC for the GX system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | INT | — | — | 0 | 100 |
|
N/{installation_id}/settings/{device_id}/Settings/Generator{gen_id(0-1)}/WarmUpTime
|
Generator | generator_{gen_id}_warm_up_timer | Generator warm-up timer | Configured generator warm-up timer for the GX system. |
s
|
DURATION | MEASUREMENT | INT | — | — | 0 | 1800 |
|
N/{installation_id}/settings/{device_id}/Settings/Network/VrmPortal
|
Victron Venus | system_vrm_portal_mode | VRM portal access level | Selected VRM portal access level for the GX system. |
|
ENUM | NONE | ENUM | — | VrmPortalMode | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Relay/{relay}/CustomName
|
Victron Venus | system_relay_{relay}_custom_name | Relay {relay} custom name | Reports the custom name of a numbered GX system relay. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/Services/Bol
|
Victron Venus | system_dvcc_raw | DVCC (raw) | Selected DVCC (raw) for the GX system. |
|
ENUM | NONE | ENUM | — | DVCCMode | — | — |
|
$$func/system/dvcc_enabled:dvcc_enabled_set
|
Victron Venus | system_dvcc | DVCC | Controls whether Distributed Voltage and Current Control (DVCC) is enabled. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
$$func/system/dvcc_state
|
Victron Venus | system_dvcc_state | DVCC state | Current DVCC state, including whether control is forced by the system or BMS. |
|
ENUM | NONE | ENUM | — | DVCCMode | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/AcInput1
|
Victron Venus | system_ac_input_1_type | AC input 1 source type | Selected AC input 1 source type for the GX system. |
|
ENUM | NONE | ENUM | — | AcInputTypeEnum | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/AcInput2
|
Victron Venus | system_ac_input_2_type | AC input 2 source type | Selected AC input 2 source type for the GX system. |
|
ENUM | NONE | ENUM | — | AcInputTypeEnum | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/MaxChargeCurrent
|
Victron Venus | system_ess_max_charge_current | ESS max charge current | Configured ESS max charge current for the GX system. ESS Mode 2 with DVCC – Maximum system charge current. -1 Disables. |
A
|
CURRENT | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/SystemSetup/MaxChargeVoltage
|
Victron Venus | system_ess_max_charge_voltage | ESS max charge voltage | Configured ESS max charge voltage for the GX system. Only used if there is a managed battery in the system. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/settings/{device_id}/Settings/TransferSwitch/GeneratorCurrentLimit
|
Transfer switch | transfer_switch_generator_current_limit | Generator AC current limit | Configured generator AC current limit for the GX system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | 60 |
|
N/{installation_id}/solarcharger/{device_id}/Dc/0/Current
|
Solar charger | solarcharger_dc_current | DC (battery) bus current | Measured DC (battery) bus current for the solar charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Dc/0/Temperature
|
Solar charger | solarcharger_temperature | Temperature | Measured temperature for the solar charger. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Dc/0/Voltage
|
Solar charger | solarcharger_dc_voltage | DC (battery) bus voltage | Measured DC (battery) bus voltage for the solar charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/DeviceOffReason
|
Solar charger | solarcharger_device_off_reason | Device-off reason | Bit mask of conditions preventing the solar charger from operating. |
|
NONE | NONE | BITMASK | — | SolarChargerDeviceOffReason | — | — |
|
N/{installation_id}/solarcharger/{device_id}/ErrorCode
|
Solar charger | solarcharger_error_code | Error code | Current error condition of the solar charger. |
|
ENUM | NONE | ENUM | — | ErrorCode | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MaxBatteryVoltage
|
Solar charger | solarcharger_max_battery_voltage_today | Max battery voltage today | Measured max battery voltage today for the solar charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MaxPower
|
Solar charger | solarcharger_max_power_today | Max power today | Measured max power today for the solar charger. Today's maximum power. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/MinBatteryVoltage
|
Solar charger | solarcharger_min_battery_voltage_today | Min battery voltage today | Measured min battery voltage today for the solar charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/Pv/{tracker}/MaxPower
|
Solar charger | solarcharger_tracker_{tracker}_max_power_today | Tracker {tracker:solarcharger_tracker_{tracker}_name} max power today | Measured maximum power today for a PV tracker of the solar charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/Pv/{tracker}/MaxVoltage
|
Solar charger | solarcharger_tracker_{tracker}_max_voltage_today | Tracker {tracker:solarcharger_tracker_{tracker}_name} max voltage today | Measured maximum voltage today for a PV tracker of the solar charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/Pv/{tracker}/Yield
|
Solar charger | solarcharger_tracker_{tracker}_yield_today | Tracker {tracker:solarcharger_tracker_{tracker}_name} yield today | Energy recorded as today's yield for a PV tracker of the solar charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInAbsorption
|
Solar charger | solarcharger_time_in_absorption_today | Time in absorption today | Reports time in absorption today for the solar charger. |
min
|
DURATION | TOTAL_INCREASING | INT | — | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInBulk
|
Solar charger | solarcharger_time_in_bulk_today | Time in bulk today | Reports time in bulk today for the solar charger. |
min
|
DURATION | TOTAL_INCREASING | INT | — | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/TimeInFloat
|
Solar charger | solarcharger_time_in_float_today | Time in float today | Reports time in float today for the solar charger. |
min
|
DURATION | TOTAL_INCREASING | INT | — | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/0/Yield
|
Solar charger | solarcharger_yield_today | Yield today | Energy recorded as yield today for the solar charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/1/MaxPower
|
Solar charger | solarcharger_max_power_yesterday | Max power yesterday | Measured max power yesterday for the solar charger. Yesterday's maximum power. |
W
|
POWER | NONE | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/History/Daily/1/Yield
|
Solar charger | solarcharger_yield_yesterday | Yield yesterday | Energy recorded as yield yesterday for the solar charger. |
kWh
|
ENERGY | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Load/I
|
Solar charger | solarcharger_load_current | Load bus current | Measured load bus current for the solar charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Load/State
|
Solar charger | solarcharger_load_state | Load state | Indicates whether the solar charger's load output is active. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Mode
|
Solar charger | solarcharger_mode | Mode | Controls mode for the solar charger. |
|
ENUM | NONE | ENUM | — | ChargerMode | — | — |
|
N/{installation_id}/solarcharger/{device_id}/MppOperationMode
|
Solar charger | solarcharger_mppt_operation_mode | MPPT operation mode | Current operating mode of the solar charger. |
|
ENUM | NONE | ENUM | — | MppOperationMode | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Pv/V
|
Solar charger | solarcharger_voltage | PV bus voltage | Measured PV bus voltage for the solar charger. Not available if multiple VE.Can chargers are combined. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Pv/{tracker}/MppOperationMode
|
Solar charger | solarcharger_tracker_{tracker}_operation_mode | PV tracker {tracker:solarcharger_tracker_{tracker}_name} operation mode | Current operating mode of the solar charger. |
|
ENUM | NONE | ENUM | — | MppOperationMode | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Pv/{tracker}/Name
|
Solar charger | solarcharger_tracker_{tracker}_name | PV tracker {tracker} name | Reports the configured name of a PV tracker for the solar charger. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Pv/{tracker}/P
|
Solar charger | solarcharger_tracker_{tracker}_power | PV tracker {tracker:solarcharger_tracker_{tracker}_name} power | Measured power for a PV tracker of the solar charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Pv/{tracker}/V
|
Solar charger | solarcharger_tracker_{tracker}_voltage | PV tracker {tracker:solarcharger_tracker_{tracker}_name} voltage | Measured voltage for a PV tracker of the solar charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
$$func/solarcharger/pv_current
|
Solar charger | solarcharger_tracker_{tracker}_current | PV tracker {tracker:solarcharger_tracker_{tracker}_name} current | Calculates current for a PV tracker of the solar charger from PV power and voltage. |
A
|
CURRENT | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Relay/0/State
|
Solar charger | solarcharger_relay_state | Relay state | Controls relay state for the solar charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Settings/ChargeCurrentLimit
|
Solar charger | solarcharger_charge_current_limit | Charge current limit | Configured charge current limit for the solar charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | {"capability"=>"max_charge_current", "default"=>200} |
|
N/{installation_id}/solarcharger/{device_id}/State
|
Solar charger | solarcharger_state | State | Current operating state of the solar charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Yield/Power
|
Solar charger | solarcharger_yield_power | PV yield power | Measured PV yield power for the solar charger. Older 16-bit variant of 789. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
$$func/solarcharger/pv_current
|
Solar charger | solarcharger_pv_current | PV current | Calculates total PV current for the solar charger from PV power and voltage. |
A
|
CURRENT | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Yield/System
|
Solar charger | solarcharger_total_pv_yield_system | Total PV yield system | Energy recorded as total PV yield system for the solar charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 2 | — | — | — |
|
N/{installation_id}/solarcharger/{device_id}/Yield/User
|
Solar charger | solarcharger_yield_total | Total yield | Energy recorded as total yield for the solar charger. Energy generated by the solarcharger since last user reset. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 2 | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Dimming
|
Switch | switch_{output}_dimming | Dimming | Configured dimming for the switch device. |
switch_{output}_unit:%
|
DYNAMIC | NONE | FLOAT | — | — | switch_{output}_dimming_min:0 | switch_{output}_dimming_max:100 |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/DimmingMax
|
Switch | switch_{output}_dimming_max | Dimming max | Reports dimming max for the switch device. |
—
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/DimmingMin
|
Switch | switch_{output}_dimming_min | Dimming min | Reports dimming min for the switch device. |
—
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/Labels
|
Switch | switch_{output}_labels | Labels | Reports labels for the switch device. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/StepSize
|
Switch | switch_{output}_step_size | Step size | Reports step size for the switch device. |
—
|
NONE | NONE | FLOAT | — | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/Type
|
Switch | switch_{output}_type | Output type | Configured output type for the switch device. |
|
ENUM | NONE | ENUM | — | SwitchableOutputType | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/Settings/Unit
|
Switch | switch_{output}_unit | Unit | Reports unit for the switch device. |
—
|
NONE | NONE | STRING | — | — | — | — |
|
N/{installation_id}/switch/{device_id}/SwitchableOutput/{output}/State
|
Switch | switch_{output}_state | State | Reports state for the switch device. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/Ac/ActiveIn/Source
|
Victron Venus | system_ac_active_input_source | AC active input source | Current AC active input source for the system. |
|
ENUM | NONE | ENUM | — | ACActiveInputSource | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Consumption/NumberOfPhases
|
Victron Venus | system_consumption_phases | Consumption phases | Reports consumption phases for the system. |
phases
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Consumption/{phase}/Current
|
Victron Venus | system_consumption_current_{phase} | Consumption current {phase} | Measured consumption current for an AC phase of the system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Consumption/{phase}/Power
|
Victron Venus | system_consumption_power_{phase} | Consumption power {phase} | Measured consumption power for an AC phase of the system. Power supplied by system to loads. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnInput/{phase}/Power
|
Victron Venus | system_ac_loads_{phase} | AC loads on {phase} | Measured AC loads on an AC phase for the system. This is the power shown on the overview in the Loads box. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnOutput/NumberOfPhases
|
Victron Venus | system_consumption_on_output_phases | Consumption on output phases | Reports consumption on output phases for the system. |
phases
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/ConsumptionOnOutput/{phase}/Power
|
Victron Venus | system_critical_loads_{phase} | Critical loads on {phase} | Measured critical loads on an AC phase for the system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Genset/{phase}/Power
|
Victron Venus | system_generator_load_{phase} | Genset load {phase} | Measured genset load for an AC phase of the system. Power supplied by the genset to the system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Grid/NumberOfPhases
|
Victron Venus | system_grid_phases | Grid phases | Reports grid phases for the system. |
phases
|
NONE | NONE | INT_DEFAULT_0 | — | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Grid/{phase}/Current
|
Victron Venus | system_grid_current_{phase} | Grid current {phase} | Measured grid current for an AC phase of the system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/Grid/{phase}/Power
|
Victron Venus | system_grid_power_{phase} | Grid power {phase} | Measured grid power for an AC phase of the system. Power supplied by the grid to the system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnGrid/NumberOfPhases
|
Victron Venus | system_pv_on_grid_phases | PV on grid phases | Reports PV on grid phases for the system. |
phases
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnGrid/{phase}/Current
|
Victron Venus | system_pv_on_grid_current_{phase} | PV on grid current {phase} | Measured current for an AC phase of grid-connected PV on the system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnGrid/{phase}/Power
|
Victron Venus | system_pv_on_grid_power_{phase} | PV on grid power {phase} | Measured power for an AC phase of grid-connected PV on the system. Summation of all AC-coupled PV inverters on the input. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/NumberOfPhases
|
Victron Venus | system_pv_on_output_phases | PV on output phases | Reports PV on output phases for the system. |
phases
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/{phase}/Current
|
Victron Venus | system_pv_on_output_current_{phase} | PV on output current {phase} | Measured current for an AC phase of output-connected PV on the system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Ac/PvOnOutput/{phase}/Power
|
Victron Venus | system_pv_on_output_power_{phase} | PV on output power {phase} | Measured power for an AC phase of output-connected PV on the system. Summation of all AC-coupled PV inverters on the output. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Control/ActiveSocLimit
|
Victron Venus | system_control_active_soc_limit | Active SoC limit | Reports active SoC limit for the system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/system/{device_id}/Control/ScheduledSoc
|
Victron Venus | system_control_scheduled_soc | Scheduled SoC | Reports scheduled SoC for the system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/system/{device_id}/Dc/Alternator/Power
|
Victron Venus | system_dc_alternator_power | DC alternator power | Measured DC alternator power for the system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Battery/Current
|
Victron Venus | system_dc_battery_current | DC battery current | Measured DC battery current for the system. Positive values indicate charging; negative values indicate discharging. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Battery/Power
|
Victron Venus | system_dc_battery_power | DC battery power | Measured DC battery power for the system. Positive values indicate charging; negative values indicate discharging. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
$$func/system/system_dc_battery_charge_power
|
Victron Venus | system_dc_battery_charge_energy | DC battery charge energy | Integrates battery charging power over time to calculate charged energy. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
$$func/system/system_dc_battery_discharge_power
|
Victron Venus | system_dc_battery_discharge_energy | DC battery discharge energy | Integrates battery discharging power over time to calculate discharged energy. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Battery/Soc
|
Victron Venus | system_dc_battery_soc | DC battery charge | Reports DC battery charge for the system. Best battery state of charge, determined from different measurements. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 1 | — | 0 | 100 |
|
N/{installation_id}/system/{device_id}/Dc/Battery/State
|
Victron Venus | system_dc_battery_state | DC battery state | Current DC battery state, indicating whether the battery is charging, discharging, or idle. |
|
ENUM | NONE | ENUM | — | BatteryState | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Battery/Voltage
|
Victron Venus | system_dc_battery_voltage | DC battery voltage | Measured DC battery voltage for the system. Battery Voltage determined from different measurements. In order of preference: BMV-voltage (V), Multi-DC-Voltage (CV), MPPT-DC-Voltage (ScV), Charger voltage. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Pv/Current
|
Victron Venus | system_dc_pv_current | PV current | Measured PV current for the system. Summation of output current of all connected Solar Chargers. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/Pv/Power
|
Victron Venus | system_dc_pv_power | PV power | Measured PV power for the system. Summation of output power of all connected Solar Chargers. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
$$func/system/left_riemann_sum
|
Victron Venus | system_dc_pv_energy | PV energy | Integrates DC PV power over time to calculate generated energy. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/system/{device_id}/Dc/System/Power
|
Victron Venus | system_dc_consumption | DC consumption | Measured DC consumption for the system. Power supplied by Battery to system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/Active
|
Victron Venus | system_dynamicess_active | Dynamic ESS active | Indicates whether Dynamic ESS is active. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/AllowGridFeedIn
|
Victron Venus | system_dynamicess_allow_gridfeedin | Dynamic ESS allow grid feed-in | Indicates whether Dynamic ESS allows grid feed-in. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/Available
|
Victron Venus | system_dynamicess_available | Dynamic ESS available | Indicates whether Dynamic ESS is available. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/AvailableOverhead
|
Victron Venus | system_dynamicess_available_overhead | Dynamic ESS available overhead | Measured dynamic ESS available overhead for the system. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/ErrorCode
|
Victron Venus | system_dynamicess_error | Dynamic ESS error | Current error condition of the system. |
|
ENUM | NONE | ENUM | — | DESSErrorCode | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/LastScheduledEnd
|
Victron Venus | system_dynamicess_last_scheduled_end | Dynamic ESS last scheduled end | Reports dynamic ESS last scheduled end for the system. |
—
|
TIMESTAMP | NONE | EPOCH | — | — | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/LastScheduledStart
|
Victron Venus | system_dynamicess_last_scheduled_start | Dynamic ESS last scheduled start | Reports dynamic ESS last scheduled start for the system. |
—
|
TIMESTAMP | NONE | EPOCH | — | — | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/MinimumSoc
|
Victron Venus | system_dynamicess_minimum_soc | Dynamic ESS minimum SoC | Reports dynamic ESS minimum SoC for the system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 0 | — | 0 | 100 |
|
N/{installation_id}/system/{device_id}/DynamicEss/NumberOfSchedules
|
Victron Venus | system_dynamicess_schedule_count | Dynamic ESS number of schedules | Reports dynamic ESS number of schedules for the system. |
schedules
|
NONE | NONE | INT | — | — | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/ReactiveStrategy
|
Victron Venus | system_dynamicess_reactive_strategy | Dynamic ESS reactive strategy | Current dynamic ESS reactive strategy for the system. |
|
ENUM | NONE | ENUM | — | DESSReactiveStrategy | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/Restrictions
|
Victron Venus | system_dynamicess_restrictions | Dynamic ESS restrictions | Active restrictions on energy flow between the battery and grid. |
|
ENUM | NONE | ENUM | — | DESSRestrictions | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/Strategy
|
Victron Venus | system_dynamicess_strategy | Dynamic ESS strategy | Current dynamic ESS strategy for the system. |
|
ENUM | NONE | ENUM | — | DESSStrategy | — | — |
|
N/{installation_id}/system/{device_id}/DynamicEss/TargetSoc
|
Victron Venus | system_dynamicess_target_soc | Dynamic ESS target SoC | Reports dynamic ESS target SoC for the system. |
%
|
ELECTRIC_STORAGE_PERCENTAGE | MEASUREMENT | FLOAT | 0 | — | 0 | 100 |
|
N/{installation_id}/system/{device_id}/PV/Current
|
Solar charger | solarcharger_current | PV bus current | Measured PV bus current for the system. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/system/{device_id}/Relay/{relay}/State
|
Victron Venus | system_relay_{relay} | Relay {relay} state | Controls the state of a numbered system relay. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/SwitchableOutput/{output}/State
|
Switchable output | switchable_output_{output}_state | State | Controls state for the system. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/system/{device_id}/SystemState/State
|
Victron Venus | system_state | System state | Current operating state of the system. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
N/{installation_id}/tank/{device_id}/BatteryVoltage
|
Liquid tank | tank_battery_voltage | Sensor battery voltage | Measured sensor battery voltage for the tank sensor. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/tank/{device_id}/FluidType
|
Liquid tank | tank_fluid_type | Fluid type | Configured fluid type for the tank sensor. |
|
ENUM | NONE | ENUM | — | FluidType | — | — |
|
N/{installation_id}/tank/{device_id}/Level
|
Liquid tank | tank_level | Level | Reports level for the tank sensor. |
%
|
PERCENTAGE | MEASUREMENT | INT | — | — | — | — |
|
N/{installation_id}/tank/{device_id}/Remaining
|
Liquid tank | tank_remaining | Remaining | Measured remaining for the tank sensor. |
L
|
LIQUID_VOLUME | MEASUREMENT | FLOAT_M3_TO_LITERS | 1 | — | — | — |
|
N/{installation_id}/tank/{device_id}/Temperature
|
Liquid tank | tank_temperature | Temperature | Measured temperature for the tank sensor. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/BatteryVoltage
|
Temperature | temperature_battery_voltage | Sensor battery voltage | Measured sensor battery voltage for the temperature sensor. Used by wireless tags that have a battery in the sensor. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/Humidity
|
Temperature | temperature_humidity | Humidity | Measured humidity for the temperature sensor. Relative humidity as a percentage. Only available on sensors that has this feature, eg Ruuvi. |
%
|
HUMIDITY | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/Offset
|
Temperature | temperature_offset | Offset | Configured offset for the temperature sensor. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/Pressure
|
Temperature | temperature_pressure | Pressure | Measured pressure for the temperature sensor. Only available on sensors that has this feature, eg Ruuvi. |
hPa
|
PRESSURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/Scale
|
Temperature | temperature_scale | Scale factor | Configured scale factor for the temperature sensor. |
—
|
NONE | NONE | FLOAT | 2 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/Status
|
Temperature | temperature_status | Sensor status | Current status of the temperature sensor. |
|
ENUM | NONE | ENUM | — | TemperatureStatus | — | — |
|
N/{installation_id}/temperature/{device_id}/Temperature
|
Temperature | temperature_temperature | Temperature | Measured temperature for the temperature sensor. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/temperature/{device_id}/TemperatureType
|
Temperature | temperature_type | Sensor type | Configured sensor type for the temperature sensor. |
|
ENUM | NONE | ENUM | — | TemperatureType | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/ActiveInput
|
VE.Bus | vebus_inverter_active_input | Active AC input | Current active AC input for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | ACActiveInputSource | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/CurrentLimit
|
VE.Bus | vebus_inverter_current_limit | Current limit | Configured current limit for the VE.Bus inverter/charger. See Venus-OS manual for limitations, for example when VE.Bus BMS or DMC is installed. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | 0 | 16 |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/F
|
VE.Bus | vebus_inverter_input_frequency_{phase} | Input frequency {phase} | Measured input frequency for an AC phase of the VE.Bus inverter/charger. |
Hz
|
FREQUENCY | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/I
|
VE.Bus | vebus_inverter_input_current_{phase} | Input current {phase} | Measured input current for an AC phase of the VE.Bus inverter/charger. Positive values flow from mains to the unit; negative values flow from the unit to mains. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/P
|
VE.Bus | vebus_inverter_input_power_{phase} | Input power {phase} | Measured input power for an AC phase of the VE.Bus inverter/charger. Uses the same sign convention as input current. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/S
|
VE.Bus | vebus_inverter_input_apparent_power_{phase} | Input apparent power {phase} | Measured input apparent power for an AC phase of the VE.Bus inverter/charger. |
VA
|
APPARENT_POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/ActiveIn/{phase}/V
|
VE.Bus | vebus_inverter_input_voltage_{phase} | Input voltage {phase} | Measured input voltage for an AC phase of the VE.Bus inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Control/IgnoreAcIn1
|
VE.Bus | vebus_inverter_ignoreacin1_onoff_control | Control ignore AC-in-1 | Controls whether the VE.Bus inverter/charger ignores AC-in-1. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/F
|
VE.Bus | vebus_inverter_output_frequency_{phase} | Output frequency {phase} | Measured output frequency for an AC phase of the VE.Bus inverter/charger. |
Hz
|
FREQUENCY | MEASUREMENT | FLOAT | 2 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/I
|
VE.Bus | vebus_inverter_output_current_{phase} | Output current {phase} | Measured output current for an AC phase of the VE.Bus inverter/charger. Positive values flow from the inverter/charger to the load; negative values flow from the load to the inverter/charger. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/P
|
VE.Bus | vebus_inverter_output_power_{phase} | Output power {phase} | Measured output power for an AC phase of the VE.Bus inverter/charger. Uses the same sign convention as output current. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/S
|
VE.Bus | vebus_inverter_output_apparent_power_{phase} | Output apparent power {phase} | Measured output apparent power for an AC phase of the VE.Bus inverter/charger. |
VA
|
APPARENT_POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/Out/{phase}/V
|
VE.Bus | vebus_inverter_output_voltage_{phase} | Output voltage {phase} | Measured output voltage for an AC phase of the VE.Bus inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/State/IgnoreAcIn1
|
VE.Bus | vebus_inverter_ignoreacin1_state | State of ignore AC-in-1 | Indicates whether the VE.Bus inverter/charger is ignoring AC-in-1. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Ac/State/RemoteGeneratorSelected
|
VE.Bus | vebus_inverter_remote_generator_selected | Remote generator selected | Indicates whether remote generator control is selected on the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/GridLost
|
VE.Bus | vebus_inverter_alarm_grid_lost | Grid lost alarm | Current severity of the grid lost alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/HighDcCurrent
|
VE.Bus | vebus_inverter_alarm_high_dc_current | High DC current alarm | Current severity of the high DC current alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/HighDcVoltage
|
VE.Bus | vebus_inverter_alarm_high_dc_voltage | High DC voltage alarm | Current severity of the high DC voltage alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/HighTemperature
|
VE.Bus | vebus_inverter_alarm_high_temperature | High temperature alarm | Current severity of the high temperature alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/LowBattery
|
VE.Bus | vebus_inverter_alarm_low_battery | Low battery alarm | Current severity of the low battery alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/Overload
|
VE.Bus | vebus_inverter_alarm_overload | Overload alarm | Current severity of the overload alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/PhaseRotation
|
VE.Bus | vebus_inverter_alarm_phase_rotation | Phase rotation alarm | Current severity of the phase rotation alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/Ripple
|
VE.Bus | vebus_inverter_alarm_ripple | Ripple alarm | Current severity of the ripple alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/TemperatureSensor
|
VE.Bus | vebus_inverter_alarm_temperature_sensor | Temperature sensor alarm | Current severity of the temperature sensor alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Alarms/VoltageSensor
|
VE.Bus | vebus_inverter_alarm_voltage_sensor | Voltage sensor alarm | Current severity of the voltage sensor alarm for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericAlarmEnum | — | — |
|
N/{installation_id}/vebus/{device_id}/Connected
|
VE.Bus | vebus_inverter_connected | Connected | Indicates whether the VE.Bus inverter/charger is connected. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Dc/0/Current
|
VE.Bus | vebus_inverter_dc_current | DC current | Measured DC current for the VE.Bus inverter/charger. Positive: current flowing from the Multi to the dc system. Negative: the other way around. |
A
|
CURRENT | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Dc/0/Power
|
VE.Bus | vebus_inverter_dc_power | DC power | Measured DC power for the VE.Bus inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Dc/0/PreferRenewableEnergy
|
VE.Bus | vebus_inverter_prefer_renewable_energy_raw | Prefer renewable energy (raw) | Selected prefer renewable energy (raw) for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | PreferRenewableEnergyEnum | — | — |
|
$$func/vebus/prefer_renewable_energy:prefer_renewable_energy_set
|
VE.Bus | vebus_inverter_prefer_renewable_energy | Prefer renewable energy | Controls whether the VE.Bus inverter/charger prioritizes renewable energy. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Dc/0/Temperature
|
VE.Bus | vebus_inverter_dc_temperature | DC temperature | Measured DC temperature for the VE.Bus inverter/charger. |
°C
|
TEMPERATURE | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Dc/0/Voltage
|
VE.Bus | vebus_inverter_dc_voltage | DC voltage | Measured DC voltage for the VE.Bus inverter/charger. |
V
|
VOLTAGE | MEASUREMENT | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Ac/In/P
|
VE.Bus | vebus_device_{device_number}_input_power_l1 | {device_number} line 1 input power | Measured line 1 input power for an individual VE.Bus unit. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Ac/In/{phase}/P
|
VE.Bus | vebus_device_{device_number}_input_power_{phase} | {device_number} line {phase} input power | Measured input power for an AC phase of an individual VE.Bus unit. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Ac/Inverter/P
|
VE.Bus | vebus_device_{device_number}_inverted_power | {device_number} inverted power | Measured inverted power for an individual VE.Bus unit. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Ac/Out/P
|
VE.Bus | vebus_device_{device_number}_output_power_l1 | {device_number} line 1 output power | Measured line 1 output power for an individual VE.Bus unit. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Ac/Out/{phase}/P
|
VE.Bus | vebus_device_{device_number}_output_power_{phase} | {device_number} line {phase} output power | Measured output power for an AC phase of an individual VE.Bus unit. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Devices/{device_number}/Settings/PowerAssistEnabled
|
VE.Bus | vebus_device_{device_number}_power_assist_enabled | {device_number} PowerAssist enabled | Controls whether PowerAssist is enabled for an individual VE.Bus unit. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcIn1ToAcOut
|
VE.Bus | vebus_energy_ac_in1_to_ac_out | Energy from AC-in-1 to AC-out | Energy recorded as energy from AC-in-1 to AC-out for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcIn1ToInverter
|
VE.Bus | vebus_energy_ac_in1_to_inverter | Energy from AC-in-1 to inverter | Energy recorded as energy from AC-in-1 to inverter for the VE.Bus inverter/charger. Energy counters from the Multi(s) are volatile. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcIn2ToAcOut
|
VE.Bus | vebus_energy_ac_in2_to_ac_out | Energy from AC-in-2 to AC-out | Energy recorded as energy from AC-in-2 to AC-out for the VE.Bus inverter/charger. These energy counters reset to zero when the Multi is switched off. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcIn2ToInverter
|
VE.Bus | vebus_energy_ac_in2_to_inverter | Energy from AC-in-2 to inverter | Energy recorded as energy from AC-in-2 to inverter for the VE.Bus inverter/charger. These energy counters ALSO reset to zero when the GX-device reboots. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcOutToAcIn1
|
VE.Bus | vebus_energy_ac_out_to_ac_in1 | Energy from AC-out to AC-in-1 | Energy recorded as energy from AC-out to AC-in-1 for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/AcOutToAcIn2
|
VE.Bus | vebus_energy_ac_out_to_ac_in2 | Energy from AC-out to AC-in-2 | Energy recorded as energy from AC-out to AC-in-2 for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/InverterToAcIn1
|
VE.Bus | vebus_energy_inverter_to_ac_in1 | Energy from inverter to AC-in-1 | Energy recorded as energy from inverter to AC-in-1 for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/InverterToAcIn2
|
VE.Bus | vebus_energy_inverter_to_ac_in2 | Energy from inverter to AC-in-2 | Energy recorded as energy from inverter to AC-in-2 for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/InverterToAcOut
|
VE.Bus | vebus_energy_inverter_to_ac_out | Energy from inverter to AC-out | Energy recorded as energy from inverter to AC-out for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Energy/OutToInverter
|
VE.Bus | vebus_energy_out_to_inverter | Energy from out to inverter | Energy recorded as energy from out to inverter for the VE.Bus inverter/charger. |
kWh
|
ENERGY | TOTAL_INCREASING | FLOAT | 3 | — | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/DisableCharge
|
VE.Bus | vebus_hub4_disable_charge | Hub4 disable charge | Controls Hub4 disable charge for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/DisableFeedIn
|
VE.Bus | vebus_hub4_disable_feed_in | Hub4 disable feed-in | Controls Hub4 disable feed-in for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/DoNotFeedInOvervoltage
|
VE.Bus | vebus_hub4_do_not_feed_in_overvoltage | Hub4 do not feed in on overvoltage | Controls Hub4 do not feed in on overvoltage for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/FixSolarOffsetTo100mV
|
VE.Bus | vebus_hub4_fix_solar_offset_100mv | Hub4 fix solar offset to 100mV | Controls Hub4 fix solar offset to 100mV for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/TargetPowerIsMaxFeedIn
|
VE.Bus | vebus_hub4_target_power_is_max_feed_in | Hub4 target power is max feed-in | Controls Hub4 target power is max feed-in for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Hub4/{phase}/AcPowerSetpoint
|
VE.Bus | vebus_ac_power_setpoint_{phase} | AC power setpoint {phase} | Configured AC power setpoint for an AC phase of the VE.Bus inverter/charger. ESS Mode 3 instructs the unit to charge or discharge to the requested power; negative values request discharge. Used by the control loop in grid-parallel systems. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | -10000 | 10000 |
|
N/{installation_id}/vebus/{device_id}/Mode
|
VE.Bus | vebus_inverter_mode | Mode | Selected operating mode for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | InverterMode | — | — |
|
N/{installation_id}/vebus/{device_id}/PvInverter/Disable
|
VE.Bus | vebus_pvinverter_disable | Vebus PV inverter disable | Controls vebus PV inverter disable for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Settings/Alarm/System/GridLost
|
VE.Bus | vebus_inverter_setting_alarm_grid_lost | Grid lost alarm setting | Controls grid lost alarm setting for the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | GenericOnOff | — | — |
|
N/{installation_id}/vebus/{device_id}/Settings/AssistCurrentBoostFactor
|
MultiPlus | multiplus_assist_current_boost_factor | Assist current boost factor | Configured assist current boost factor for the VE.Bus inverter/charger. These 4 settings were first introduced I Venus 3.30, but immediately redefined as they did not work properly. |
—
|
NONE | NONE | FLOAT | 3 | — | 0.25 | 3.5 |
|
N/{installation_id}/vebus/{device_id}/State
|
VE.Bus | vebus_inverter_state | State | Current operating state of the VE.Bus inverter/charger. |
|
ENUM | NONE | ENUM | — | State | — | — |
|
W/{installation_id}/generator/{device_id}/ServiceCounterReset
|
Generator | generator_service_counter_reset | Generator service counter reset | Requests generator service counter reset on the generator. |
resets
|
NONE | NONE | INT | — | — | — | — |
|
W/{installation_id}/multi/{device_id}/Ess/AcPowerSetpoint
|
Multi RS Solar | multi_service_ess_ac_power_setpoint | Set ESS AC power setpoint | Sets the ESS AC power setpoint on the Multi RS inverter/charger. |
W
|
POWER | MEASUREMENT | FLOAT | 1 | — | -12500 | 12500 |
|
W/{installation_id}/platform/{device_id}/Firmware/Online/Check
|
Platform | platform_service_venus_firmware_check | Check for firmware update | Requests an online firmware update check on the GX device. |
—
|
NONE | NONE | INT | — | — | — | — |
|
W/{installation_id}/platform/{device_id}/Firmware/Online/Install
|
Platform | platform_service_venus_firmware_install | Install firmware update | Requests installation of the available firmware update on the GX device. |
—
|
NONE | NONE | INT | — | — | — | — |
Value reference
Enums translate numeric MQTT payloads into operating modes, alarm states, relay statuses, and other human-readable values.
| ID | Value | Display Name | Description |
|---|---|---|---|
| unknown | 0 |
Unknown | The active AC input source cannot be identified from the system configuration. |
| grid | 1 |
Grid | The active AC input is configured as utility grid power. |
| generator | 2 |
Generator | The active AC input is configured as generator power. |
| shore_power | 3 |
Shore power | The active AC input is configured as shore power. |
| not_connected | 240 |
Not connected | No AC input is connected; the system is operating without an external AC source. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| charger_only | 1 |
Charger only | The AC system may charge batteries but does not invert DC power to AC. |
| inverter_only | 2 |
Inverter only | The AC system may invert DC power to AC but does not charge from AC input. |
| on | 3 |
On | Charging, inversion, and AC passthrough are enabled as conditions require. |
| off | 4 |
Off | The AC system is disabled. |
| passthrough | 251 |
Passthrough | AC input is passed to the output without charging or inverting. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| not_used | 0 |
Not used | The AC input is configured as unused. |
| grid | 1 |
Grid | The AC input is configured for utility grid power. |
| generator | 2 |
Generator | The AC input is configured for generator power. |
| shore | 3 |
Shore | The AC input is configured for shore power. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| ac_input_1 | 0 |
AC input 1 | AC input 1 is the active source. |
| ac_input_2 | 1 |
AC input 2 | AC input 2 is the active source. |
| disconnected | 240 |
Disconnected | Neither AC input is currently connected. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| on | 3 |
On | The BMS contactor is closed for normal battery operation. |
| off | 4 |
Off | The BMS contactor is open and battery operation is disabled. |
| standby | 252 |
Standby | The BMS is powered but waiting in standby. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| idle | 0 |
Idle | The battery is neither charging nor discharging significantly. |
| charging | 1 |
Charging | Net current is flowing into the battery. |
| discharging | 2 |
Discharging | Net current is flowing out of the battery. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| disabled_sunday | -10 |
Disabled (Sunday) | Disables this scheduled-charge slot on sunday. |
| disabled_weekend | -9 |
Disabled (Weekends) | Disables this scheduled-charge slot on weekends. |
| disabled_weekdays | -8 |
Disabled (Weekdays) | Disables this scheduled-charge slot on weekdays. |
| disabled_every_day | -7 |
Disabled (Every day) | Disables this scheduled-charge slot on every day. |
| disabled_saturday | -6 |
Disabled (Saturday) | Disables this scheduled-charge slot on saturday. |
| disabled_friday | -5 |
Disabled (Friday) | Disables this scheduled-charge slot on friday. |
| disabled_thursday | -4 |
Disabled (Thursday) | Disables this scheduled-charge slot on thursday. |
| disabled_wednesday | -3 |
Disabled (Wednesday) | Disables this scheduled-charge slot on wednesday. |
| disabled_tuesday | -2 |
Disabled (Tuesday) | Disables this scheduled-charge slot on tuesday. |
| disabled_monday | -1 |
Disabled (Monday) | Disables this scheduled-charge slot on monday. |
| sunday | 0 |
Sunday | Runs this scheduled-charge slot on sunday. |
| monday | 1 |
Monday | Runs this scheduled-charge slot on monday. |
| tuesday | 2 |
Tuesday | Runs this scheduled-charge slot on tuesday. |
| wednesday | 3 |
Wednesday | Runs this scheduled-charge slot on wednesday. |
| thursday | 4 |
Thursday | Runs this scheduled-charge slot on thursday. |
| friday | 5 |
Friday | Runs this scheduled-charge slot on friday. |
| saturday | 6 |
Saturday | Runs this scheduled-charge slot on saturday. |
| every_day | 7 |
Every day | Runs this scheduled-charge slot on every day. |
| weekdays | 8 |
Weekdays | Runs this scheduled-charge slot on weekdays. |
| weekends | 9 |
Weekends | Runs this scheduled-charge slot on weekends. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| on | 1 |
On | The charger is enabled and may charge when operating conditions permit. |
| off | 4 |
Off | The charger is disabled. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| no_error | 0 |
No error | Dynamic ESS has no active configuration or scheduling error. |
| no_ess | 1 |
No ESS | Dynamic ESS cannot operate because ESS is unavailable. |
| ess_mode | 2 |
ESS mode | Dynamic ESS cannot operate with the currently selected ESS mode. |
| no_schedule | 3 |
No matching schedule | Dynamic ESS has no schedule matching the current time. |
| soc_low | 4 |
SoC low | Dynamic ESS is constrained because battery state of charge is too low. |
| battry_capacity_not_configured | 5 |
Battery capacity not configured | Dynamic ESS cannot calculate a schedule because battery capacity is not configured. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | Dynamic ESS is disabled. |
| auto_vrm | 1 |
Auto / VRM | Dynamic ESS follows schedules received automatically from VRM. |
| buy | 2 |
Buy | Dynamic ESS is forced to buy energy from the grid. |
| sell | 3 |
Sell | Dynamic ESS is forced to sell energy to the grid. |
| node_red | 4 |
Node-RED | Dynamic ESS is controlled locally, such as through Node-RED. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| scheduled_selfconsume | 1 |
Scheduled self-consume | Dynamic ESS follows the scheduled target while prioritizing local self-consumption. |
| scheduled_charge_allow_grid | 2 |
Scheduled charge allow grid | Dynamic ESS charges on schedule and may import the required power from the grid. |
| scheduled_charge_enhanced | 3 |
Scheduled charge enhanced | Dynamic ESS increases scheduled charging to recover the target state of charge. |
| selfconsume_accept_charge | 4 |
Self-consume accept charge | Dynamic ESS accepts additional charging while operating in self-consumption mode. |
| idle_scheduled_feedin | 5 |
Idle scheduled feed-in | Dynamic ESS remains idle while scheduled energy is exported to the grid. |
| scheduled_discharge | 6 |
Scheduled discharge | Dynamic ESS discharges the battery to follow the active schedule. |
| selfconsume_accept_discharge | 7 |
Self-consume accept discharge | Dynamic ESS permits additional battery discharge for local self-consumption. |
| idle_maintain_surplus | 8 |
Idle maintain surplus | Dynamic ESS remains idle to preserve an available energy surplus. |
| idle_maintain_targetsoc | 9 |
Idle maintain target SoC | Dynamic ESS remains idle because the battery is at its target state of charge. |
| scheduled_charge_smooth_transition | 10 |
Scheduled charge smooth transition | Dynamic ESS gradually transitions into scheduled charging. |
| scheduled_charge_feedin | 11 |
Scheduled charge feed-in | Dynamic ESS charges on schedule while allowing permitted grid feed-in. |
| scheduled_charge_no_grid | 12 |
Scheduled charge no grid | Dynamic ESS charges on schedule without importing energy from the grid. |
| scheduled_minimum_discharge | 13 |
Scheduled minimum discharge | Dynamic ESS applies the minimum discharge needed to follow the schedule. |
| selfconsume_no_grid | 14 |
Self-consume no grid | Dynamic ESS serves local loads without importing energy from the grid. |
| idle_no_opportunity | 15 |
Idle no opportunity | Dynamic ESS remains idle because no profitable charge or discharge opportunity exists. |
| unscheduled_charge_catchup_targetsoc | 16 |
Unscheduled charge catch-up target SoC | Dynamic ESS charges outside the schedule to catch up to the target state of charge. |
| selfconsume_increased_discharge | 17 |
Self-consume increased discharge | Dynamic ESS increases battery discharge to cover local consumption. |
| keep_battery_charged | 18 |
Keep battery charged | Dynamic ESS retains energy to keep the battery charged. |
| scheduled_discharge_smooth_transition | 19 |
Scheduled discharge smooth transition | Dynamic ESS gradually transitions into scheduled discharging. |
| dess_disabled | 92 |
DESS disabled | No reactive strategy is active because Dynamic ESS is disabled. |
| selfconsume_unexpected_exception | 93 |
Self-consume unexpected exception | Dynamic ESS fell back from self-consumption because of an unexpected internal exception. |
| selfconsume_faulty_chargerate | 94 |
Self-consume faulty charge rate | Dynamic ESS cannot use the calculated charge rate for self-consumption. |
| unknown_operating_mode | 95 |
Unknown operating mode | Dynamic ESS cannot map the current system operating mode to a strategy. |
| ess_low_soc | 96 |
ESS low SoC | Dynamic ESS is constrained because ESS reports a low battery state of charge. |
| selfconsume_unmapped_state | 97 |
Self-consume unmapped state | Dynamic ESS cannot map the current ESS state to self-consumption behavior. |
| selfconsume_unpredicted | 98 |
Self-consume unpredicted | Dynamic ESS is self-consuming because actual power flow differs from the schedule. |
| no_window | 99 |
No window | Dynamic ESS has no applicable schedule window. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| no_restrictions | 0 |
No restrictions between battery and the grid | Energy may flow in either direction between the battery and grid. |
| battery_to_grid_restricted | 1 |
Battery to grid energy flow restricted | Exporting battery energy to the grid is prohibited. |
| grid_to_battery_restricted | 2 |
Grid to battery energy flow restricted | Charging the battery from the grid is prohibited. |
| no_flow | 3 |
No energy flow between battery and grid | Energy flow between the battery and grid is prohibited in both directions. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| targetsoc | 0 |
Target SoC | Dynamic ESS follows scheduled target state-of-charge values. |
| selfconsume | 1 |
Self-consume | Dynamic ESS prioritizes local self-consumption. |
| probattery | 2 |
Pro battery | Dynamic ESS prioritizes protecting and retaining energy in the battery. |
| progrid | 3 |
Pro grid | Dynamic ESS prioritizes energy trading and grid interaction. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | DVCC is disabled and remains user-controllable. |
| on | 1 |
On | DVCC is enabled and remains user-controllable. |
| forced_off | 2 |
Forced off | DVCC is disabled and forced by the system or BMS. |
| forced_on | 3 |
Forced on | DVCC is enabled and forced by the system or BMS. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| system | system |
Victron Venus | Identifies the Victron Venus MQTT and D-Bus service type. |
| solar_charger | solarcharger |
Solar charger | Identifies the Solar charger MQTT and D-Bus service type. |
| inverter | inverter |
Inverter | Identifies the Inverter MQTT and D-Bus service type. |
| battery | battery |
Battery | Identifies the Battery MQTT and D-Bus service type. |
| grid | grid |
Grid | Identifies the Grid MQTT and D-Bus service type. |
| vebus | vebus |
VE.Bus | Identifies the VE.Bus MQTT and D-Bus service type. |
| evcharger | evcharger |
EV charging station | Identifies the EV charging station MQTT and D-Bus service type. |
| ev | ev |
Electric vehicle | Identifies the Electric vehicle MQTT and D-Bus service type. |
| pvinverter | pvinverter |
PV inverter | Identifies the PV inverter MQTT and D-Bus service type. |
| temperature | temperature |
Temperature | Identifies the Temperature MQTT and D-Bus service type. |
| generator | generator |
Generator | Identifies the Generator MQTT and D-Bus service type. |
| generator0 | Generator0 |
Generator 0 settings | Identifies the Generator 0 settings MQTT and D-Bus service type. |
| generator1 | Generator1 |
Generator 1 settings | Identifies the Generator 1 settings MQTT and D-Bus service type. |
| tank | tank |
Liquid tank | Identifies the Liquid tank MQTT and D-Bus service type. |
| multi_rs_solar | multi |
Multi RS Solar | Identifies the Multi RS Solar MQTT and D-Bus service type. |
| cgwacs | CGwacs |
Maps the CGwacs MQTT and D-Bus service namespace to the system device type. | |
| dc_load | dcload |
DC load | Identifies the DC load MQTT and D-Bus service type. |
| dc_source | dcsource |
DC source | Identifies the DC source MQTT and D-Bus service type. |
| alternator | alternator |
Alternator charger | Identifies the Alternator charger MQTT and D-Bus service type. |
| switch | switch |
Switch | Identifies the Switch MQTT and D-Bus service type. |
| gps | gps |
GPS | Identifies the GPS MQTT and D-Bus service type. |
| system_setup | SystemSetup |
Maps the SystemSetup MQTT and D-Bus service namespace to the system device type. | |
| services | Services |
Maps the Services MQTT and D-Bus service namespace to the system device type. | |
| transfer_switch | TransferSwitch |
Transfer switch | Identifies the Transfer switch MQTT and D-Bus service type. |
| digital_input | digitalinput |
Digital input | Identifies the Digital input MQTT and D-Bus service type. |
| dc_system | dcsystem |
DC system | Identifies the DC system MQTT and D-Bus service type. |
| relay | Relay |
Maps the Relay MQTT and D-Bus service namespace to the system device type. | |
| platform | platform |
Platform | Maps the platform MQTT and D-Bus service namespace to the system device type. |
| heatpump | heatpump |
Heat pump | Identifies the Heat pump MQTT and D-Bus service type. |
| network | Network |
Maps the Network MQTT and D-Bus service namespace to the system device type. | |
| meteo | meteo |
Irradiance sensor | Identifies the Irradiance sensor MQTT and D-Bus service type. |
| dynamic_ess | DynamicEss |
Maps the DynamicEss MQTT and D-Bus service namespace to the system device type. | |
| acload | acload |
AC load | Identifies the AC load MQTT and D-Bus service type. |
| charger | charger |
Charger | Identifies the Charger MQTT and D-Bus service type. |
| hub4 | hub4 |
Hub4 | Identifies the Hub4 MQTT and D-Bus service type. |
| acsystem | acsystem |
Maps the acsystem MQTT and D-Bus service namespace to the system device type. | |
| dcdc | dcdc |
DC/DC charger | Identifies the DC/DC charger MQTT and D-Bus service type. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| high_open | 0 |
High/open | The raw digital input is electrically high or the contact is open. |
| low_closed | 1 |
Low/closed | The raw digital input is electrically low or the contact is closed. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| low | 0 |
Low | The configured digital-input translation reports this state: Low. |
| high | 1 |
High | The configured digital-input translation reports this state: High. |
| off | 2 |
Off | The configured digital-input translation reports this state: Off. |
| on | 3 |
On | The configured digital-input translation reports this state: On. |
| no | 4 |
No | The configured digital-input translation reports this state: No. |
| yes | 5 |
Yes | The configured digital-input translation reports this state: Yes. |
| open | 6 |
Open | The configured digital-input translation reports this state: Open. |
| closed | 7 |
Closed | The configured digital-input translation reports this state: Closed. |
| ok | 8 |
Ok | The configured digital-input translation reports this state: Ok. |
| alarm | 9 |
Alarm | The configured digital-input translation reports this state: Alarm. |
| running | 10 |
Running | The configured digital-input translation reports this state: Running. |
| stopped | 11 |
Stopped | The configured digital-input translation reports this state: Stopped. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| disabled | 0 |
Disabled | The digital input is configured for this function: Disabled. |
| pulse_meter | 1 |
Pulse meter | The digital input is configured for this function: Pulse meter. |
| door_alarm | 2 |
Door alarm | The digital input is configured for this function: Door alarm. |
| bilge_pump | 3 |
Bilge pump | The digital input is configured for this function: Bilge pump. |
| bilge_alarm | 4 |
Bilge alarm | The digital input is configured for this function: Bilge alarm. |
| burglar_alarm | 5 |
Burglar alarm | The digital input is configured for this function: Burglar alarm. |
| smoke_alarm | 6 |
Smoke alarm | The digital input is configured for this function: Smoke alarm. |
| fire_alarm | 7 |
Fire alarm | The digital input is configured for this function: Fire alarm. |
| co2_alarm | 8 |
CO2 alarm | The digital input is configured for this function: CO2 alarm. |
| generator | 9 |
Generator | The digital input is configured for this function: Generator. |
| touch_input_control | 10 |
Touch input control | The digital input is configured for this function: Touch input control. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| self_consumption_batterylife | 0 |
Self-consumption (BatteryLife) | ESS maximizes self-consumption while BatteryLife dynamically protects battery state of charge. |
| self_consumption | 1 |
Self-consumption | ESS maximizes self-consumption using the configured minimum state of charge. |
| keep_charged | 2 |
Keep charged | ESS keeps the battery charged and avoids normal battery discharge. |
| external_control | 3 |
External control | An external controller determines ESS charge and discharge behavior. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| phase_compensation_enabled | 1 |
Optimized mode or 'keep batteries charged' and phase compensation enabled | ESS optimization or keep-charged mode is active with phase compensation enabled. |
| phase_compensation_disabled | 2 |
Optimized mode or 'keep batteries charged' and phase compensation disabled | ESS optimization or keep-charged mode is active with phase compensation disabled. |
| external_control | 3 |
External control | An external controller manages Hub4 power flow. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| with_battery_life | 1 |
Optimized mode with BatteryLife | ESS reports this BatteryLife operating condition: Optimized mode with BatteryLife. |
| self_consumption | 2 |
Self-consumption | ESS reports this BatteryLife operating condition: Self-consumption. |
| self_consumption_soc_exceeds_85 | 3 |
Self-consumption, SoC exceeds 85% | ESS reports this BatteryLife operating condition: Self-consumption, SoC exceeds 85%. |
| self_consumption_soc_at_100 | 4 |
Self-consumption, SoC at 100% | ESS reports this BatteryLife operating condition: Self-consumption, SoC at 100%. |
| soc_below_battery_life_dynamic_soc_limit | 5 |
SoC below BatteryLife dynamic SoC limit | ESS reports this BatteryLife operating condition: SoC below BatteryLife dynamic SoC limit. |
| soc_below_soc_limit_24_hours | 6 |
SoC has been below SoC limit for more than 24 hours. Charging battery with 5 amps | ESS reports this BatteryLife operating condition: SoC has been below SoC limit for more than 24 hours. Charging battery with 5 amps. |
| sustain | 7 |
Multi/Quattro is in sustain | ESS reports this BatteryLife operating condition: Multi/Quattro is in sustain. |
| recharge | 8 |
Recharge, SoC dropped 5% or more below minimum SoC | ESS reports this BatteryLife operating condition: Recharge, SoC dropped 5% or more below minimum SoC. |
| keep_batteries_charged | 9 |
'Keep batteries charged' mode enabled | ESS reports this BatteryLife operating condition: 'Keep batteries charged' mode enabled. |
| self_consumption_soc_above_min | 10 |
Self-consumption, SoC at or above minimum SoC | ESS reports this BatteryLife operating condition: Self-consumption, SoC at or above minimum SoC. |
| self_consumption_soc_below_min | 11 |
Self-consumption, SoC is below minimum SoC | ESS reports this BatteryLife operating condition: Self-consumption, SoC is below minimum SoC. |
| recharge_no_battery_life | 12 |
Recharge, SoC dropped 5% or more below minimum SoC (No BatteryLife) | ESS reports this BatteryLife operating condition: Recharge, SoC dropped 5% or more below minimum SoC (No BatteryLife). |
| ID | Value | Display Name | Description |
|---|---|---|---|
| optimized_battery_life | 1 |
Optimized (with BatteryLife) | ESS optimizes self-consumption while BatteryLife dynamically adjusts the discharge floor. |
| optimized_no_battery_life | 10 |
Optimized (without BatteryLife) | ESS optimizes self-consumption using a fixed minimum state of charge. |
| keep_batteries_charged | 9 |
Keep batteries charged | ESS uses available AC power to keep the batteries charged. |
| external_control | 3 |
External control | An external controller manages ESS charge and discharge behavior. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| no_error | 0 |
No error | The device reports no active error. |
| battery_voltage_too_high | 2 |
Battery voltage too high | The device reports this active error condition: Battery voltage too high. |
| charger_temperature_too_high | 17 |
Charger temperature too high | The device reports this active error condition: Charger temperature too high. |
| charger_over_current | 18 |
Charger over current | The device reports this active error condition: Charger over current. |
| charger_current_reversed | 19 |
Charger current reversed | The device reports this active error condition: Charger current reversed. |
| bulk_time_limit_exceeded | 20 |
Bulk time limit exceeded | The device reports this active error condition: Bulk time limit exceeded. |
| current_sensor_issue | 21 |
Current sensor issue | The device reports this active error condition: Current sensor issue. |
| terminals_overheated | 26 |
Terminals overheated | The device reports this active error condition: Terminals overheated. |
| converter_issue | 28 |
Converter issue | The device reports this active error condition: Converter issue. |
| input_voltage_too_high | 33 |
Input voltage too high (solar panel) | The device reports this active error condition: Input voltage too high (solar panel). |
| input_current_too_high | 34 |
Input current too high (solar panel) | The device reports this active error condition: Input current too high (solar panel). |
| input_shutdown_battery_voltage_too_high | 38 |
Input shutdown (battery voltage too high) | The device reports this active error condition: Input shutdown (battery voltage too high). |
| input_shutdown_reverse_current | 39 |
Input shutdown (reverse current) | The device reports this active error condition: Input shutdown (reverse current). |
| lost_communication_with_device | 65 |
Lost communication with device | The device reports this active error condition: Lost communication with device. |
| synchronized_charging_config_issue | 66 |
Synchronized charging config issue | The device reports this active error condition: Synchronized charging config issue. |
| bms_connection_lost | 67 |
BMS connection lost | The device reports this active error condition: BMS connection lost. |
| network_misconfigured | 68 |
Network misconfigured | The device reports this active error condition: Network misconfigured. |
| factory_calibration_data_lost | 116 |
Factory calibration data lost | The device reports this active error condition: Factory calibration data lost. |
| invalid_incompatible_firmware | 117 |
Invalid/incompatible firmware | The device reports this active error condition: Invalid/incompatible firmware. |
| user_settings_invalid | 119 |
User settings invalid | The device reports this active error condition: User settings invalid. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| manual | 0 |
Manual | Charging current and start or stop behavior are controlled manually. |
| auto | 1 |
Auto | The charging station automatically uses available excess solar power. |
| scheduled_charge | 2 |
Scheduled charge | Charging follows the configured charging schedule. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| ac_out | 0 |
AC out | The charging station is connected to the inverter/charger AC output. |
| ac_input | 1 |
AC input | The charging station is connected on the AC input side of the inverter/charger. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| disconnected | 0 |
Disconnected | No electric vehicle is connected to the charging station. |
| connected | 1 |
Connected | An electric vehicle is connected and waiting for charging to start. |
| charging | 2 |
Charging | The charging station is actively delivering energy to the electric vehicle. |
| charged | 3 |
Charged | The connected electric vehicle has completed charging. |
| waiting_for_sun | 4 |
Waiting for sun | Charging is paused until sufficient excess solar power is available. |
| waiting_for_rfid | 5 |
Waiting for RFID | Charging is waiting for authorization from an RFID card. |
| waiting_for_start | 6 |
Waiting for start | The vehicle is authorized and connected but charging has not started. |
| low_soc | 7 |
Low SoC | Charging behavior is constrained by a low system battery state of charge. |
| ground_test_error | 8 |
Ground test error | The charging station ground safety test failed. |
| welded_contacts_test_error | 9 |
Welded contacts test error | The charging station detected welded power contacts during its safety test. |
| cp_input_test_error | 10 |
CP input test error | The charging station detected an invalid control-pilot input during its safety test. |
| residual_current_detected | 11 |
Residual current detected | The charging station stopped because residual leakage current was detected. |
| undervoltage_detected | 12 |
Undervoltage detected | The charging station stopped because AC supply voltage was too low. |
| overvoltage_detected | 13 |
Overvoltage detected | The charging station stopped because AC supply voltage was too high. |
| overheating_detected | 14 |
Overheating detected | The charging station stopped because its temperature was too high. |
| reserved15 | 15 |
Reserved | Status code 15 is reserved for future EV charging station use. |
| reserved16 | 16 |
Reserved | Status code 16 is reserved for future EV charging station use. |
| reserved17 | 17 |
Reserved | Status code 17 is reserved for future EV charging station use. |
| reserved18 | 18 |
Reserved | Status code 18 is reserved for future EV charging station use. |
| reserved19 | 19 |
Reserved | Status code 19 is reserved for future EV charging station use. |
| charging_limit | 20 |
Charging limit | Charging is constrained by an active current or power limit. |
| start_charging | 21 |
Start charging | The charging station is initiating a charging session. |
| switching_to_3_phase | 22 |
Switching to 3 phase | The charging station is changing from single-phase to three-phase charging. |
| switching_to_1_phase | 23 |
Switching to 1 phase | The charging station is changing from three-phase to single-phase charging. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| not_charging | 0 |
Not charging | The electric vehicle is connected but is not currently charging. |
| low_power_mode | 1 |
Low power mode | The electric vehicle is charging with power constrained to a low level. |
| charging | 3 |
Charging | Energy is actively flowing into the electric vehicle battery. |
| sustain | 244 |
Sustain | Charging is limited to sustain the electric vehicle battery without increasing its state of charge. |
| wake_up | 245 |
Wake up | The charging station is waking the electric vehicle before charging starts. |
| blocked | 250 |
Blocked | Charging cannot start because the electric vehicle or charging station is blocking it. |
| unavailable | 255 |
Unavailable | The electric vehicle charging state is not available. |
| discharging | 256 |
Discharging | Energy is flowing from the electric vehicle battery back to the connected system. |
| scheduled_charging | 259 |
Scheduled charging | The electric vehicle is charging during an active scheduled-charge window. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| update_file_not_found | 997 |
Update file not found | The GX device could not find the firmware update file. |
| error_during_update | 998 |
Error during update | The firmware installation failed before it could complete. |
| error_during_check | 999 |
Error during check | The GX device could not complete the online firmware update check. |
| idle | 1000 |
Idle | No firmware check or installation is currently running. |
| checking | 1001 |
Checking | The GX device is checking online for an available firmware update. |
| downloading_and_installing | 1002 |
Downloading and installing | The GX device is downloading and installing the firmware update. |
| rebooting | 1003 |
Rebooting | The GX device is rebooting to complete the firmware update. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| fuel | 0 |
Fuel | The tank is configured for this fluid type: Fuel. |
| fresh_water | 1 |
Fresh water | The tank is configured for this fluid type: Fresh water. |
| waste_water | 2 |
Waste water | The tank is configured for this fluid type: Waste water. |
| live_well | 3 |
Live well | The tank is configured for this fluid type: Live well. |
| oil | 4 |
Oil | The tank is configured for this fluid type: Oil. |
| black_water | 5 |
Black water (sewage) | The tank is configured for this fluid type: Black water (sewage). |
| gasoline | 6 |
Gasoline | The tank is configured for this fluid type: Gasoline. |
| diesel | 7 |
Diesel | The tank is configured for this fluid type: Diesel. |
| lpg | 8 |
Liquid petroleum gas (LPG) | The tank is configured for this fluid type: Liquid petroleum gas (LPG). |
| lng | 9 |
Liquid natural gas (LNG) | The tank is configured for this fluid type: Liquid natural gas (LNG). |
| hydraulic_oil | 10 |
Hydraulic oil | The tank is configured for this fluid type: Hydraulic oil. |
| raw_water | 11 |
Raw water | The tank is configured for this fluid type: Raw water. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| stopped | 0 |
Stopped | The generator is stopped because no start condition is active. |
| manual | 1 |
Manual | The generator is running because it was started manually. |
| test_run | 2 |
Test run | The generator is running for a scheduled or manually requested test run. |
| lost_comms | 3 |
Lost comms | The generator is running because communication with its controller was lost. |
| soc | 4 |
SoC | The generator is running because this start condition is active: SoC. |
| ac_load | 5 |
AC load | The generator is running because this start condition is active: AC load. |
| battery_current | 6 |
Battery current | The generator is running because this start condition is active: Battery current. |
| battery_volts | 7 |
Battery volts | The generator is running because this start condition is active: Battery volts. |
| inv_temp | 8 |
Inverter temperature | The generator is running because this start condition is active: Inverter temperature. |
| inv_overload | 9 |
Inverter overload | The generator is running because this start condition is active: Inverter overload. |
| stop_on_ac1 | 10 |
Stop on AC1 | The generator is stopping because AC input 1 became available. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | The option is disabled. |
| on | 1 |
On | The option is enabled. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| on | 0 |
On | The option is enabled. |
| off | 1 |
Off | The option is disabled. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| charger_only | 1 |
Charger only | The inverter/charger may charge batteries but will not invert DC power to AC. |
| inverter_only | 2 |
Inverter only | The inverter/charger may supply AC from the battery but will not charge from AC input. |
| on | 3 |
On | Charging, inversion, and AC passthrough are enabled as conditions require. |
| off | 4 |
Off | The inverter/charger is disabled. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | The solar charger is not performing maximum power point tracking. |
| voltage_current_limited | 1 |
Voltage/current limited | PV operation is limited by a voltage or current constraint. |
| mppt_active | 2 |
MPPT active | Maximum power point tracking is actively optimizing PV production. |
| not_available | 255 |
Not available | The device does not provide an MPPT operating mode. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| inverter | 2 |
Inverter | The Phoenix inverter continuously supplies AC power when sufficient DC power is available. |
| off | 4 |
Off | The Phoenix inverter output is disabled. |
| eco | 5 |
Eco | The Phoenix inverter enters a low-power search mode when no significant AC load is detected. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| full_charge_active | 0 |
Full charge active | A one-time full battery charge is in progress before renewable-energy priority resumes. |
| renewable_priority | 1 |
Renewable priority | Charging prioritizes renewable energy and normally stops at float. |
| overridden | 2 |
Overridden by generator | Renewable-energy priority is unavailable because a generator or Quattro AC-in-1 overrides it. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| none | 0 |
- | No device-off reason is active. |
| no_input_power | 1 |
No/low input power | Solar charger operation is prevented for this reason: No/low input power. |
| switched_off_power_switch | 2 |
Switched off (power switch) | Solar charger operation is prevented for this reason: Switched off (power switch). |
| switched_off_device_mode_register | 4 |
Switched off (device mode register) | Solar charger operation is prevented for this reason: Switched off (device mode register). |
| remote_input | 8 |
Remote input | Solar charger operation is prevented for this reason: Remote input. |
| protective_action | 16 |
Protection active | Solar charger operation is prevented for this reason: Protection active. |
| need_token | 32 |
Need token for operation | Solar charger operation is prevented for this reason: Need token for operation. |
| signal_from_bms | 64 |
Signal from BMS | Solar charger operation is prevented for this reason: Signal from BMS. |
| engine_shutdown | 128 |
Engine shutdown on low input voltage | Solar charger operation is prevented for this reason: Engine shutdown on low input voltage. |
| analysing_input_voltage | 256 |
Analysing input voltage | Solar charger operation is prevented for this reason: Analysing input voltage. |
| low_temperature | 512 |
Low temperature | Solar charger operation is prevented for this reason: Low temperature. |
| no_panel_power | 1024 |
No/low panel power | Solar charger operation is prevented for this reason: No/low panel power. |
| no_battery_power | 2048 |
No/low battery power | Solar charger operation is prevented for this reason: No/low battery power. |
| active_alarm | 32768 |
Active alarm | Solar charger operation is prevented for this reason: Active alarm. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | The device is switched off. |
| low_power | 1 |
Low power | The device is operating in a reduced-power state. |
| fault | 2 |
Fault | The device has stopped because of a fault. |
| bulk | 3 |
Bulk | The charger is delivering maximum available current during bulk charging. |
| absorption | 4 |
Absorption | The charger is holding the absorption voltage while charge current tapers. |
| float | 5 |
Float | The charger is maintaining the battery at its float voltage. |
| storage | 6 |
Storage | The charger is maintaining the lower long-term storage voltage. |
| equalize | 7 |
Equalize | The charger is performing a controlled equalization charge. |
| passthrough | 8 |
Passthrough | AC input is being passed through to the AC output. |
| inverting | 9 |
Inverting | The inverter is supplying AC power from the battery. |
| power_assist | 10 |
Power Assist | The inverter is supplementing the AC input with battery power. |
| power_supply | 11 |
Power supply | The charger is operating as a regulated DC power supply. |
| sustain | 244 |
Sustain | Battery discharge is restricted while the system sustains a safe battery voltage. |
| starting_up | 245 |
Starting up | The device is completing its startup sequence. |
| repeated_absorption | 246 |
Repeated absorption | The charger is performing a scheduled repeated absorption cycle. |
| auto_equalize | 247 |
Auto equalize / recondition | The charger is performing an automatic equalization or reconditioning cycle. |
| battery_safe | 248 |
Battery Safe | Charge current is limited to prevent excessive battery voltage rise. |
| external_control | 252 |
External control | An external controller determines the device operating state. |
| discharging | 256 |
Discharging | The battery is supplying power to the system. |
| sustain_alt | 257 |
Sustain alt | ESS sustain is active because battery voltage reached the dynamic cutoff. |
| recharging | 258 |
Recharging | The system is recharging after state of charge fell below its threshold. |
| scheduled_recharging | 259 |
Scheduled recharging | The system is charging during an active scheduled-charge window. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| momentary | 0 |
Momentary | The switchable output uses this control interface: Momentary. |
| toggle | 1 |
Toggle | The switchable output uses this control interface: Toggle. |
| dimmable | 2 |
Dimmable | The switchable output uses this control interface: Dimmable. |
| temperature_setpoint | 3 |
Temperature setpoint | The switchable output uses this control interface: Temperature setpoint. |
| stepped_switch | 4 |
Stepped switch | The switchable output uses this control interface: Stepped switch. |
| slave_mode | 5 |
Slave mode | The switchable output uses this control interface: Slave mode. |
| dropdown | 6 |
Dropdown | The switchable output uses this control interface: Dropdown. |
| basic_slider | 7 |
Basic slider | The switchable output uses this control interface: Basic slider. |
| numeric_input | 8 |
Numeric input | The switchable output uses this control interface: Numeric input. |
| three_state_switch | 9 |
Three-state switch | The switchable output uses this control interface: Three-state switch. |
| bilge_pump_control | 10 |
Bilge pump control | The switchable output uses this control interface: Bilge pump control. |
| rgb_color_wheel | 11 |
RGB color wheel | The switchable output uses this control interface: RGB color wheel. |
| cct_color_wheel | 12 |
CCT color wheel | The switchable output uses this control interface: CCT color wheel. |
| rgbw_color_wheel | 13 |
RGBW color wheel | The switchable output uses this control interface: RGBW color wheel. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| ok | 0 |
Ok | The temperature sensor reports this status: Ok. |
| disconnected | 1 |
Disconnected | The temperature sensor reports this status: Disconnected. |
| short_circuited | 2 |
Short circuited | The temperature sensor reports this status: Short circuited. |
| reverse_polarity | 3 |
Reverse polarity | The temperature sensor reports this status: Reverse polarity. |
| unknown | 4 |
Unknown | The temperature sensor reports this status: Unknown. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| battery | 0 |
Battery | The temperature sensor is configured for this measurement type: Battery. |
| fridge | 1 |
Fridge | The temperature sensor is configured for this measurement type: Fridge. |
| generic | 2 |
Generic | The temperature sensor is configured for this measurement type: Generic. |
| room | 3 |
Room | The temperature sensor is configured for this measurement type: Room. |
| outdoor | 4 |
Outdoor | The temperature sensor is configured for this measurement type: Outdoor. |
| water_heater | 5 |
Water heater | The temperature sensor is configured for this measurement type: Water heater. |
| freezer | 6 |
Freezer | The temperature sensor is configured for this measurement type: Freezer. |
| ID | Value | Display Name | Description |
|---|
| ID | Value | Display Name | Description |
|---|---|---|---|
| bluesolar_mppt_75_15 | 41026 |
BlueSolar MPPT 75/15 | Identifies the BlueSolar MPPT 75/15 model from its published Victron product ID. |
| bluesolar_mppt_100_15 | 41027 |
BlueSolar MPPT 100/15 | Identifies the BlueSolar MPPT 100/15 model from its published Victron product ID. |
| bluesolar_mppt_100_30 | 41028 |
BlueSolar MPPT 100/30 | Identifies the BlueSolar MPPT 100/30 model from its published Victron product ID. |
| bluesolar_mppt_100_50 | 41029 |
BlueSolar MPPT 100/50 | Identifies the BlueSolar MPPT 100/50 model from its published Victron product ID. |
| bluesolar_mppt_150_70 | 41034 |
BlueSolar MPPT 150/70 | Identifies the BlueSolar MPPT 150/70 model from its published Victron product ID. |
| bluesolar_mppt_75_10 | 41036 |
BlueSolar MPPT 75/10 | Identifies the BlueSolar MPPT 75/10 model from its published Victron product ID. |
| bluesolar_mppt_150_45 | 41037 |
BlueSolar MPPT 150/45 | Identifies the BlueSolar MPPT 150/45 model from its published Victron product ID. |
| bluesolar_mppt_150_45_rev2 | 41071 |
BlueSolar MPPT 150/45 rev2 | Identifies the BlueSolar MPPT 150/45 rev2 model from its published Victron product ID. |
| bluesolar_mppt_150_45_rev3 | 41074 |
BlueSolar MPPT 150/45 rev3 | Identifies the BlueSolar MPPT 150/45 rev3 model from its published Victron product ID. |
| bluesolar_mppt_150_60 | 41038 |
BlueSolar MPPT 150/60 | Identifies the BlueSolar MPPT 150/60 model from its published Victron product ID. |
| bluesolar_mppt_150_85 | 41039 |
BlueSolar MPPT 150/85 | Identifies the BlueSolar MPPT 150/85 model from its published Victron product ID. |
| smartsolar_mppt_250_100 | 41040 |
SmartSolar MPPT 250/100 | Identifies the SmartSolar MPPT 250/100 model from its published Victron product ID. |
| smartsolar_mppt_150_100 | 41041 |
SmartSolar MPPT 150/100 | Identifies the SmartSolar MPPT 150/100 model from its published Victron product ID. |
| smartsolar_mppt_150_85 | 41042 |
SmartSolar MPPT 150/85 | Identifies the SmartSolar MPPT 150/85 model from its published Victron product ID. |
| smartsolar_mppt_75_15 | 41043 |
SmartSolar MPPT 75/15 | Identifies the SmartSolar MPPT 75/15 model from its published Victron product ID. |
| smartsolar_mppt_75_10 | 41044 |
SmartSolar MPPT 75/10 | Identifies the SmartSolar MPPT 75/10 model from its published Victron product ID. |
| smartsolar_mppt_100_15 | 41045 |
SmartSolar MPPT 100/15 | Identifies the SmartSolar MPPT 100/15 model from its published Victron product ID. |
| smartsolar_mppt_100_30 | 41046 |
SmartSolar MPPT 100/30 | Identifies the SmartSolar MPPT 100/30 model from its published Victron product ID. |
| smartsolar_mppt_100_50 | 41047 |
SmartSolar MPPT 100/50 | Identifies the SmartSolar MPPT 100/50 model from its published Victron product ID. |
| smartsolar_mppt_150_35 | 41048 |
SmartSolar MPPT 150/35 | Identifies the SmartSolar MPPT 150/35 model from its published Victron product ID. |
| smartsolar_mppt_150_100_rev2 | 41049 |
SmartSolar MPPT 150/100 rev2 | Identifies the SmartSolar MPPT 150/100 rev2 model from its published Victron product ID. |
| smartsolar_mppt_150_85_rev2 | 41050 |
SmartSolar MPPT 150/85 rev2 | Identifies the SmartSolar MPPT 150/85 rev2 model from its published Victron product ID. |
| smartsolar_mppt_250_70 | 41051 |
SmartSolar MPPT 250/70 | Identifies the SmartSolar MPPT 250/70 model from its published Victron product ID. |
| smartsolar_mppt_250_85 | 41052 |
SmartSolar MPPT 250/85 | Identifies the SmartSolar MPPT 250/85 model from its published Victron product ID. |
| smartsolar_mppt_250_60 | 41053 |
SmartSolar MPPT 250/60 | Identifies the SmartSolar MPPT 250/60 model from its published Victron product ID. |
| smartsolar_mppt_250_60_rev2 | 41064 |
SmartSolar MPPT 250/60 rev2 | Identifies the SmartSolar MPPT 250/60 rev2 model from its published Victron product ID. |
| smartsolar_mppt_250_45 | 41054 |
SmartSolar MPPT 250/45 | Identifies the SmartSolar MPPT 250/45 model from its published Victron product ID. |
| smartsolar_mppt_100_20 | 41055 |
SmartSolar MPPT 100/20 | Identifies the SmartSolar MPPT 100/20 model from its published Victron product ID. |
| smartsolar_mppt_100_20_48v | 41056 |
SmartSolar MPPT 100/20 48V | Identifies the SmartSolar MPPT 100/20 48V model from its published Victron product ID. |
| bluesolar_mppt_100_20_48v | 41063 |
BlueSolar MPPT 100/20 48V | Identifies the BlueSolar MPPT 100/20 48V model from its published Victron product ID. |
| smartsolar_mppt_150_45 | 41057 |
SmartSolar MPPT 150/45 | Identifies the SmartSolar MPPT 150/45 model from its published Victron product ID. |
| smartsolar_mppt_150_45_rev2 | 41066 |
SmartSolar MPPT 150/45 rev2 | Identifies the SmartSolar MPPT 150/45 rev2 model from its published Victron product ID. |
| smartsolar_mppt_150_45_rev3 | 41075 |
SmartSolar MPPT 150/45 rev3 | Identifies the SmartSolar MPPT 150/45 rev3 model from its published Victron product ID. |
| smartsolar_mppt_150_60 | 41058 |
SmartSolar MPPT 150/60 | Identifies the SmartSolar MPPT 150/60 model from its published Victron product ID. |
| smartsolar_mppt_150_70 | 41059 |
SmartSolar MPPT 150/70 | Identifies the SmartSolar MPPT 150/70 model from its published Victron product ID. |
| smartsolar_mppt_vecan_150_85_rev2 | 41229 |
SmartSolar MPPT VE.Can 150/85 rev2 | Identifies the SmartSolar MPPT VE.Can 150/85 rev2 model from its published Victron product ID. |
| smartsolar_mppt_rs_450_100 | 41232 |
SmartSolar MPPT RS 450/100 | Identifies the SmartSolar MPPT RS 450/100 model from its published Victron product ID. |
| orion_xs_12v_12v_50a | 41968 |
Orion XS 12V/12V-50A | Identifies the Orion XS 12V/12V-50A model from its published Victron product ID. |
| orion_xs_12v_12v_70a | 41970 |
Orion XS 12V/12V-70A | Identifies the Orion XS 12V/12V-70A model from its published Victron product ID. |
| orion_xs_12v_24v_50a | 41969 |
Orion XS 12V/24V-50A | Identifies the Orion XS 12V/24V-50A model from its published Victron product ID. |
| ID | Value | Display Name | Description |
|---|---|---|---|
| off | 0 |
Off | VRM Portal connectivity is disabled. |
| read_only | 1 |
Read-only | VRM Portal may read system data but cannot issue remote commands. |
| full | 2 |
Full | VRM Portal has full read and remote-control access. |
5 possible values for ACActiveInputSource.
5 possible values for ACSystemMode.
4 possible values for AcInputTypeEnum.
3 possible values for ActiveInputEnum.
3 possible values for BMSMode.
3 possible values for BatteryState.
20 possible values for ChargeSchedule.
2 possible values for ChargerMode.
6 possible values for DESSErrorCode.
5 possible values for DESSMode.
27 possible values for DESSReactiveStrategy.
4 possible values for DESSRestrictions.
4 possible values for DESSStrategy.
4 possible values for DVCCMode.
37 possible values for DeviceType.
2 possible values for DigitalInputInputState.
12 possible values for DigitalInputState.
11 possible values for DigitalInputType.
4 possible values for ESSMode.
3 possible values for ESSModeHub4.
12 possible values for ESSState.
4 possible values for ESSUserMode.
20 possible values for ErrorCode.
3 possible values for EvChargerMode.
2 possible values for EvChargerPosition.
24 possible values for EvChargerStatus.
9 possible values for EvChargingState.
7 possible values for FirmwareUpdateState.
12 possible values for FluidType.
11 possible values for GeneratorRunningByConditionCode.
3 possible values for GenericAlarmEnum.
2 possible values for GenericOnOff.
2 possible values for GenericOnOffInverted.
4 possible values for InverterMode.
4 possible values for MppOperationMode.
3 possible values for PhoenixInverterMode.
3 possible values for PreferRenewableEnergyEnum.
14 possible values for SolarChargerDeviceOffReason.
22 possible values for State.
14 possible values for SwitchableOutputType.
5 possible values for TemperatureStatus.
7 possible values for TemperatureType.
0 possible values for VictronDeviceEnum.
40 possible values for VictronProductId.
3 possible values for VrmPortalMode.