d398a6ced2
- CitrineOS core extracted (CSMS OCPP 2.0.1) - OpenOCPP extracted (firmware OCPP 1.6J/2.0.1) - ShapeShifter library installed (pip install -e) - ShapeShifter specification extracted - EVerest extracted TODO updated with progress
90 lines
3.0 KiB
YAML
90 lines
3.0 KiB
YAML
description: This interface defines a OCPP 1.6 charge point
|
|
cmds:
|
|
stop:
|
|
description: >-
|
|
Disconnects the websocket connection and stops the OCPP communication.
|
|
No OCPP messages will be stored and sent after a restart.
|
|
result:
|
|
type: boolean
|
|
description: >-
|
|
Returns true if the service could be stopped successfully, else
|
|
false
|
|
restart:
|
|
description: >-
|
|
Connects the websocket and enables OCPP communication after a previous
|
|
stop call.
|
|
result:
|
|
type: boolean
|
|
description: >-
|
|
Returns true if the service could be restarted successfully, else
|
|
false
|
|
get_configuration_key:
|
|
description: >-
|
|
Gets the response to the requested configuration key containing a list of the values of the requested keys
|
|
and a list of the keys that are unknown
|
|
arguments:
|
|
keys:
|
|
description: List of keys for which the values are requested. If empty, all keys and values are returned
|
|
type: array
|
|
items:
|
|
description: A key
|
|
type: string
|
|
result:
|
|
description: Response to the requested operation
|
|
type: object
|
|
$ref: /ocpp#/GetConfigurationResponse
|
|
set_configuration_key:
|
|
description: >-
|
|
Command to set a configuration key
|
|
arguments:
|
|
key:
|
|
description: Key that should be set
|
|
type: string
|
|
maximum: 50
|
|
value:
|
|
description: Value that should be set for the given key
|
|
type: string
|
|
maximum: 500
|
|
result:
|
|
description: Indicates the result of the requested operation
|
|
type: string
|
|
$ref: /ocpp#/ConfigurationStatus
|
|
monitor_configuration_keys:
|
|
description: >-
|
|
Monitors the given configuration key. In case this configuration keys is changed by the CSMS the configuration key
|
|
the changed configuration key will be published. Consecutive calls of this operation will not override but extend the
|
|
existing monitors
|
|
arguments:
|
|
keys:
|
|
description: Keys that should be monitored
|
|
type: array
|
|
items:
|
|
description: Key that should be montired
|
|
type: string
|
|
maximum: 50
|
|
security_event:
|
|
description: >-
|
|
Triggers a SecurityEventNotification.req at the CSMS. This event is queued with a guaranteed delivery
|
|
to the CSMS.
|
|
arguments:
|
|
type:
|
|
description: type of the security event
|
|
type: string
|
|
info:
|
|
description: Additional information about the occurred security event
|
|
type: string
|
|
vars:
|
|
is_connected:
|
|
description: Indicates if chargepoint is connected to CSMS
|
|
type: boolean
|
|
configuration_key:
|
|
description: >-
|
|
Published when a configuration key has been changed by the CSMS and a monitor has been registered
|
|
using the command monitor_configuration_keys
|
|
type: object
|
|
$ref: /ocpp#/KeyValue
|
|
security_event:
|
|
description: Published when an internal security event occurred
|
|
type: object
|
|
$ref: /ocpp#/SecurityEvent
|