| 1 | { |
| 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", |
| 5 | "definitions": { |
| 6 | "CustomDataType": { |
| 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", |
| 9 | "type": "object", |
| 10 | "properties": { |
| 11 | "vendorId": { |
| 12 | "type": "string", |
| 13 | "maxLength": 255 |
| 14 | } |
| 15 | }, |
| 16 | "required": ["vendorId"] |
| 17 | }, |
| 18 | "MonitorEnumType": { |
| 19 | "description": "The type of this monitor, e.g. a threshold, delta or periodic monitor. \r\n", |
| 20 | "javaType": "MonitorEnum", |
| 21 | "type": "string", |
| 22 | "additionalProperties": false, |
| 23 | "enum": ["UpperThreshold", "LowerThreshold", "Delta", "Periodic", "PeriodicClockAligned"] |
| 24 | }, |
| 25 | "ComponentType": { |
| 26 | "description": "A physical or logical component\r\n", |
| 27 | "javaType": "Component", |
| 28 | "type": "object", |
| 29 | "additionalProperties": false, |
| 30 | "properties": { |
| 31 | "customData": { |
| 32 | "$ref": "#/definitions/CustomDataType" |
| 33 | }, |
| 34 | "evse": { |
| 35 | "$ref": "#/definitions/EVSEType" |
| 36 | }, |
| 37 | "name": { |
| 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", |
| 39 | "type": "string", |
| 40 | "maxLength": 50 |
| 41 | }, |
| 42 | "instance": { |
| 43 | "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n", |
| 44 | "type": "string", |
| 45 | "maxLength": 50 |
| 46 | } |
| 47 | }, |
| 48 | "required": ["name"] |
| 49 | }, |
| 50 | "EVSEType": { |
| 51 | "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n", |
| 52 | "javaType": "EVSE", |
| 53 | "type": "object", |
| 54 | "additionalProperties": false, |
| 55 | "properties": { |
| 56 | "customData": { |
| 57 | "$ref": "#/definitions/CustomDataType" |
| 58 | }, |
| 59 | "id": { |
| 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", |
| 61 | "type": "integer" |
| 62 | }, |
| 63 | "connectorId": { |
| 64 | "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n", |
| 65 | "type": "integer" |
| 66 | } |
| 67 | }, |
| 68 | "required": ["id"] |
| 69 | }, |
| 70 | "MonitoringDataType": { |
| 71 | "description": "Class to hold parameters of SetVariableMonitoring request.\r\n", |
| 72 | "javaType": "MonitoringData", |
| 73 | "type": "object", |
| 74 | "additionalProperties": false, |
| 75 | "properties": { |
| 76 | "customData": { |
| 77 | "$ref": "#/definitions/CustomDataType" |
| 78 | }, |
| 79 | "component": { |
| 80 | "$ref": "#/definitions/ComponentType" |
| 81 | }, |
| 82 | "variable": { |
| 83 | "$ref": "#/definitions/VariableType" |
| 84 | }, |
| 85 | "variableMonitoring": { |
| 86 | "type": "array", |
| 87 | "additionalItems": false, |
| 88 | "items": { |
| 89 | "$ref": "#/definitions/VariableMonitoringType" |
| 90 | }, |
| 91 | "minItems": 1 |
| 92 | } |
| 93 | }, |
| 94 | "required": ["component", "variable", "variableMonitoring"] |
| 95 | }, |
| 96 | "VariableMonitoringType": { |
| 97 | "description": "A monitoring setting for a variable.\r\n", |
| 98 | "javaType": "VariableMonitoring", |
| 99 | "type": "object", |
| 100 | "additionalProperties": false, |
| 101 | "properties": { |
| 102 | "customData": { |
| 103 | "$ref": "#/definitions/CustomDataType" |
| 104 | }, |
| 105 | "id": { |
| 106 | "description": "Identifies the monitor.\r\n", |
| 107 | "type": "integer" |
| 108 | }, |
| 109 | "transaction": { |
| 110 | "description": "Monitor only active when a transaction is ongoing on a component relevant to this transaction. \r\n", |
| 111 | "type": "boolean" |
| 112 | }, |
| 113 | "value": { |
| 114 | "description": "Value for threshold or delta monitoring.\r\nFor Periodic or PeriodicClockAligned this is the interval in seconds.\r\n", |
| 115 | "type": "number" |
| 116 | }, |
| 117 | "type": { |
| 118 | "$ref": "#/definitions/MonitorEnumType" |
| 119 | }, |
| 120 | "severity": { |
| 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", |
| 122 | "type": "integer" |
| 123 | } |
| 124 | }, |
| 125 | "required": ["id", "transaction", "value", "type", "severity"] |
| 126 | }, |
| 127 | "VariableType": { |
| 128 | "description": "Reference key to a component-variable.\r\n", |
| 129 | "javaType": "Variable", |
| 130 | "type": "object", |
| 131 | "additionalProperties": false, |
| 132 | "properties": { |
| 133 | "customData": { |
| 134 | "$ref": "#/definitions/CustomDataType" |
| 135 | }, |
| 136 | "name": { |
| 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", |
| 138 | "type": "string", |
| 139 | "maxLength": 50 |
| 140 | }, |
| 141 | "instance": { |
| 142 | "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n", |
| 143 | "type": "string", |
| 144 | "maxLength": 50 |
| 145 | } |
| 146 | }, |
| 147 | "required": ["name"] |
| 148 | } |
| 149 | }, |
| 150 | "type": "object", |
| 151 | "additionalProperties": false, |
| 152 | "properties": { |
| 153 | "customData": { |
| 154 | "$ref": "#/definitions/CustomDataType" |
| 155 | }, |
| 156 | "monitor": { |
| 157 | "type": "array", |
| 158 | "additionalItems": false, |
| 159 | "items": { |
| 160 | "$ref": "#/definitions/MonitoringDataType" |
| 161 | }, |
| 162 | "minItems": 1 |
| 163 | }, |
| 164 | "requestId": { |
| 165 | "description": "The id of the GetMonitoringRequest that requested this report.\r\n\r\n", |
| 166 | "type": "integer" |
| 167 | }, |
| 168 | "tbc": { |
| 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", |
| 170 | "type": "boolean", |
| 171 | "default": false |
| 172 | }, |
| 173 | "seqNo": { |
| 174 | "description": "Sequence number of this message. First message starts at 0.\r\n", |
| 175 | "type": "integer" |
| 176 | }, |
| 177 | "generatedAt": { |
| 178 | "description": "Timestamp of the moment this message was generated at the Charging Station.\r\n", |
| 179 | "type": "string", |
| 180 | "format": "date-time" |
| 181 | } |
| 182 | }, |
| 183 | "required": ["requestId", "seqNo", "generatedAt"] |
| 184 | } |