Zum Hauptinhalt springen
Internal notes
TitleModbus API reference
Statusdraft ✏
Sources
Preview Link... s-api-reference-complete
Version: 5.32

Modbus API reference

info

All data is transferred in network byte order/big endian.

Device/ProtocolReg. TypeAddressNameR/WNr. Regs.Description
PhoenixInput100EV StatusR1Returns the Control Pilot state
PhoenixInput101Proximity CurrentR1Returns signaled current in Amps
PhoenixInput102Charging Time (seconds)R2Duration since beginning of charge
PhoenixInput104LegacyR1Do not use.
PhoenixInput105Firmware VersionR2Returns the Ebee Application version number (example: 0.91 = {0x30, 0x2E, 0x39, 0x31) 4.40 = {0x34, 0x2E, 0x34, 0x34}).
PhoenixInput107LegacyR1Do not use.
PhoenixInput108Voltage L1R2Returns the voltage of phase 1 of the ocpp meter in V.
PhoenixInput110Voltage L2R2Returns the voltage of phase 2 of the ocpp meter in V.
PhoenixInput112Voltage L3R2Returns the voltage of phase 3 of the ocpp meter in V.
PhoenixInput114Current L1R2Returns the current of phase 1 of the ocpp meter in mA.
PhoenixInput116Current L2R2Returns the current of phase 2 of the ocpp meter in mA.
PhoenixInput118Current L3R2Returns the current of phase 3 of the ocpp meter in mA.
PhoenixInput120Total Power (OCPP Meter Power)R2Returns the power read from the ocpp meter in W.
PhoenixInput122Reactive PowerR2
PhoenixInput124Real PowerR2
PhoenixInput126Power FactorR2
PhoenixInput128EnergyR2Energy read from meter in Wh
PhoenixInput130Max. power ever seen from OCPP MeterR2Max. power value ever seen since boot
PhoenixInput132Charged Energy (Wh)R2Sum of charged energy for the current session
PhoenixInput134Grid FrequencyR2Returns the frequency read from the ocpp meter in Hz.
PhoenixInput136Assumed Maximum Charging Current L1R2
PhoenixInput138Assumed Maximum Charging Current L2R2
PhoenixInput140Assumed Maximum Charging Current L3R2
PhoenixInput200Input valuesR1
PhoenixInput201-R1-
PhoenixInput202Plug lock detectR1Status of plug lock detection
PhoenixInput203-R1-
PhoenixInput204-R1-
PhoenixInput205-R1-
PhoenixInput206-R1-
PhoenixInput207-R1-
PhoenixInput208-R1-
PhoenixHolding310IP Address - 1st OctetR1Get the IP address of the active interface connected to the backend.
PhoenixHolding311IP Address - 2nd OctetR1Get the IP address of the active interface connected to the backend.
PhoenixHolding312IP Address - 3rd OctetR1Get the IP address of the active interface connected to the backend.
PhoenixHolding313IP Address - 4th OctetR1Get the IP address of the active interface connected to the backend.
TQ-DM100Holding1000Charge Point StateR1
TQ-DM100Holding1001Charge StateR1
TQ-DM100Holding1002EVSE StateR1
TQ-DM100Holding1004Cable StateR1
TQ-DM100Holding1006EVSE Error CodeR1
TQ-DM100Holding1008Current L1R1Returns the current of phase 1 of the ocpp meter in mA.
TQ-DM100Holding1010Current L2R1Returns the current of phase 2 of the ocpp meter in mA.
TQ-DM100Holding1012Current L3R1Returns the current of phase 3 of the ocpp meter in mA.
TQ-DM100Holding1020Active PowerR2
TQ-DM100Holding1024Active Power L1R2
TQ-DM100Holding1028Active Power L2R2
TQ-DM100Holding1032Active Power L3R2
TQ-DM100Holding1036EnergyR2
TQ-DM100Holding1100Hardware current limitR1
TQ-DM100Holding1102Minimum current limitR1
TQ-DM100Holding1104Max. Current from EVSER1
TQ-DM100Holding1106Max. Current from CableR1
TQ-DM100Holding1108Max. Current from EVR1
TQ-DM100Holding1200User priorityR1
TQ-DM100Holding1300EV Battery State (% 0-100)R1Returns an estimate of the SoC
TQ-DM100Holding1302EV Battery Capacity (Wh)R2Returns an estimate of the EV Battery Capacity
TQ-DM100Holding1400Schedule TypeR1
TQ-DM100Holding1402Required Energy (Wh)R2
TQ-DM100Holding1406Required Battery State (% 0-100)R1
TQ-DM100Holding1408Scheduled Time (hhmmss)R2
TQ-DM100Holding1412Scheduled Date (yymmdd)R2
TQ-DM100Holding1502Charged Energy (Wh)R1Sum of charged energy for the current session
TQ-DM100Holding1504Start Time (hhmmss)R2Start time of charging process
TQ-DM100Holding1508Charging Time (seconds)R2Duration since beginning of charge
TQ-DM100Holding1512End Time (hhmmss)R2End time of charging process
TQ-DM100Holding1600User IDR2User ID (OCPP IdTag) from the current session. Bytes 0 to 3.
TQ-DM100Holding1602User IDR2User ID (OCPP IdTag) from the current session. Bytes 4 to 7.
TQ-DM100Holding1604User IDR2User ID (OCPP IdTag) from the current session. Bytes 8 to 11.
TQ-DM100Holding1606User IDR2User ID (OCPP IdTag) from the current session. Bytes 12 to 15.
TQ-DM100Holding1608User IDR2User ID (OCPP IdTag) from the current session. Bytes 16 to 19.
TQ-DM100Holding162015118 Smart vehicle detectedR1Returns 1 if an EV currently connected is a smart vehicle, or 0 if no EV connected or it is not a smart vehicle
TQ-DM100Holding2000Safe Current (Amps.)R/W1Max. charge current under communication failure
TQ-DM100Holding2002Comm. Timeout (seconds)R/W1Communication timeout
TQ-DM100Holding5000Charge Power (W)W2
TQ-DM100Holding5004Charge Current (A)W1
TQ-DM100Holding5006Charge Control1Unimplemented
TQ-DM100Holding5008Charge Release1Unimplemented
TQ-DM100Holding5900Free ChargingR/W1Unimplemented
TQ-DM100Holding5902Free Charging ModeR/W1Unimplemented
TQ-DM100Holding6000Life BitR/W10/1 Toggle-Bit
Open Modbus Charge Control Interface (OMCCI)Holding100Firmware VersionR2Returns the Ebee Application version number (example: 0.91 = {0x30, 0x2E, 0x39, 0x31) 4.40 = {0x34, 0x2E, 0x34, 0x34}).
Open Modbus Charge Control Interface (OMCCI)Holding104OCPP CP StatusR1Charge Point status according to the OCPP spec. enumeration
Open Modbus Charge Control Interface (OMCCI)Holding105Error Codes 1R2Aggregated error states (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding107Error Codes 2R2Aggregated error states (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding109Error Codes 3R2Aggregated error states (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding111Error Codes 4R2Aggregated error states (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding120Protocol VersionR2Ebee Modbus TCP Server Protocol Version number (example: 0.6 = {0x30, 0x2E, 0x36}).
Open Modbus Charge Control Interface (OMCCI)Holding122Vehicle (Control Pilot) stateR1A=1, B=2, C=3, D=4, E=5
Open Modbus Charge Control Interface (OMCCI)Holding123Vehicle (Control Pilot) state in Hex. formatR1A = 0x0A, B = 0x0B, etc.
Open Modbus Charge Control Interface (OMCCI)Holding124Charge Point availabilityR/W1Get/Set available/unavailable
Open Modbus Charge Control Interface (OMCCI)Holding131Safe Current (Amps.)R/W1Max. charge current under communication failure
Open Modbus Charge Control Interface (OMCCI)Holding132Comm. Timeout (seconds)R/W1Communication timeout
Open Modbus Charge Control Interface (OMCCI)Holding133Hardware current limitR1
Open Modbus Charge Control Interface (OMCCI)Holding134Operator current limitR1
Open Modbus Charge Control Interface (OMCCI)Holding135RCMB ModeR1
Open Modbus Charge Control Interface (OMCCI)Holding136RCMB Last RMS value (integral part)R1
Open Modbus Charge Control Interface (OMCCI)Holding137RCMB Last RMS value (fractional part)R1
Open Modbus Charge Control Interface (OMCCI)Holding138RCMB Last DC value (integral part)R1
Open Modbus Charge Control Interface (OMCCI)Holding139RCMB Last DC value (fractional part)R1
Open Modbus Charge Control Interface (OMCCI)Holding140Relays StateR1
Open Modbus Charge Control Interface (OMCCI)Holding141Device IDR1This register is a device identifier and always returns the value 0xEBEE (decimal 60398)
Open Modbus Charge Control Interface (OMCCI)Holding142ChargePoint ModelR2ChargePoint Model. Bytes 0 to 3.
Open Modbus Charge Control Interface (OMCCI)Holding144ChargePoint ModelR2ChargePoint Model. Bytes 4 to 7.
Open Modbus Charge Control Interface (OMCCI)Holding146ChargePoint ModelR2ChargePoint Model. Bytes 8 to 11.
Open Modbus Charge Control Interface (OMCCI)Holding148ChargePoint ModelR2ChargePoint Model. Bytes 12 to 15.
Open Modbus Charge Control Interface (OMCCI)Holding150ChargePoint ModelR2ChargePoint Model. Bytes 16 to 19.
Open Modbus Charge Control Interface (OMCCI)Holding152Plug lock detectR1Status of plug lock detection
Open Modbus Charge Control Interface (OMCCI)Holding153Firmware VersionR1Returns the Ebee Application major version number
Open Modbus Charge Control Interface (OMCCI)Holding154Firmware VersionR1Returns the Ebee Application minor version number
Open Modbus Charge Control Interface (OMCCI)Holding155Firmware VersionR1Returns the Ebee Application patch version number
Open Modbus Charge Control Interface (OMCCI)Holding156Build NumberR2Returns the Ebee Application build number
Open Modbus Charge Control Interface (OMCCI)Holding158Error Events 1R2Aggregated error events (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding160Error Events 2R2Aggregated error events (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding162Error Events 3R2Aggregated error events (see Spec. sheet for mask mappings)
Open Modbus Charge Control Interface (OMCCI)Holding164Error Events 4R2Aggregated error events (see Spec. sheet for mask mappings) no error code --- 0x1 no error code --- 0x2 no error code --- 0x4 no error code --- 0x8 no error code --- 0x10 01-02-017 --- 0x20 01-02-018 --- 0x40 no error code --- 0x80 01-03-005 --- 0x100 01-04-001 --- 0x200 01-04-010 --- 0x400 01-04-009 --- 0x800 01-04-006 --- 0x1000 01-04-008 --- 0x2000 01-04-011 --- 0x4000 01-04-012 --- 0x8000 01-04-013 --- 0x10000 01-04-002 --- 0x20000 01-04-003 --- 0x40000 01-06-002 --- 0x80000 01-03-007 --- 0x100000
Open Modbus Charge Control Interface (OMCCI)Holding166Free ChargingR/W10 = Free charging disabled, 1 = Free charging enabled
Open Modbus Charge Control Interface (OMCCI)Holding167Free Charging ModeR/W1Modes 0 to 5 (see Spec. sheet for details)
Open Modbus Charge Control Interface (OMCCI)Holding168Manufacturer serial numberR2Manufacturer serial number. Bytes 0 to 3.
Open Modbus Charge Control Interface (OMCCI)Holding170Manufacturer serial numberR2Manufacturer serial number. Bytes 4 to 7.
Open Modbus Charge Control Interface (OMCCI)Holding172Manufacturer serial numberR2Manufacturer serial number. Bytes 8 to 11.
Open Modbus Charge Control Interface (OMCCI)Holding174Manufacturer serial numberR2Manufacturer serial number. Bytes 12 to 15.
Open Modbus Charge Control Interface (OMCCI)Holding176Manufacturer serial numberR2Manufacturer serial number. Bytes 16 to 19.
Open Modbus Charge Control Interface (OMCCI)Holding178Manufacturer serial numberR2Manufacturer serial number. Bytes 20 to 23.
Open Modbus Charge Control Interface (OMCCI)Holding180Manufacturer serial numberR1Manufacturer serial number. Byte 24 and '
Open Modbus Charge Control Interface (OMCCI)Holding182Phytec-Board temperatureR/W2Phytec-Board temperature from comtraxx system
Open Modbus Charge Control Interface (OMCCI)Holding184Reservation expiry timeR2Reservation expiry time
Open Modbus Charge Control Interface (OMCCI)Holding200Energy L1R2Energy in Wh. (phase 1) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding202Energy L2R2Energy in Wh. (phase 2) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding204Energy L3R2Energy in Wh. (phase 3) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding206Power L1R2Power in W (phase 1) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding208Power L2R2Power in W (phase 2) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding210Power L3R2Power in W (phase 3) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding212Current L1R2Current in mA (phase 1) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding214Current L2R2Current in mA (phase 2) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding216Current L3R2Current in mA (phase 3) from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding218Total EnergyR2Total Energy in Wh. from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding220Total PowerR2Total Power in Wh. from primary meter
Open Modbus Charge Control Interface (OMCCI)Holding222Voltage L1R2Returns the voltage of phase 1 of the ocpp meter in V.
Open Modbus Charge Control Interface (OMCCI)Holding224Voltage L2R2Returns the voltage of phase 2 of the ocpp meter in V.
Open Modbus Charge Control Interface (OMCCI)Holding226Voltage L3R2Returns the voltage of phase 3 of the ocpp meter in V.
Open Modbus Charge Control Interface (OMCCI)Holding500(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding501(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding502(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding503(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding504(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding505(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding506(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding507(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding508(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding509(Reserved)R1
Open Modbus Charge Control Interface (OMCCI)Holding600DLM ModeR1Indicates the DLM mode configured for this device.
Open Modbus Charge Control Interface (OMCCI)Holding610DLM EVSE Sub-distribution Limit L1R1Overall current limit for DLM available for EVs
Open Modbus Charge Control Interface (OMCCI)Holding611DLM EVSE Sub-distribution Limit L2R1Overall current limit for DLM available for EVs
Open Modbus Charge Control Interface (OMCCI)Holding612DLM EVSE Sub-distribution Limit L3R1Overall current limit for DLM available for EVs
Open Modbus Charge Control Interface (OMCCI)Holding613DLM Operator EVSE Sub-distribution Limit L1R/W1Operator current limit for DLM available for distribution to EVs
Open Modbus Charge Control Interface (OMCCI)Holding614DLM Operator EVSE Sub-distribution Limit L2R/W1Operator current limit for DLM available for distribution to EVs
Open Modbus Charge Control Interface (OMCCI)Holding615DLM Operator EVSE Sub-distribution Limit L3R/W1Operator current limit for DLM available for distribution to EVs
Open Modbus Charge Control Interface (OMCCI)Holding620DLM External Meter supportR1Value of this register is 1 when External Meter is enabled, 0 when disabled
Open Modbus Charge Control Interface (OMCCI)Holding621DLM Number of Slaves connectedR1The number of DLM Slaves connected to this Master device
Open Modbus Charge Control Interface (OMCCI)Holding630DLM Overall Current applied L1R1Overall Current (A) the DLM Master is currently applying (sum of current distributed among the slaves)
Open Modbus Charge Control Interface (OMCCI)Holding631DLM Overall Current applied L2R1Overall Current (A) the DLM Master is currently applying (sum of current distributed among the slaves)
Open Modbus Charge Control Interface (OMCCI)Holding632DLM Overall Current applied L3R1Overall Current (A) the DLM Master is currently applying (sum of current distributed among the slaves)
Open Modbus Charge Control Interface (OMCCI)Holding633DLM Overall Current available L1R1Overall Current (A) the DLM Master has available to distribute among the slaves
Open Modbus Charge Control Interface (OMCCI)Holding634DLM Overall Current available L2R1Overall Current (A) the DLM Master has available to distribute among the slaves
Open Modbus Charge Control Interface (OMCCI)Holding635DLM Overall Current available L3R1Overall Current (A) the DLM Master has available to distribute among the slaves
Open Modbus Charge Control Interface (OMCCI)Holding701Scheduled Time (hhmmss)R2Scheduled departure time (format is `hhmmss` in big-endian packed BCD with left zero padding) – 15118 only
Open Modbus Charge Control Interface (OMCCI)Holding703Scheduled Date (yymmdd)R2Scheduled departure time (format is `ddmmyy` in big-endian packed BCD with left zero padding) – 15118 only
Open Modbus Charge Control Interface (OMCCI)Holding705(deprecated) Charged EnergyR1Sum of charged energy for the current session (Wh)
Open Modbus Charge Control Interface (OMCCI)Holding706Signaled CurrentR1The maximum current that's being signaled to the EV for charging
Open Modbus Charge Control Interface (OMCCI)Holding707Start Time (hhmmss)R2Start time of charging process
Open Modbus Charge Control Interface (OMCCI)Holding709(deprecated) Charging Duration (seconds)R1Duration since beginning of charge
Open Modbus Charge Control Interface (OMCCI)Holding710End Time (hhmmss)R2End time of charging process
Open Modbus Charge Control Interface (OMCCI)Holding712Minimum current limitR1Minimum current limit for charging
Open Modbus Charge Control Interface (OMCCI)Holding713EV Required Energy (Wh)R2Returns the amount of energy in Wh required by the EV
Open Modbus Charge Control Interface (OMCCI)Holding715Max. Current EVR1This is the maximum current with which the EV can charge
Open Modbus Charge Control Interface (OMCCI)Holding716Charged EnergyR2Sum of charged energy for the current session (Wh)
Open Modbus Charge Control Interface (OMCCI)Holding718Charging Duration (seconds)R2Duration since beginning of charge
Open Modbus Charge Control Interface (OMCCI)Holding720User IDR2User ID (OCPP IdTag) from the current session. Bytes 0 to 3.
Open Modbus Charge Control Interface (OMCCI)Holding722User IDR2User ID (OCPP IdTag) from the current session. Bytes 4 to 7.
Open Modbus Charge Control Interface (OMCCI)Holding724User IDR2User ID (OCPP IdTag) from the current session. Bytes 8 to 11.
Open Modbus Charge Control Interface (OMCCI)Holding726User IDR2User ID (OCPP IdTag) from the current session. Bytes 12 to 15.
Open Modbus Charge Control Interface (OMCCI)Holding728User IDR2User ID (OCPP IdTag) from the current session. Bytes 16 to 19.
Open Modbus Charge Control Interface (OMCCI)Holding730EV Battery State (% 0-100)R1Returns an estimate of the SoC
Open Modbus Charge Control Interface (OMCCI)Holding74015118 Smart vehicle detectedR1Returns 1 if an EV currently connected is a smart vehicle, or 0 if no EV connected or it is not a smart vehicle
Open Modbus Charge Control Interface (OMCCI)Holding741EVCCID - 15118 onlyR2ASCII representation of the Hex. Values corresponding to the EVCCID. Bytes 0 to 3.
Open Modbus Charge Control Interface (OMCCI)Holding743EVCCID - 15118 onlyR2ASCII representation of the Hex. Values corresponding to the EVCCID. Bytes 4 to 7.
Open Modbus Charge Control Interface (OMCCI)Holding745EVCCID - 15118 onlyR2ASCII representation of the Hex. Values corresponding to the EVCCID. Bytes 8 to 11.
Open Modbus Charge Control Interface (OMCCI)Holding747Remaining time to full SoC - 15118 onlyR2Returns the remaining time in seconds to full SoC
Open Modbus Charge Control Interface (OMCCI)Holding749Is in charging loop - 15118 onlyR1Returns 1 if the EV/EVSE are on a charging loop, 0 otherwise
Open Modbus Charge Control Interface (OMCCI)Holding752Auth. sourceR1Source of authorization (RFID, Input, Remote, 15118, Autocharge, Freecharge, Power Loss... )
Open Modbus Charge Control Interface (OMCCI)Holding1000Hems Current Limit (A)R/W1Current limit of the HEMS module in Amps
Open Modbus Charge Control Interface (OMCCI)Holding1110User IDW2Write user ID (OCPP IdTag) for the current session. Bytes 0 to 3.
Open Modbus Charge Control Interface (OMCCI)Holding1112User IDW2Write user ID (OCPP IdTag) for the current session. Bytes 4 to 7.
Open Modbus Charge Control Interface (OMCCI)Holding1114User IDW2Write user ID (OCPP IdTag) for the current session. Bytes 8 to 11.
Open Modbus Charge Control Interface (OMCCI)Holding1116User IDW2Write user ID (OCPP IdTag) for the current session. Bytes 12 to 15.
Open Modbus Charge Control Interface (OMCCI)Holding1118User IDW2Write user ID (OCPP IdTag) for the current session. Bytes 16 to 19.