2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:NotifyMonitoringReportRequest",
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"]
19 "description": "The type of this monitor, e.g. a threshold, delta or periodic monitor. \r\n",
20 "javaType": "MonitorEnum",
22 "additionalProperties": false,
23 "enum": ["UpperThreshold", "LowerThreshold", "Delta", "Periodic", "PeriodicClockAligned"]
26 "description": "A physical or logical component\r\n",
27 "javaType": "Component",
29 "additionalProperties": false,
32 "$ref": "#/definitions/CustomDataType"
35 "$ref": "#/definitions/EVSEType"
38 "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",
43 "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
51 "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n",
54 "additionalProperties": false,
57 "$ref": "#/definitions/CustomDataType"
60 "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",
64 "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
70 "MonitoringDataType": {
71 "description": "Class to hold parameters of SetVariableMonitoring request.\r\n",
72 "javaType": "MonitoringData",
74 "additionalProperties": false,
77 "$ref": "#/definitions/CustomDataType"
80 "$ref": "#/definitions/ComponentType"
83 "$ref": "#/definitions/VariableType"
85 "variableMonitoring": {
87 "additionalItems": false,
89 "$ref": "#/definitions/VariableMonitoringType"
94 "required": ["component", "variable", "variableMonitoring"]
96 "VariableMonitoringType": {
97 "description": "A monitoring setting for a variable.\r\n",
98 "javaType": "VariableMonitoring",
100 "additionalProperties": false,
103 "$ref": "#/definitions/CustomDataType"
106 "description": "Identifies the monitor.\r\n",
110 "description": "Monitor only active when a transaction is ongoing on a component relevant to this transaction. \r\n",
114 "description": "Value for threshold or delta monitoring.\r\nFor Periodic or PeriodicClockAligned this is the interval in seconds.\r\n",
118 "$ref": "#/definitions/MonitorEnumType"
121 "description": "The severity that will be assigned to an event that is triggered by this monitor. The severity range is 0-9, with 0 as the highest and 9 as the lowest severity level.\r\n\r\nThe severity levels have the following meaning: +\r\n*0-Danger* +\r\nIndicates lives are potentially in danger. Urgent attention is needed and action should be taken immediately. +\r\n*1-Hardware Failure* +\r\nIndicates that the Charging Station is unable to continue regular operations due to Hardware issues. Action is required. +\r\n*2-System Failure* +\r\nIndicates that the Charging Station is unable to continue regular operations due to software or minor hardware issues. Action is required. +\r\n*3-Critical* +\r\nIndicates a critical error. Action is required. +\r\n*4-Error* +\r\nIndicates a non-urgent error. Action is required. +\r\n*5-Alert* +\r\nIndicates an alert event. Default severity for any type of monitoring event. +\r\n*6-Warning* +\r\nIndicates a warning event. Action may be required. +\r\n*7-Notice* +\r\nIndicates an unusual event. No immediate action is required. +\r\n*8-Informational* +\r\nIndicates a regular operational event. May be used for reporting, measuring throughput, etc. No action is required. +\r\n*9-Debug* +\r\nIndicates information useful to developers for debugging, not useful during operations.\r\n",
125 "required": ["id", "transaction", "value", "type", "severity"]
128 "description": "Reference key to a component-variable.\r\n",
129 "javaType": "Variable",
131 "additionalProperties": false,
134 "$ref": "#/definitions/CustomDataType"
137 "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",
142 "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
151 "additionalProperties": false,
154 "$ref": "#/definitions/CustomDataType"
158 "additionalItems": false,
160 "$ref": "#/definitions/MonitoringDataType"
165 "description": "The id of the GetMonitoringRequest that requested this report.\r\n\r\n",
169 "description": "“to be continued” indicator. Indicates whether another part of the monitoringData follows in an upcoming notifyMonitoringReportRequest message. Default value when omitted is false.\r\n",
174 "description": "Sequence number of this message. First message starts at 0.\r\n",
178 "description": "Timestamp of the moment this message was generated at the Charging Station.\r\n",
180 "format": "date-time"
183 "required": ["requestId", "seqNo", "generatedAt"]