2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:NotifyEventRequest",
4 "$comment": "OCPP 2.0.1 FINAL",
7 "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.",
8 "javaType": "CustomData",
16 "required": ["vendorId"]
18 "EventNotificationEnumType": {
19 "description": "Specifies the event notification type of the message.\r\n\r\n",
20 "javaType": "EventNotificationEnum",
22 "additionalProperties": false,
23 "enum": ["HardWiredNotification", "HardWiredMonitor", "PreconfiguredMonitor", "CustomMonitor"]
25 "EventTriggerEnumType": {
26 "description": "Type of monitor that triggered this event, e.g. exceeding a threshold value.\r\n\r\n",
27 "javaType": "EventTriggerEnum",
29 "additionalProperties": false,
30 "enum": ["Alerting", "Delta", "Periodic"]
33 "description": "A physical or logical component\r\n",
34 "javaType": "Component",
36 "additionalProperties": false,
39 "$ref": "#/definitions/CustomDataType"
42 "$ref": "#/definitions/EVSEType"
45 "description": "Name of the component. Name should be taken from the list of standardized component names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
50 "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
58 "description": "Class to report an event notification for a component-variable.\r\n",
59 "javaType": "EventData",
61 "additionalProperties": false,
64 "$ref": "#/definitions/CustomDataType"
67 "description": "Identifies the event. This field can be referred to as a cause by other events.\r\n\r\n",
71 "description": "Timestamp of the moment the report was generated.\r\n",
76 "$ref": "#/definitions/EventTriggerEnumType"
79 "description": "Refers to the Id of an event that is considered to be the cause for this event.\r\n\r\n",
83 "description": "Actual value (_attributeType_ Actual) of the variable.\r\n\r\nThe Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal. \r\n\r\n",
88 "description": "Technical (error) code as reported by component.\r\n",
93 "description": "Technical detail information as reported by component.\r\n",
98 "description": "_Cleared_ is set to true to report the clearing of a monitored situation, i.e. a 'return to normal'. \r\n\r\n",
102 "description": "If an event notification is linked to a specific transaction, this field can be used to specify its transactionId.\r\n",
107 "$ref": "#/definitions/ComponentType"
109 "variableMonitoringId": {
110 "description": "Identifies the VariableMonitoring which triggered the event.\r\n",
113 "eventNotificationType": {
114 "$ref": "#/definitions/EventNotificationEnumType"
117 "$ref": "#/definitions/VariableType"
125 "eventNotificationType",
131 "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n",
134 "additionalProperties": false,
137 "$ref": "#/definitions/CustomDataType"
140 "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nEVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.\r\n",
144 "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
151 "description": "Reference key to a component-variable.\r\n",
152 "javaType": "Variable",
154 "additionalProperties": false,
157 "$ref": "#/definitions/CustomDataType"
160 "description": "Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
165 "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
174 "additionalProperties": false,
177 "$ref": "#/definitions/CustomDataType"
180 "description": "Timestamp of the moment this message was generated at the Charging Station.\r\n",
182 "format": "date-time"
185 "description": "“to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyEventRequest message. Default value when omitted is false. \r\n",
190 "description": "Sequence number of this message. First message starts at 0.\r\n",
195 "additionalItems": false,
197 "$ref": "#/definitions/EventDataType"
202 "required": ["generatedAt", "seqNo", "eventData"]