Controlling the charger

Available commands and responses

Commands

The commands below are available for you to issue commands to a charger.

Device Management

IdNameDescriptionArgumentsAPI Endpoint
1RebootReboot charger-POST api/chargers/{chargerId}/commands/reboot
4UpgradeFirmwareUpgrade firmware to the latest version using delta OTA-POST api/chargers/{chargerId}/commands/update_firmware
29SetEnabledSet true to enable chargerIsEnabled (bool)POST api/chargers/{chargerId}/settings (field: Enabled)

Dynamic Current Control (Volatile)

IdNameDescriptionArgumentsAPI Endpoint
21SetDynamicCurrentOfflineFallbackSets the maximum circuit current to be used by the load balancer in case the charger goes offline [Amperes]MaxDynamicCurrentP1 (int), MaxDynamicCurrentP2 (int), MaxDynamicCurrentP3 (int)POST api/sites/{siteId}/circuits/{circuitId}/settings (fields: OfflineMaxCircuitCurrentP1/P2/P3)
22SetDynamicCircuitCurrentSet charge current for each phase [Amperes], use 0 for all phases to pause charging (for smart charging / volatile setting)CurrentP1 (double), CurrentP2 (double), CurrentP3 (double), TTL_Minutes (int)POST api/sites/{siteId}/circuits/{circuitId}/dynamicCurrent
POST api/sites/{siteId}/circuits/{circuitId}/settings (fields: DynamicCircuitCurrentP1/P2/P3)
48SetDynamicChargerCurrentSet max charge current for this charger [Amperes], use 0 to pause charging (for smart charging / volatile setting)Current_Amp (int), TTL_Minutes (int)POST api/chargers/{chargerId}/commands/set_dynamic_charger_current
POST api/chargers/{chargerId}/settings (field: DynamicChargerCurrent)

Static Current Control (Non-volatile)

IdNameDescriptionArgumentsAPI Endpoint
24SetMaxCircuitCurrentNon-volatile max current for circuit [Amperes]CurrentP1 (int), CurrentP2 (int), CurrentP3 (int)POST api/sites/{siteId}/circuits/{circuitId}/settings (fields: MaxCircuitCurrentP1/P2/P3)
47SetMaxChargerCurrentSet max charge current for this charger [Amperes]. Non-volatile setting, stored in flash. Should only be used for permanent change to currentCurrent_Amp (int)POST api/chargers/{chargerId}/settings (field: MaxChargerCurrent)

Authorization

IdNameDescriptionArgumentsAPI Endpoint
25AuthorizeChargingProvide authorization resultIDToken (string), Status (int), ExpirationDate (string)POST api/chargers/{chargerId}/commands/toggle_charging (indirect, when auth required)
26DeauthorizeChargingDeauthorizes chargingIDToken (string), Status (int)POST api/chargers/{chargerId}/commands/stop_charging

Smart Charging & Scheduling

IdNameDescriptionArgumentsAPI Endpoint
11SetSmartChargingSet smart charging modeSmartCharging (bool)POST api/chargers/{chargerId}/commands/smart_charging
POST api/chargers/{chargerId}/settings (field: SmartCharging)
63OverrideScheduleOverrides the schedule for the current session. Output current will not be limited by the schedule. Schedule is automatically resumed when EV disconnects.-POST api/chargers/{chargerId}/commands/override_schedule

Phase & Grid Configuration

IdNameDescriptionArgumentsAPI Endpoint
38SetPhaseModeSet Phase mode on this charger. 1-Locked to 1-Phase, 2-Auto, 3-Locked to 3-phasePhaseMode (int)POST api/chargers/{chargerId}/commands/set_phase_mode
POST api/chargers/{chargerId}/settings (field: PhaseMode)

Cable & Relay

IdNameDescriptionArgumentsAPI Endpoint
30SetLockCablePermanentlySet cable lock stateLocked (bool)POST api/chargers/{chargerId}/commands/lock_state
POST api/chargers/{chargerId}/settings (field: LockCablePermanently)

Command Response Format

Response sent by the device for every command, regardless of command type.

FieldTypeRequiredDescription
IdintYesCommand id
TimestampdatetimeYesTimestamp from the original command
WasAcceptedboolYesWhether the command was accepted
DeliveredAtdatetimeNoCurrent datetime. Only present when WasAccepted=true
SerialNumberstringYesDevice serial number
ResultCodeintNoResult code from the device
CommentstringNoHuman-readable comment from the device

What’s Next

Next, you should be ready to go live

Did this page help you?