OCPP 2.1 Schemas — RemoteControl

Functional Block: F

Types Reference: Shared types referenced below are defined in OCPP-2.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

RequestStartTransaction (CSMS → CS)
RequestStopTransaction (CSMS → CS)
UnlockConnector (CSMS → CS)
TriggerMessage (CSMS → CS)

#RequestStartTransaction

Direction: CSMS → CS

#RequestStartTransactionRequest

Field	Type	Required	Constraints	Description
`idToken`	IdTokenType	Yes
`remoteStartId`	integer	Yes		Id given by the server to this start request. The Charging Station will return this in the TransactionEventRequest, letting the server know which transaction was started for this request. Use to start a transaction.
`chargingProfile`	ChargingProfileType	No
`evseId`	integer	No	min: 1.0	Number of the EVSE on which to start the transaction. EvseId SHALL be > 0
`groupIdToken`	IdTokenType	No
`customData`	CustomDataType	No

Example RequestStartTransactionRequest

{
  "idToken": {
    "idToken": "string",
    "type": "string"
  },
  "remoteStartId": 0
}

#RequestStartTransactionResponse

Field	Type	Required	Constraints	Description
`status`	RequestStartStopStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`transactionId`	string	No	maxLength: 36	When the transaction was already started by the Charging Station before the RequestStartTransactionRequest was received, for example: cable plugged in first. This contains the transactionId of the already started transaction.
`customData`	CustomDataType	No

#RequestStopTransaction

Direction: CSMS → CS

#RequestStopTransactionRequest

Field	Type	Required	Constraints	Description
`transactionId`	string	Yes	maxLength: 36	The identifier of the transaction which the Charging Station is requested to stop.
`customData`	CustomDataType	No

Example RequestStopTransactionRequest

{
  "transactionId": "string"
}

#RequestStopTransactionResponse

Field	Type	Required
`status`	RequestStartStopStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#UnlockConnector

Direction: CSMS → CS

#UnlockConnectorRequest

Field	Type	Required	Constraints	Description
`connectorId`	integer	Yes	min: 0.0	This contains the identifier of the connector that needs to be unlocked.
`evseId`	integer	Yes	min: 0.0	This contains the identifier of the EVSE for which a connector needs to be unlocked.
`customData`	CustomDataType	No

Example UnlockConnectorRequest

{
  "connectorId": 0,
  "evseId": 0
}

#UnlockConnectorResponse

Field	Type	Required
`status`	UnlockStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#TriggerMessage

Direction: CSMS → CS

#TriggerMessageRequest

Field	Type	Required	Constraints	Description
`requestedMessage`	MessageTriggerEnumType	Yes
`customTrigger`	string	No	maxLength: 50	(2.1) When requestedMessage = CustomTrigger this will trigger sending the corresponding message in field customTrigger, if supported by Charging Station.
`evse`	EVSEType	No
`customData`	CustomDataType	No

Example TriggerMessageRequest

{
  "requestedMessage": "BootNotification"
}

#TriggerMessageResponse

Field	Type	Required
`status`	TriggerMessageStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#Local Types

Types used only within this block's messages.

#MessageTriggerEnumType

Type of message to be triggered.

Value
`BootNotification`
`LogStatusNotification`
`FirmwareStatusNotification`
`Heartbeat`
`MeterValues`
`SignChargingStationCertificate`
`SignV2GCertificate`
`SignV2G20Certificate`
`StatusNotification`
`TransactionEvent`
`SignCombinedCertificate`
`PublishFirmwareStatusNotification`
`CustomTrigger`

Used in: TriggerMessage

#RequestStartStopStatusEnumType

Status indicating whether the Charging Station accepts the request to start a transaction.

Value
`Accepted`
`Rejected`

Used in: RequestStartTransaction, RequestStopTransaction

#TriggerMessageStatusEnumType

Indicates whether the Charging Station will send the requested notification or not.

Value
`Accepted`
`Rejected`
`NotImplemented`

Used in: TriggerMessage

#UnlockStatusEnumType

This indicates whether the Charging Station has unlocked the connector.

Value
`Unlocked`
`UnlockFailed`
`OngoingAuthorizedTransaction`
`UnknownConnector`

Used in: UnlockConnector