EVerest API definition for ocpp (consumer) 1.0.0 documentation

EVerest API definition for ocpp (consumer) 1.0.0

Apache-2.0
application/json
ID: pionix:de:everest:ocpp_consumer_API

API for EVerest API clients implementing occp / ocpp_data_transfer (consumer).

#EVerest
#OCPP

Servers

mqtt://localhost:1883/everest_api/1/ocpp_consumer/{module_id}mqttdefault
default local MQTT

object
module_id
required
string
The ID of the module as defined in the EVerest config file

Operations

REPLY e2m/data_transfer_incoming
Direction: EVerest to Module

Operation IDreceive_request_data_transfer_incoming
Available only on servers:
- default
Accepts the following message:
Request data transferreceive_request_data_transfer_incoming
Request data transfer.
application/json
Message IDreceive_request_data_transfer_incoming
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
required
object
Type for data transfer request provided by OCPP

vendor_id
required
string
Identifies the vendor

message_id
string
Identifies the message

data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "headers": { "replyTo": "string" }, "payload": { "vendor_id": "string", "message_id": "string", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to data transfer requestsend_reply_data_transfer_incoming
Reply to the request to transfer data
application/json
Message IDsend_reply_data_transfer_incoming
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "status": "Accepted", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } }

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
SEND
Operation IDsend_reply_data_transfer_incoming
Available only on servers:
- default
Accepts the following message:
Reply to data transfer requestsend_reply_data_transfer_incoming
Reply to the request to transfer data
application/json
Message IDsend_reply_data_transfer_incoming
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "status": "Accepted", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } }
REQUEST m2e/data_transfer_outgoing
Direction: Module to EVerest

Operation IDsend_request_data_transfer_outgoing
Available only on servers:
- default
Accepts the following message:
Request data transfersend_request_data_transfer_outgoing
Request data transfer.
application/json
Message IDsend_request_data_transfer_outgoing
object
object
replyTo
string
Address to send the response to. If this information is missing, the command will still be accepted, but no response will be sent.

Additional properties are allowed.
required
object
Type for data transfer request provided by OCPP

vendor_id
required
string
Identifies the vendor

message_id
string
Identifies the message

data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" }, "payload": { "vendor_id": "string", "message_id": "string", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to data transfer requestreceive_reply_data_transfer_outgoing
Reply to the request to transfer data
application/json
Message IDreceive_reply_data_transfer_outgoing
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "status": "Accepted", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_data_transfer_outgoing
Available only on servers:
- default
Accepts the following message:
Reply to data transfer requestreceive_reply_data_transfer_outgoing
Reply to the request to transfer data
application/json
Message IDreceive_reply_data_transfer_outgoing
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "status": "Accepted", "data": "string", "custom_data": { "vendor_id": "string", "data": "string" } }

This example has been generated automatically.
REQUEST m2e/get_variables
Direction: Module to EVerest

Operation IDsend_request_get_variables
Available only on servers:
- default
Accepts the following message:
Request variablessend_request_get_variables
Request the variables.
application/json
Message IDsend_request_get_variables
Reads variables using canonical component/variable addressing (e.g. component OCPPCommCtrlr, variable HeartbeatInterval), identical for OCPP 1.6 and 2.x. An empty component.name marks the deprecated OCPP 1.6 legacy key form (variable.name = configuration key); it is only accepted while OCPP 1.6 is active and will be removed per the deprecation policy. A non-empty component.name is never reinterpreted as a configuration key. Each result echoes the requested component_variable and carries a status.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.

object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
required
object
List of GetVariableRequest values

required
array<object>
List of GetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" }, "payload": { "items": [ { "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "attribute_type": "Actual" } ] } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Request variablesreceive_reply_get_variables
Reply to the request transmit the requested variables
application/json
Message IDreceive_reply_get_variables
object
List of GetVariableResult values

required
array<object>
List of GetVariableResult values

status
required
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
value
string
[ 0 .. 2500 ] characters
Value of the requested variable and AttributeEnum. This field can only be empty when the given status is NOT accepted

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "items": [ { "status": "Accepted", "attribute_type": "Actual", "value": "string", "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } } } ] }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_variables
Available only on servers:
- default
Accepts the following message:
Request variablesreceive_reply_get_variables
Reply to the request transmit the requested variables
application/json
Message IDreceive_reply_get_variables
object
List of GetVariableResult values

required
array<object>
List of GetVariableResult values

status
required
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
value
string
[ 0 .. 2500 ] characters
Value of the requested variable and AttributeEnum. This field can only be empty when the given status is NOT accepted

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "items": [ { "status": "Accepted", "attribute_type": "Actual", "value": "string", "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } } } ] }

This example has been generated automatically.
REQUEST m2e/set_variables
Direction: Module to EVerest

Operation IDsend_request_set_variables
Available only on servers:
- default
Accepts the following message:
Request set variablessend_request_set_variables
Request setting the variables.
application/json
Message IDsend_request_set_variables
Writes variables using the same canonical component/variable addressing as get_variables, identical for OCPP 1.6 and 2.x; the empty-component OCPP 1.6 legacy key form is deprecated and scheduled for removal. Connection-configuration writes (component NetworkConfiguration with the profile slot number as component instance, and the OCPPCommCtrlr/NetworkConfigurationPriority selector) return RebootRequired: the value is validated and persisted immediately and takes effect on the next (re)connect or reboot.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.

object
object
replyTo
string
Address to send the response to. If this information is missing, the command will still be accepted, but no response will be sent.

Additional properties are allowed.
required
object
Arguments for set_variables

required
object
List of SetVariableRequest values

required
array<object>
List of SetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
value
required
string
[ 0 .. 1000 ] characters
Value of the variable that should be set

attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
source
required
string
source

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" }, "payload": { "variables": { "items": [ { "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "value": "string", "attribute_type": "Actual" } ] }, "source": "string" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply set variablesreceive_reply_set_variables
Reply to the request to set the variables
application/json
Message IDreceive_reply_set_variables
object
List of SetVariableResult values

required
array<object>
List of SetVariableResult values

status
required
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
Examples
{ "items": [ { "status": "Accepted", "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "attribute_type": "Actual" } ] }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_set_variables
Available only on servers:
- default
Accepts the following message:
Reply set variablesreceive_reply_set_variables
Reply to the request to set the variables
application/json
Message IDreceive_reply_set_variables
object
List of SetVariableResult values

required
array<object>
List of SetVariableResult values

status
required
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
Examples
{ "items": [ { "status": "Accepted", "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "attribute_type": "Actual" } ] }

This example has been generated automatically.
SEND m2e/monitor_variables
Direction: Module to EVerest

Operation IDsend_request_monitor_variables
Available only on servers:
- default
Accepts the following message:
Monitor variablessend_request_monitor_variables
Monitor the variables.
application/json
Message IDsend_request_monitor_variables
Command to start monitoring the given ComponentVariable(s), using the same canonical component/variable addressing as get_variables, identical for OCPP 1.6 and 2.x; the empty-component OCPP 1.6 legacy key form is deprecated. Changes to monitored variables are published on the event_data channel and echo the addressing form used at registration. Consecutive calls of this operation will not override but extend the existing monitors.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.

object
List of MonitorVariableRequest values

required
array<object>
List of ComponentVariable values

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "items": [ { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } } ] }
RECEIVE e2m/ocpp_transaction_event
Operation IDreceive_ocpp_transaction_event
Available only on servers:
- default
Accepts the following message:
Receive OCPP transction eventreceive_ocpp_transaction_event
Events related to OCPP transactions
application/json
Message IDreceive_ocpp_transaction_event
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
Examples
{ "transaction_event": "Started", "evse": { "id": 1, "connector_id": 1 }, "session_id": "string", "transaction_id": "string" }

This example has been generated automatically.
RECEIVE e2m/is_connected
Operation IDreceive_is_connected
Available only on servers:
- default
Accepts the following message:
Receive is connectedreceive_is_connected
Indicates if chargepoint is connected to CSMS
application/json
Message IDreceive_is_connected
Payload
boolean
Indicates if chargepoint is connected to CSMS

Examples
This example has been generated automatically.
RECEIVE e2m/security_event
Operation IDreceive_security_event
Available only on servers:
- default
Accepts the following message:
Receive security eventreceive_security_event
Published when an internal sucurity event occured
application/json
Message IDreceive_security_event
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
Examples
{ "type": "string", "info": "string", "critical": true, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
REQUEST m2e/ocpp_transaction_event/get
Request the most recently published (latched) ocpp transaction event. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_ocpp_transaction_event
Available only on servers:
- default
Accepts the following message:
Request current ocpp transaction eventsend_request_get_ocpp_transaction_event
Request the most recently published (latched) ocpp transaction event.
application/json
Message IDsend_request_get_ocpp_transaction_event
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get ocpp transaction event requestreceive_reply_get_ocpp_transaction_event
The most recently published ocpp transaction event.
application/json
Message IDreceive_reply_get_ocpp_transaction_event
oneOf
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
Or to undefined:
null
Examples
{ "transaction_event": "Started", "evse": { "id": 1, "connector_id": 1 }, "session_id": "string", "transaction_id": "string" }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_ocpp_transaction_event
Available only on servers:
- default
Accepts the following message:
Reply to get ocpp transaction event requestreceive_reply_get_ocpp_transaction_event
The most recently published ocpp transaction event.
application/json
Message IDreceive_reply_get_ocpp_transaction_event
oneOf
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
Or to undefined:
null
Examples
{ "transaction_event": "Started", "evse": { "id": 1, "connector_id": 1 }, "session_id": "string", "transaction_id": "string" }

This example has been generated automatically.
REQUEST m2e/security_event/get
Request the most recently published (latched) security event. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_security_event
Available only on servers:
- default
Accepts the following message:
Request current security eventsend_request_get_security_event
Request the most recently published (latched) security event.
application/json
Message IDsend_request_get_security_event
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get security event requestreceive_reply_get_security_event
The most recently published security event.
application/json
Message IDreceive_reply_get_security_event
oneOf
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
Or to undefined:
null
Examples
{ "type": "string", "info": "string", "critical": true, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_security_event
Available only on servers:
- default
Accepts the following message:
Reply to get security event requestreceive_reply_get_security_event
The most recently published security event.
application/json
Message IDreceive_reply_get_security_event
oneOf
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
Or to undefined:
null
Examples
{ "type": "string", "info": "string", "critical": true, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
RECEIVE e2m/boot_notification_response
Operation IDreceive_boot_notification_response
Available only on servers:
- default
Accepts the following message:
Receive boot notification responsereceive_boot_notification_response
Published any time a BootNotificationResponse message is received from the CSMS
application/json
Message IDreceive_boot_notification_response
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "status": "Accepted", "current_time": "2019-08-24T14:15:22Z", "interval": 0, "status_info": { "reason_code": "string", "additional_info": "string" } }

This example has been generated automatically.
REQUEST m2e/boot_notification_response/get
Request the most recently published (latched) boot notification response. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_boot_notification_response
Available only on servers:
- default
Accepts the following message:
Request current boot notification responsesend_request_get_boot_notification_response
Request the most recently published (latched) boot notification response.
application/json
Message IDsend_request_get_boot_notification_response
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get boot notification response requestreceive_reply_get_boot_notification_response
The most recently published boot notification response.
application/json
Message IDreceive_reply_get_boot_notification_response
oneOf
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
Or to undefined:
null
Examples
{ "status": "Accepted", "current_time": "2019-08-24T14:15:22Z", "interval": 0, "status_info": { "reason_code": "string", "additional_info": "string" } }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_boot_notification_response
Available only on servers:
- default
Accepts the following message:
Reply to get boot notification response requestreceive_reply_get_boot_notification_response
The most recently published boot notification response.
application/json
Message IDreceive_reply_get_boot_notification_response
oneOf
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
Or to undefined:
null
Examples
{ "status": "Accepted", "current_time": "2019-08-24T14:15:22Z", "interval": 0, "status_info": { "reason_code": "string", "additional_info": "string" } }

This example has been generated automatically.
RECEIVE e2m/event_data
Operation IDreceive_event_data
Available only on servers:
- default
Accepts the following message:
Receive event datareceive_event_data
Published for a component variable combination when a variable with a monitor has been changed
application/json
Message IDreceive_event_data
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
Examples
{ "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "event_id": 0, "timestamp": "2019-08-24T14:15:22Z", "trigger": "Alerting", "actual_value": "string", "event_notification_type": "HardWiredNotification", "cause": 0, "tech_code": "string", "tech_info": "string", "cleared": true, "transaction_id": "string", "variable_monitoring_id": 0 }

This example has been generated automatically.
REQUEST m2e/event_data/get
Request the most recently published (latched) event data. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_event_data
Available only on servers:
- default
Accepts the following message:
Request current event datasend_request_get_event_data
Request the most recently published (latched) event data.
application/json
Message IDsend_request_get_event_data
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get event data requestreceive_reply_get_event_data
The most recently published event data.
application/json
Message IDreceive_reply_get_event_data
oneOf
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
Or to undefined:
null
Examples
{ "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "event_id": 0, "timestamp": "2019-08-24T14:15:22Z", "trigger": "Alerting", "actual_value": "string", "event_notification_type": "HardWiredNotification", "cause": 0, "tech_code": "string", "tech_info": "string", "cleared": true, "transaction_id": "string", "variable_monitoring_id": 0 }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_event_data
Available only on servers:
- default
Accepts the following message:
Reply to get event data requestreceive_reply_get_event_data
The most recently published event data.
application/json
Message IDreceive_reply_get_event_data
oneOf
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
Or to undefined:
null
Examples
{ "component_variable": { "component": { "name": "string", "instance": "string", "evse": { "id": 1, "connector_id": 1 } }, "variable": { "name": "string", "instance": "string" } }, "event_id": 0, "timestamp": "2019-08-24T14:15:22Z", "trigger": "Alerting", "actual_value": "string", "event_notification_type": "HardWiredNotification", "cause": 0, "tech_code": "string", "tech_info": "string", "cleared": true, "transaction_id": "string", "variable_monitoring_id": 0 }

This example has been generated automatically.
RECEIVE e2m/charging_schedules
Operation IDreceive_charging_schedules
Available only on servers:
- default
Accepts the following message:
Receive composite charging schedulesreceive_charging_schedules
Object that contains OCPP charging schedules of all connectors
application/json
Message IDreceive_charging_schedules
The object contains one composite charging schedule for each connector id starting from connector 0. Connector 0 contains a schedule for the whole charging station.

The frequency of publication is controlled by PublishChargingScheduleIntervalS (OCPP 2.x) and CompositeScheduleIntervalS (OCPP 1.6)

The duration of the composite schedules is controlled by PublishChargingScheduleDurationS (OCPP 2.x) and RequestCompositeScheduleDurationS (OCPP 1.6)

object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
Examples
{ "schedules": [ { "evse": 0, "charging_rate_unit": "string", "charging_schedule_period": [ { "start_period": 0, "limit": 0, "limit_L2": 0, "limit_L3": 0, "number_phases": 0, "stack_level": 0, "phase_to_use": 0, "discharge_limit": 0, "discharge_limit_L2": 0, "discharge_limit_L3": 0, "setpoint": 0, "setpoint_L2": 0, "setpoint_L3": 0, "setpoint_reactive": 0, "setpoint_reactive_L2": 0, "setpoint_reactive_L3": 0, "preconditioning_request": true, "evse_sleep": true, "v2x_baseline": 0, "operation_mode": "Idle", "v2x_freq_watt_curve": [ { "frequency": 0, "power": 0 } ], "v2x_signal_watt_curve": [ { "signal": 0, "power": 0 } ] } ], "duration": 0, "start_schedule": "string", "min_charging_rate": 0 } ] }

This example has been generated automatically.
REQUEST m2e/is_connected/get
Request the most recently published (latched) Is Connected. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_is_connected
Available only on servers:
- default
Accepts the following message:
Request current Is Connectedsend_request_get_is_connected
Request the most recently published (latched) Is Connected.
application/json
Message IDsend_request_get_is_connected
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get Is Connected requestreceive_reply_get_is_connected
The most recently published Is Connected.
application/json
Message IDreceive_reply_get_is_connected
oneOf
Adheres to undefined:
boolean
Indicates if chargepoint is connected to CSMS

Or to undefined:
null
Examples
This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_is_connected
Available only on servers:
- default
Accepts the following message:
Reply to get Is Connected requestreceive_reply_get_is_connected
The most recently published Is Connected.
application/json
Message IDreceive_reply_get_is_connected
oneOf
Adheres to undefined:
boolean
Indicates if chargepoint is connected to CSMS

Or to undefined:
null
Examples
This example has been generated automatically.
REQUEST m2e/charging_schedules/get
Request the most recently published (latched) Charging Schedules. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_charging_schedules
Available only on servers:
- default
Accepts the following message:
Request current Charging Schedulessend_request_get_charging_schedules
Request the most recently published (latched) Charging Schedules.
application/json
Message IDsend_request_get_charging_schedules
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get Charging Schedules requestreceive_reply_get_charging_schedules
The most recently published Charging Schedules.
application/json
Message IDreceive_reply_get_charging_schedules
oneOf
object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
Or to undefined:
null
Examples
{ "schedules": [ { "evse": 0, "charging_rate_unit": "string", "charging_schedule_period": [ { "start_period": 0, "limit": 0, "limit_L2": 0, "limit_L3": 0, "number_phases": 0, "stack_level": 0, "phase_to_use": 0, "discharge_limit": 0, "discharge_limit_L2": 0, "discharge_limit_L3": 0, "setpoint": 0, "setpoint_L2": 0, "setpoint_L3": 0, "setpoint_reactive": 0, "setpoint_reactive_L2": 0, "setpoint_reactive_L3": 0, "preconditioning_request": true, "evse_sleep": true, "v2x_baseline": 0, "operation_mode": "Idle", "v2x_freq_watt_curve": [ { "frequency": 0, "power": 0 } ], "v2x_signal_watt_curve": [ { "signal": 0, "power": 0 } ] } ], "duration": 0, "start_schedule": "string", "min_charging_rate": 0 } ] }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_charging_schedules
Available only on servers:
- default
Accepts the following message:
Reply to get Charging Schedules requestreceive_reply_get_charging_schedules
The most recently published Charging Schedules.
application/json
Message IDreceive_reply_get_charging_schedules
oneOf
object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
Or to undefined:
null
Examples
{ "schedules": [ { "evse": 0, "charging_rate_unit": "string", "charging_schedule_period": [ { "start_period": 0, "limit": 0, "limit_L2": 0, "limit_L3": 0, "number_phases": 0, "stack_level": 0, "phase_to_use": 0, "discharge_limit": 0, "discharge_limit_L2": 0, "discharge_limit_L3": 0, "setpoint": 0, "setpoint_L2": 0, "setpoint_L3": 0, "setpoint_reactive": 0, "setpoint_reactive_L2": 0, "setpoint_reactive_L3": 0, "preconditioning_request": true, "evse_sleep": true, "v2x_baseline": 0, "operation_mode": "Idle", "v2x_freq_watt_curve": [ { "frequency": 0, "power": 0 } ], "v2x_signal_watt_curve": [ { "signal": 0, "power": 0 } ] } ], "duration": 0, "start_schedule": "string", "min_charging_rate": 0 } ] }

This example has been generated automatically.
RECEIVE e2m/ocpp_message
A serialized OCPP message

Operation IDreceive_ocpp_message
Available only on servers:
- default
Accepts the following message:
Receive ocpp messagereceive_ocpp_message
A serialized OCPP message
application/json
Message IDreceive_ocpp_message
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
Examples
{ "message": "string", "direction": "CSMSToChargingStation", "version": "string" }

This example has been generated automatically.
REQUEST m2e/ocpp_message/get
Request the most recently published (latched) ocpp message. The reply will be sent to the replyTo address specified in the message headers. If no latched value is available yet, a null payload will be sent.

Operation IDsend_request_get_ocpp_message
Available only on servers:
- default
Accepts the following message:
Request current ocpp messagesend_request_get_ocpp_message
Request the most recently published (latched) ocpp message.
application/json
Message IDsend_request_get_ocpp_message
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
{ "headers": { "replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
Reply to get ocpp message requestreceive_reply_get_ocpp_message
The most recently published ocpp message.
application/json
Message IDreceive_reply_get_ocpp_message
oneOf
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
Or to undefined:
null
Examples
{ "message": "string", "direction": "CSMSToChargingStation", "version": "string" }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Operation IDreceive_reply_get_ocpp_message
Available only on servers:
- default
Accepts the following message:
Reply to get ocpp message requestreceive_reply_get_ocpp_message
The most recently published ocpp message.
application/json
Message IDreceive_reply_get_ocpp_message
oneOf
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
Or to undefined:
null
Examples
{ "message": "string", "direction": "CSMSToChargingStation", "version": "string" }

This example has been generated automatically.
RECEIVE e2m/heartbeat
Operation IDreceive_heartbeat
Available only on servers:
- default
Accepts the following message:
Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

Examples
#1 Example
Heartbeat
42
SEND m2e/communication_check
Operation IDsend_communication_check
Available only on servers:
- default
Accepts the following message:
Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check

Examples
#1 Example

Messages

#1Request data transferreceive_request_data_transfer_incoming
Request data transfer.
- application/json
Message IDreceive_request_data_transfer_incoming
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
required
object
Type for data transfer request provided by OCPP

vendor_id
required
string
Identifies the vendor

message_id
string
Identifies the message

data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#2Reply to data transfer requestsend_reply_data_transfer_incoming
Reply to the request to transfer data
- application/json
Message IDsend_reply_data_transfer_incoming
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
#3Request data transfersend_request_data_transfer_outgoing
Request data transfer.
- application/json
Message IDsend_request_data_transfer_outgoing
object
object
replyTo
string
Address to send the response to. If this information is missing, the command will still be accepted, but no response will be sent.

Additional properties are allowed.
required
object
Type for data transfer request provided by OCPP

vendor_id
required
string
Identifies the vendor

message_id
string
Identifies the message

data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#4Reply to data transfer requestreceive_reply_data_transfer_outgoing
Reply to the request to transfer data
- application/json
Message IDreceive_reply_data_transfer_outgoing
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
#5Request variablessend_request_get_variables
Request the variables.
- application/json
Message IDsend_request_get_variables
Reads variables using canonical component/variable addressing (e.g. component OCPPCommCtrlr, variable HeartbeatInterval), identical for OCPP 1.6 and 2.x. An empty component.name marks the deprecated OCPP 1.6 legacy key form (variable.name = configuration key); it is only accepted while OCPP 1.6 is active and will be removed per the deprecation policy. A non-empty component.name is never reinterpreted as a configuration key. Each result echoes the requested component_variable and carries a status.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
required
object
List of GetVariableRequest values

required
array<object>
List of GetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
Additional properties are allowed.
#6Request variablesreceive_reply_get_variables
Reply to the request transmit the requested variables
- application/json
Message IDreceive_reply_get_variables
object
List of GetVariableResult values

required
array<object>
List of GetVariableResult values

status
required
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
value
string
[ 0 .. 2500 ] characters
Value of the requested variable and AttributeEnum. This field can only be empty when the given status is NOT accepted

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#7Request set variablessend_request_set_variables
Request setting the variables.
- application/json
Message IDsend_request_set_variables
Writes variables using the same canonical component/variable addressing as get_variables, identical for OCPP 1.6 and 2.x; the empty-component OCPP 1.6 legacy key form is deprecated and scheduled for removal. Connection-configuration writes (component NetworkConfiguration with the profile slot number as component instance, and the OCPPCommCtrlr/NetworkConfigurationPriority selector) return RebootRequired: the value is validated and persisted immediately and takes effect on the next (re)connect or reboot.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.
object
object
replyTo
string
Address to send the response to. If this information is missing, the command will still be accepted, but no response will be sent.

Additional properties are allowed.
required
object
Arguments for set_variables

required
object
List of SetVariableRequest values

required
array<object>
List of SetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
value
required
string
[ 0 .. 1000 ] characters
Value of the variable that should be set

attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
source
required
string
source

Additional properties are allowed.
Additional properties are allowed.
#8Reply set variablesreceive_reply_set_variables
Reply to the request to set the variables
- application/json
Message IDreceive_reply_set_variables
object
List of SetVariableResult values

required
array<object>
List of SetVariableResult values

status
required
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
#9Monitor variablessend_request_monitor_variables
Monitor the variables.
- application/json
Message IDsend_request_monitor_variables
Command to start monitoring the given ComponentVariable(s), using the same canonical component/variable addressing as get_variables, identical for OCPP 1.6 and 2.x; the empty-component OCPP 1.6 legacy key form is deprecated. Changes to monitored variables are published on the event_data channel and echo the addressing form used at registration. Consecutive calls of this operation will not override but extend the existing monitors.

See the OCPPmulti module documentation ("Configuration access" and "Migration from OCPP 1.6 key addressing") for examples and the migration guide.

object
List of MonitorVariableRequest values

required
array<object>
List of ComponentVariable values

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
#10Receive OCPP transction eventreceive_ocpp_transaction_event
Events related to OCPP transactions
- application/json
Message IDreceive_ocpp_transaction_event
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
#11Request current ocpp transaction eventsend_request_get_ocpp_transaction_event
Request the most recently published (latched) ocpp transaction event.
- application/json
Message IDsend_request_get_ocpp_transaction_event
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#12Reply to get ocpp transaction event requestreceive_reply_get_ocpp_transaction_event
The most recently published ocpp transaction event.
- application/json
Message IDreceive_reply_get_ocpp_transaction_event
oneOf
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
Or to undefined:
null
#13Receive is connectedreceive_is_connected
Indicates if chargepoint is connected to CSMS
- application/json
Message IDreceive_is_connected
Payload
boolean
Indicates if chargepoint is connected to CSMS
#14Receive security eventreceive_security_event
Published when an internal sucurity event occured
- application/json
Message IDreceive_security_event
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
#15Request current security eventsend_request_get_security_event
Request the most recently published (latched) security event.
- application/json
Message IDsend_request_get_security_event
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#16Reply to get security event requestreceive_reply_get_security_event
The most recently published security event.
- application/json
Message IDreceive_reply_get_security_event
oneOf
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
Or to undefined:
null
#17Receive boot notification responsereceive_boot_notification_response
Published any time a BootNotificationResponse message is received from the CSMS
- application/json
Message IDreceive_boot_notification_response
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
#18Request current boot notification responsesend_request_get_boot_notification_response
Request the most recently published (latched) boot notification response.
- application/json
Message IDsend_request_get_boot_notification_response
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#19Reply to get boot notification response requestreceive_reply_get_boot_notification_response
The most recently published boot notification response.
- application/json
Message IDreceive_reply_get_boot_notification_response
oneOf
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
Or to undefined:
null
#20Receive event datareceive_event_data
Published for a component variable combination when a variable with a monitor has been changed
- application/json
Message IDreceive_event_data
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
#21Request current event datasend_request_get_event_data
Request the most recently published (latched) event data.
- application/json
Message IDsend_request_get_event_data
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#22Reply to get event data requestreceive_reply_get_event_data
The most recently published event data.
- application/json
Message IDreceive_reply_get_event_data
oneOf
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
Or to undefined:
null
#23Receive composite charging schedulesreceive_charging_schedules
Object that contains OCPP charging schedules of all connectors
- application/json
Message IDreceive_charging_schedules
The object contains one composite charging schedule for each connector id starting from connector 0. Connector 0 contains a schedule for the whole charging station.

The frequency of publication is controlled by PublishChargingScheduleIntervalS (OCPP 2.x) and CompositeScheduleIntervalS (OCPP 1.6)

The duration of the composite schedules is controlled by PublishChargingScheduleDurationS (OCPP 2.x) and RequestCompositeScheduleDurationS (OCPP 1.6)
object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
#24Request current Is Connectedsend_request_get_is_connected
Request the most recently published (latched) Is Connected.
- application/json
Message IDsend_request_get_is_connected
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#25Reply to get Is Connected requestreceive_reply_get_is_connected
The most recently published Is Connected.
- application/json
Message IDreceive_reply_get_is_connected
oneOf
Adheres to undefined:
boolean
Indicates if chargepoint is connected to CSMS

Or to undefined:
null
#26Request current Charging Schedulessend_request_get_charging_schedules
Request the most recently published (latched) Charging Schedules.
- application/json
Message IDsend_request_get_charging_schedules
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#27Reply to get Charging Schedules requestreceive_reply_get_charging_schedules
The most recently published Charging Schedules.
- application/json
Message IDreceive_reply_get_charging_schedules
oneOf
object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
Or to undefined:
null
#28Receive ocpp messagereceive_ocpp_message
A serialized OCPP message
- application/json
Message IDreceive_ocpp_message
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
#29Request current ocpp messagesend_request_get_ocpp_message
Request the most recently published (latched) ocpp message.
- application/json
Message IDsend_request_get_ocpp_message
object
required
object
replyTo
required
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#30Reply to get ocpp message requestreceive_reply_get_ocpp_message
The most recently published ocpp message.
- application/json
Message IDreceive_reply_get_ocpp_message
oneOf
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
Or to undefined:
null
#31Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
- application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
#32Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
- application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check

Schemas

AttributeEnum
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
object
OCPP BootNotificationResponse

status
required
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
current_time
required
string
format: date-time
Contains the CSMS current time in RFC3339 format

interval
required
integer
When Status is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.

object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
Additional properties are allowed.
object
Type to report an event notification for a component-variable

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
event_id
required
integer
Identifies the event

timestamp
required
string
format: date-time
Timestamp of the moment the report was generated

trigger
required
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
actual_value
required
string
<= 2500 characters
Actual value of the variable

event_notification_type
required
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
cause
integer
Refers to the Id of an event that is considered to be the cause for this event

tech_code
string
<= 50 characters
Technical (error) code as reported by component

tech_info
string
<= 500 characters
Technical detail information as reported by component

cleared
boolean
Cleared is set to true to report the clearing of a monitored situation

transaction_id
string
<= 36 characters
If an event notification is linked to a specific transaction, this field can be used to specify its transactionId

variable_monitoring_id
integer
Identifies the VariableMonitoring which triggered the event

Additional properties are allowed.
object
A point of a frequency-watt curve.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

Additional properties are allowed.
object
A point of a signal-watt curve.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

Additional properties are allowed.
object
Element providing information on a charging schedule period.

start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

Additional properties are allowed.
object
Element providing information on an OCPP charging schedule.

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
object
schedules for connectors

required
array<object>
array of schedules

evse
required
integer
>= 0
The OCPP 2.0.1 EVSE ID (not used in OCPP 1.6).

charging_rate_unit
required
string
required
array<object>
start_period
required
integer
limit
required
number
Optional only when not required by the operationMode, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. Charging rate limit during the schedule period, in the applicable chargingRateUnit. This SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit. When using chargingRateUnit = W, this field represents the sum of the power of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

limit_L2
number
Charging rate limit on phase L2 in the applicable chargingRateUnit.

limit_L3
number
Charging rate limit on phase L3 in the applicable chargingRateUnit.

number_phases
integer
stack_level
integer
phase_to_use
integer
discharge_limit
number
value <= 0. Limit in chargingRateUnit that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with setpoint, which can be positive and negative. For AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

discharge_limit_L2
number
Limit in chargingRateUnit on phase L2 that the EV is allowed to discharge with

discharge_limit_L3
number
Limit in chargingRateUnit on phase L3 that the EV is allowed to discharge with

setpoint
number
Setpoint in chargingRateUnit that the EV should follow as close as possible. Use negative values for discharging. When a limit and/or dischargeLimit are given the overshoot when following setpoint must remain within these values. This field represents the sum of all phases,unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_L2
number
Setpoint in chargingRateUnit that the EV should follow on phase L2 as close as possible.

setpoint_L3
number
Setpoint in chargingRateUnit that the EV should follow on phase L3 as close as possible.

setpoint_reactive
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. This field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.

setpoint_reactive_L2
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L2 as closely as possible.

setpoint_reactive_L3
number
Setpoint for reactive power (or current) in chargingRateUnit that the EV should follow on phase L3 as closely as possible.

preconditioning_request
boolean
If true, the EV should attempt to keep the BMS preconditioned for this time interval.

evse_sleep
boolean
If true, the EVSE must turn off power electronics/modules associated with this transaction. Default value when absent is false.

v2x_baseline
number
Power value that, when present, is used as a baseline on top of which values from v2xFreqWattCurve and v2xSignalWattCurve are added

operation_mode
string
Operation mode for (bi-)directional charging during a charging schedule period.

Allowed values:
"Idle"
"ChargingOnly"
"CentralSetpoint"
"ExternalSetpoint"
"ExternalLimits"
"CentralFrequency"
"LocalFrequency"
"LocalLoadBalancing"
array<object>
Only required when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a power-frequency table to use during this period. The table determines the value of setpoint power for a given frequency. chargingRateUnit must be W for LocalFrequency control.

frequency
required
number
Net frequency in Hz

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

array<object>
Only used, but not required, when operationMode = LocalFrequency. When used it must contain at least two coordinates to specify a signal-frequency curve to use during this period. The curve determines the value of setpoint power for a given signal. chargingRateUnit must be W for LocalFrequency control.

signal
required
integer
Signal value from an AFRRSignalRequest.

power
required
number
Power in W to charge (positive) or discharge (negative) at specified frequency.

duration
integer
start_schedule
string
min_charging_rate
number
Additional properties are allowed.
EventTriggerEnum
string
Indicates the trigger reason of a generic event as part of the type EventData Alerting: Monitored variable has passed an Lower or Upper Threshold Delta: Delta Monitored Variable value has changed by more than specified amount Periodic: Periodic Monitored Variable has been sampled for reporting at the specified interval

Allowed values:
"Alerting"
"Delta"
"Periodic"
EventNotificationType
string
Indicates the event notification type as part of the type EventData HardWiredNotification: The software implemented by the manufacturer triggered a hardwired notification HardWiredMonitor: Triggered by a monitor, which is hardwired by the manufacturer PreconfiguredMonitor: Triggered by a monitor, which is preconfigured by the manufacturer. CustomMonitor: Triggered by a monitor which is set by a message by the Charging Station Operator.

Allowed values:
"HardWiredNotification"
"HardWiredMonitor"
"PreconfiguredMonitor"
"CustomMonitor"
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
ConnectedStatus
boolean
Indicates if chargepoint is connected to CSMS
object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
object
Type for data transfer request provided by OCPP

vendor_id
required
string
Identifies the vendor

message_id
string
Identifies the message

data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
object
Type for data transfer response provided by OCPP

status
required
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
data
string
Data provided by this data transfer

object
Custom data extension

vendor_id
required
string
Vendor Id to identify the customization, this is also included in the data field and only reproduced for convenience

data
required
string
Custom json data object encoded as string

Additional properties are allowed.
Additional properties are allowed.
DataTransferStatus
string
Data Transfer Status enum

Allowed values:
"Accepted"
"Rejected"
"UnknownMessageId"
"UnknownVendorId"
"Offline"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
object
Type to request a variable value (OCPP2.0.1) or configuration value (OCPP1.6)

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
object
List of GetVariableRequest values

required
array<object>
List of GetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
object
Result of a GetVariableRequest

status
required
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
value
string
[ 0 .. 2500 ] characters
Value of the requested variable and AttributeEnum. This field can only be empty when the given status is NOT accepted

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
List of GetVariableResult values

required
array<object>
List of GetVariableResult values

status
required
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
value
string
[ 0 .. 2500 ] characters
Value of the requested variable and AttributeEnum. This field can only be empty when the given status is NOT accepted

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
GetVariableStatusEnumType
string
Indicates the status of the GetVariableRequest as part of the GetVariableResult operation

Accepted: Variable successfully retrieved

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
object
List of MonitorVariableRequest values

required
array<object>
List of ComponentVariable values

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
object
Element providing information on OCPP transactions.

transaction_event
required
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
session_id
required
string
The EVSE manager assigned session ID.

transaction_id
string
The CSMS assigned transaction ID. A string is used to support OCPP 2.0.1. For OCPP 1.6 the integer is converted to a string

Additional properties are allowed.
RegistrationStatus
string
Indicates whether the Charging Station has been registered within the OCPP CSMS

Allowed values:
"Accepted"
"Pending"
"Rejected"
object
Type for a security event

type
required
string
Type of the security event

info
string
Additional information about the occurred security event

critical
boolean
If set this overwrites the default criticality recommended in the OCPP 2.0.1 appendix. A critical security event is transmitted as a message to the CSMS, a non-critical one is just written to the security log

timestamp
string
format: date-time
Timestamp of the moment the security event was generated, if absent the current datetime is assumed

Additional properties are allowed.
object
Type to request to set a variable or configuration key

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
value
required
string
[ 0 .. 1000 ] characters
Value of the variable that should be set

attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
object
List of SetVariableRequest values

required
array<object>
List of SetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
value
required
string
[ 0 .. 1000 ] characters
Value of the variable that should be set

attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
object
Result of a SetVariableRequest

status
required
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
object
List of SetVariableResult values

required
array<object>
List of SetVariableResult values

status
required
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
SetVariableStatusEnumType
string
Indicates the status of the SetVariableRequest operation as part of the SetVariableResult

Accepted: Variable successfully set

Rejected: Request is rejected

UnknownComponent: Component is not known

UnknownVariable: Variable is not known

NotSupportedAttributeType: The AttributeType is not supported

RebootRequired: A reboot is required

Allowed values:
"Accepted"
"Rejected"
"UnknownComponent"
"UnknownVariable"
"NotSupportedAttributeType"
"RebootRequired"
object
Arguments for set_variables

required
object
List of SetVariableRequest values

required
array<object>
List of SetVariableRequest values

required
object
Type for a combination of component and variable. Note that for OCPP1.6 only the Variable.name (configuration key) is sufficient to identify a configuration key. For OCPP2.0.1 all properties of the type(s) can be used.

required
object
Type for a component with name, optional instance and optional evse For OCPP1.6: A definition of a Component doesn't exist in OCPP1.6; In the context of OCPP1.6 this type may not be relevant or used. For OCPP2.0.1: All properties of the Component can be used

name
required
string
[ 0 .. 50 ] characters
Name of a component

instance
string
[ 0 .. 50 ] characters
Name of instance in case the component exists as multiple instances

object
Type of an EVSE. If only the id is present, this type identifies an EVSE. If also a connector_id is given, this type identifies a Connector of the EVSE

id
required
integer
>= 1
Id of the EVSE

connector_id
integer
>= 1
An id to designate a specific connector (on an EVSE) by connector index number

Additional properties are allowed.
Additional properties are allowed.
required
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
Additional properties are allowed.
value
required
string
[ 0 .. 1000 ] characters
Value of the variable that should be set

attribute_type
string
Attribute enum

Actual: The actual value of a variable

Target: The target value of a variable

MinSet: The minimal allowed value of a variable

MaxSet: The maximum allowed value of a variable

Allowed values:
"Actual"
"Target"
"MinSet"
"MaxSet"
Additional properties are allowed.
source
required
string
source

Additional properties are allowed.
object
Element providing more information about the status.

reason_code
required
string
A predefined code for the reason why the status is returned in this response. The string is case-insensitive.

additional_info
string
Additional text to provide detailed information

Additional properties are allowed.
TransactionEvent
string
The transaction event enumeration

Allowed values:
"Started"
"Updated"
"Ended"
object
Type for a variable with a name and an optional instance For OCPP1.6: A Variable should only contain a name. The name identifies the configuration key. For OCPP2.0.1: All properties of the Variable can be used

name
required
string
[ 0 .. 50 ] characters
Name of a variable

instance
string
[ 0 .. 50 ] characters
Name of instance in case the variable exists as multiple instances

Additional properties are allowed.
MessageDirection
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
object
OCPP message with direction

message
required
string
Serialized OCPP-J message

direction
required
string
OCPP message direction

Allowed values:
"CSMSToChargingStation"
"ChargingStationToCSMS"
version
string
OCPP version of the serialized message

Additional properties are allowed.
CommunicationCheck
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check
HeartBeatId
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

EVerest API definition for ocpp (consumer) 1.0.0

Servers

Operations

REPLY e2m/data_transfer_incoming

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

#1 Example

REPLY address information

SEND

Examples

#1 Example

REQUEST m2e/data_transfer_outgoing

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

REQUEST m2e/get_variables

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

REQUEST m2e/set_variables

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

SEND m2e/monitor_variables

Examples

#1 Example

RECEIVE e2m/ocpp_transaction_event

Examples

This example has been generated automatically.

RECEIVE e2m/is_connected

Examples

This example has been generated automatically.

RECEIVE e2m/security_event

Examples

This example has been generated automatically.

REQUEST m2e/ocpp_transaction_event/get

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

REQUEST m2e/security_event/get

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

RECEIVE e2m/boot_notification_response

Examples

This example has been generated automatically.

REQUEST m2e/boot_notification_response/get

Examples