@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
98 lines (97 loc) • 3.68 kB
JSON
{
"$id": "TriggerMessageRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"MessageTriggerEnumType": {
"description": "Type of message to be triggered.\r\n",
"javaType": "MessageTriggerEnum",
"type": "string",
"additionalProperties": false,
"enum": [
"BootNotification",
"LogStatusNotification",
"FirmwareStatusNotification",
"Heartbeat",
"MeterValues",
"SignChargingStationCertificate",
"SignV2GCertificate",
"SignV2G20Certificate",
"StatusNotification",
"TransactionEvent",
"SignCombinedCertificate",
"PublishFirmwareStatusNotification",
"CustomTrigger"
],
"tsEnumNames": [
"BootNotification",
"LogStatusNotification",
"FirmwareStatusNotification",
"Heartbeat",
"MeterValues",
"SignChargingStationCertificate",
"SignV2GCertificate",
"SignV2G20Certificate",
"StatusNotification",
"TransactionEvent",
"SignCombinedCertificate",
"PublishFirmwareStatusNotification",
"CustomTrigger"
]
},
"EVSEType": {
"description": "Electric Vehicle Supply Equipment\r\n",
"javaType": "EVSE",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.\r\n",
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"connectorId": {
"description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["id"]
},
"CustomDataType": {
"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"evse": {
"$ref": "#/definitions/EVSEType"
},
"requestedMessage": {
"$ref": "#/definitions/MessageTriggerEnumType"
},
"customTrigger": {
"description": "*(2.1)* When _requestedMessage_ = `CustomTrigger` this will trigger sending the corresponding message in field _customTrigger_, if supported by Charging Station.\r\n\r\n",
"type": "string",
"maxLength": 50
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["requestedMessage"]
}