Command model
A command is one remote operation against one target: you name the target and the operation, the chargecloud OS forwards the command to the controller and records the controller’s answer.1
Target
The device the command is for: a controller (the unit in the charging station that communicates with the chargecloud OS), a connector (one charging point, where a driver plugs in) or a running charging session.Identified by
target_type and target_uuid.2
Command type
The operation to perform. Each command type fits certain targets; the chargecloud OS rejects other combinations before anything reaches the device.
Whether a controller restarts during a charging session is up to the controller. For the difference between a soft and a hard reset, see the Help Center article Restarting a Charging Station (Reset).Sent as
type on the command.3
Status and result
Every command reports what happened, normally in the same response, so a support agent knows the outcome right away.
result holds the controller’s answer or the failure reason. A command runs once; to repeat an action, create a new command. The list of commands is your history of what was sent to which device.Identified by command_uuid.Command flow
The typical flow, using a stuck cable as the example:1
Authenticate
Your system signs in once and receives an access token, see Authentication.
2
Send the command
One request naming the charging point and the operation,
unlock.3
Act on the result
The response normally contains the outcome:
accepted (the cable was released), rejected (the controller refused) or failed (with the reason). If the status is still pending or sent, read the command by its command_uuid until it has one of these statuses.created_at and completed_at are server-local time in Y-m-d H:i:s, without a time zone.4
Look it up later
Read a command by its
command_uuid or list commands by device, type or status, for example all failed commands.Additional use cases
- Restart an unresponsive controller: A
soft_resetusually recovers the device; ahard_resetis the stronger fallback. - Stop a charging session remotely: Send a
remote_stopfor the charging point or for the session itself if your system already knows it. Either way, the running session on that charging point ends. - Check or change a controller’s settings: Read the settings the chargecloud OS last received from the controller, refresh them with a
refresh_configurationcommand or change a value. The controller answersAccepted,Rejected,RebootRequired(the change applies after a restart) orNotSupported. - Audit past commands: List commands by device or status to review what was sent and how each device answered.