[e-mobility-charging-stations-simulator.git] / src / assets / json-schemas / ocpp / 2.0 / MeterValuesRequest.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "urn:OCPP:Cp:2:2020:3:MeterValuesRequest",
  "description": "Request_ Body\r\nurn:x-enexis:ecdm:uid:2:234744\r\n",
  "$comment": "OCPP 2.0.1 FINAL",
  "definitions": {
    "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"]
    },
    "LocationEnumType": {
      "description": "Sampled_ Value. Location. Location_ Code\r\nurn:x-oca:ocpp:uid:1:569265\r\nIndicates where the measured value has been sampled. Default =  \"Outlet\"\r\n\r\n",
      "javaType": "LocationEnum",
      "type": "string",
      "default": "Outlet",
      "additionalProperties": false,
      "enum": ["Body", "Cable", "EV", "Inlet", "Outlet"]
    },
    "MeasurandEnumType": {
      "description": "Sampled_ Value. Measurand. Measurand_ Code\r\nurn:x-oca:ocpp:uid:1:569263\r\nType of measurement. Default = \"Energy.Active.Import.Register\"\r\n",
      "javaType": "MeasurandEnum",
      "type": "string",
      "default": "Energy.Active.Import.Register",
      "additionalProperties": false,
      "enum": [
        "Current.Export",
        "Current.Import",
        "Current.Offered",
        "Energy.Active.Export.Register",
        "Energy.Active.Import.Register",
        "Energy.Reactive.Export.Register",
        "Energy.Reactive.Import.Register",
        "Energy.Active.Export.Interval",
        "Energy.Active.Import.Interval",
        "Energy.Active.Net",
        "Energy.Reactive.Export.Interval",
        "Energy.Reactive.Import.Interval",
        "Energy.Reactive.Net",
        "Energy.Apparent.Net",
        "Energy.Apparent.Import",
        "Energy.Apparent.Export",
        "Frequency",
        "Power.Active.Export",
        "Power.Active.Import",
        "Power.Factor",
        "Power.Offered",
        "Power.Reactive.Export",
        "Power.Reactive.Import",
        "SoC",
        "Voltage"
      ]
    },
    "PhaseEnumType": {
      "description": "Sampled_ Value. Phase. Phase_ Code\r\nurn:x-oca:ocpp:uid:1:569264\r\nIndicates how the measured value is to be interpreted. For instance between L1 and neutral (L1-N) Please note that not all values of phase are applicable to all Measurands. When phase is absent, the measured value is interpreted as an overall value.\r\n",
      "javaType": "PhaseEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": ["L1", "L2", "L3", "N", "L1-N", "L2-N", "L3-N", "L1-L2", "L2-L3", "L3-L1"]
    },
    "ReadingContextEnumType": {
      "description": "Sampled_ Value. Context. Reading_ Context_ Code\r\nurn:x-oca:ocpp:uid:1:569261\r\nType of detail value: start, end or sample. Default = \"Sample.Periodic\"\r\n",
      "javaType": "ReadingContextEnum",
      "type": "string",
      "default": "Sample.Periodic",
      "additionalProperties": false,
      "enum": [
        "Interruption.Begin",
        "Interruption.End",
        "Other",
        "Sample.Clock",
        "Sample.Periodic",
        "Transaction.Begin",
        "Transaction.End",
        "Trigger"
      ]
    },
    "MeterValueType": {
      "description": "Meter_ Value\r\nurn:x-oca:ocpp:uid:2:233265\r\nCollection of one or more sampled values in MeterValuesRequest and TransactionEvent. All sampled values in a MeterValue are sampled at the same point in time.\r\n",
      "javaType": "MeterValue",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "sampledValue": {
          "type": "array",
          "additionalItems": false,
          "items": {
            "$ref": "#/definitions/SampledValueType"
          },
          "minItems": 1
        },
        "timestamp": {
          "description": "Meter_ Value. Timestamp. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569259\r\nTimestamp for measured value(s).\r\n",
          "type": "string",
          "format": "date-time"
        }
      },
      "required": ["timestamp", "sampledValue"]
    },
    "SampledValueType": {
      "description": "Sampled_ Value\r\nurn:x-oca:ocpp:uid:2:233266\r\nSingle sampled value in MeterValues. Each value can be accompanied by optional fields.\r\n\r\nTo save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.\r\n",
      "javaType": "SampledValue",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "value": {
          "description": "Sampled_ Value. Value. Measure\r\nurn:x-oca:ocpp:uid:1:569260\r\nIndicates the measured value.\r\n\r\n",
          "type": "number"
        },
        "context": {
          "$ref": "#/definitions/ReadingContextEnumType"
        },
        "measurand": {
          "$ref": "#/definitions/MeasurandEnumType"
        },
        "phase": {
          "$ref": "#/definitions/PhaseEnumType"
        },
        "location": {
          "$ref": "#/definitions/LocationEnumType"
        },
        "signedMeterValue": {
          "$ref": "#/definitions/SignedMeterValueType"
        },
        "unitOfMeasure": {
          "$ref": "#/definitions/UnitOfMeasureType"
        }
      },
      "required": ["value"]
    },
    "SignedMeterValueType": {
      "description": "Represent a signed version of the meter value.\r\n",
      "javaType": "SignedMeterValue",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "signedMeterData": {
          "description": "Base64 encoded, contains the signed data which might contain more then just the meter value. It can contain information like timestamps, reference to a customer etc.\r\n",
          "type": "string",
          "maxLength": 2500
        },
        "signingMethod": {
          "description": "Method used to create the digital signature.\r\n",
          "type": "string",
          "maxLength": 50
        },
        "encodingMethod": {
          "description": "Method used to encode the meter values before applying the digital signature algorithm.\r\n",
          "type": "string",
          "maxLength": 50
        },
        "publicKey": {
          "description": "Base64 encoded, sending depends on configuration variable _PublicKeyWithSignedMeterValue_.\r\n",
          "type": "string",
          "maxLength": 2500
        }
      },
      "required": ["signedMeterData", "signingMethod", "encodingMethod", "publicKey"]
    },
    "UnitOfMeasureType": {
      "description": "Represents a UnitOfMeasure with a multiplier\r\n",
      "javaType": "UnitOfMeasure",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "unit": {
          "description": "Unit of the value. Default = \"Wh\" if the (default) measurand is an \"Energy\" type.\r\nThis field SHALL use a value from the list Standardized Units of Measurements in Part 2 Appendices. \r\nIf an applicable unit is available in that list, otherwise a \"custom\" unit might be used.\r\n",
          "type": "string",
          "default": "Wh",
          "maxLength": 20
        },
        "multiplier": {
          "description": "Multiplier, this value represents the exponent to base 10. I.e. multiplier 3 means 10 raised to the 3rd power. Default is 0.\r\n",
          "type": "integer",
          "default": 0
        }
      }
    }
  },
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "customData": {
      "$ref": "#/definitions/CustomDataType"
    },
    "evseId": {
      "description": "Request_ Body. EVSEID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:571101\r\nThis contains a number (&gt;0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter.\r\n",
      "type": "integer"
    },
    "meterValue": {
      "type": "array",
      "additionalItems": false,
      "items": {
        "$ref": "#/definitions/MeterValueType"
      },
      "minItems": 1
    }
  },
  "required": ["evseId", "meterValue"]
}
Commit	Line	Data
d270cc87	1	{
98fc1389	2	"$schema": "http://json-schema.org/draft-07/schema#",
d270cc87 JB	3	"$id": "urn:OCPP:Cp:2:2020:3:MeterValuesRequest",
d270cc87 JB	4	"description": "Request_ Body\r\nurn:x-enexis:ecdm:uid:2:234744\r\n",
98fc1389	5	"$comment": "OCPP 2.0.1 FINAL",
d270cc87 JB	6	"definitions": {
	7	"CustomDataType": {
	8	"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.",
	9	"javaType": "CustomData",
	10	"type": "object",
	11	"properties": {
	12	"vendorId": {
	13	"type": "string",
	14	"maxLength": 255
	15	}
	16	},
	17	"required": ["vendorId"]
	18	},
	19	"LocationEnumType": {
	20	"description": "Sampled_ Value. Location. Location_ Code\r\nurn:x-oca:ocpp:uid:1:569265\r\nIndicates where the measured value has been sampled. Default = \"Outlet\"\r\n\r\n",
	21	"javaType": "LocationEnum",
	22	"type": "string",
	23	"default": "Outlet",
	24	"additionalProperties": false,
	25	"enum": ["Body", "Cable", "EV", "Inlet", "Outlet"]
	26	},
	27	"MeasurandEnumType": {
	28	"description": "Sampled_ Value. Measurand. Measurand_ Code\r\nurn:x-oca:ocpp:uid:1:569263\r\nType of measurement. Default = \"Energy.Active.Import.Register\"\r\n",
	29	"javaType": "MeasurandEnum",
	30	"type": "string",
	31	"default": "Energy.Active.Import.Register",
	32	"additionalProperties": false,
	33	"enum": [
	34	"Current.Export",
	35	"Current.Import",
	36	"Current.Offered",
	37	"Energy.Active.Export.Register",
	38	"Energy.Active.Import.Register",
	39	"Energy.Reactive.Export.Register",
	40	"Energy.Reactive.Import.Register",
	41	"Energy.Active.Export.Interval",
	42	"Energy.Active.Import.Interval",
	43	"Energy.Active.Net",
	44	"Energy.Reactive.Export.Interval",
	45	"Energy.Reactive.Import.Interval",
	46	"Energy.Reactive.Net",
	47	"Energy.Apparent.Net",
	48	"Energy.Apparent.Import",
	49	"Energy.Apparent.Export",
	50	"Frequency",
	51	"Power.Active.Export",
	52	"Power.Active.Import",
	53	"Power.Factor",
	54	"Power.Offered",
	55	"Power.Reactive.Export",
	56	"Power.Reactive.Import",
	57	"SoC",
	58	"Voltage"
	59	]
	60	},
	61	"PhaseEnumType": {
	62	"description": "Sampled_ Value. Phase. Phase_ Code\r\nurn:x-oca:ocpp:uid:1:569264\r\nIndicates how the measured value is to be interpreted. For instance between L1 and neutral (L1-N) Please note that not all values of phase are applicable to all Measurands. When phase is absent, the measured value is interpreted as an overall value.\r\n",
	63	"javaType": "PhaseEnum",
	64	"type": "string",
	65	"additionalProperties": false,
	66	"enum": ["L1", "L2", "L3", "N", "L1-N", "L2-N", "L3-N", "L1-L2", "L2-L3", "L3-L1"]
	67	},
	68	"ReadingContextEnumType": {
	69	"description": "Sampled_ Value. Context. Reading_ Context_ Code\r\nurn:x-oca:ocpp:uid:1:569261\r\nType of detail value: start, end or sample. Default = \"Sample.Periodic\"\r\n",
70	"javaType": "ReadingContextEnum",
71	"type": "string",
72	"default": "Sample.Periodic",
73	"additionalProperties": false,
74	"enum": [
75	"Interruption.Begin",
76	"Interruption.End",
77	"Other",
78	"Sample.Clock",
79	"Sample.Periodic",
80	"Transaction.Begin",
81	"Transaction.End",
82	"Trigger"
83	]
84	},
85	"MeterValueType": {
86	"description": "Meter_ Value\r\nurn:x-oca:ocpp:uid:2:233265\r\nCollection of one or more sampled values in MeterValuesRequest and TransactionEvent. All sampled values in a MeterValue are sampled at the same point in time.\r\n",
87	"javaType": "MeterValue",
88	"type": "object",
89	"additionalProperties": false,
90	"properties": {
91	"customData": {
92	"$ref": "#/definitions/CustomDataType"
93	},
94	"sampledValue": {
95	"type": "array",
96	"additionalItems": false,
97	"items": {
98	"$ref": "#/definitions/SampledValueType"
99	},
100	"minItems": 1
101	},
102	"timestamp": {
103	"description": "Meter_ Value. Timestamp. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569259\r\nTimestamp for measured value(s).\r\n",
104	"type": "string",
105	"format": "date-time"
106	}
107	},
108	"required": ["timestamp", "sampledValue"]
109	},
110	"SampledValueType": {
111	"description": "Sampled_ Value\r\nurn:x-oca:ocpp:uid:2:233266\r\nSingle sampled value in MeterValues. Each value can be accompanied by optional fields.\r\n\r\nTo save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.\r\n",
112	"javaType": "SampledValue",
113	"type": "object",
114	"additionalProperties": false,
115	"properties": {
116	"customData": {
117	"$ref": "#/definitions/CustomDataType"
118	},
119	"value": {
120	"description": "Sampled_ Value. Value. Measure\r\nurn:x-oca:ocpp:uid:1:569260\r\nIndicates the measured value.\r\n\r\n",
121	"type": "number"
122	},
123	"context": {
124	"$ref": "#/definitions/ReadingContextEnumType"
125	},
126	"measurand": {
127	"$ref": "#/definitions/MeasurandEnumType"
128	},
129	"phase": {
130	"$ref": "#/definitions/PhaseEnumType"
131	},
132	"location": {
133	"$ref": "#/definitions/LocationEnumType"
134	},
135	"signedMeterValue": {
136	"$ref": "#/definitions/SignedMeterValueType"
137	},
138	"unitOfMeasure": {
139	"$ref": "#/definitions/UnitOfMeasureType"
140	}
141	},
142	"required": ["value"]
143	},
144	"SignedMeterValueType": {
145	"description": "Represent a signed version of the meter value.\r\n",
146	"javaType": "SignedMeterValue",
147	"type": "object",
148	"additionalProperties": false,
149	"properties": {
150	"customData": {
151	"$ref": "#/definitions/CustomDataType"
152	},
153	"signedMeterData": {
154	"description": "Base64 encoded, contains the signed data which might contain more then just the meter value. It can contain information like timestamps, reference to a customer etc.\r\n",
155	"type": "string",
156	"maxLength": 2500
157	},
158	"signingMethod": {
159	"description": "Method used to create the digital signature.\r\n",
160	"type": "string",
161	"maxLength": 50
162	},
163	"encodingMethod": {
164	"description": "Method used to encode the meter values before applying the digital signature algorithm.\r\n",
165	"type": "string",
166	"maxLength": 50
167	},
168	"publicKey": {
169	"description": "Base64 encoded, sending depends on configuration variable _PublicKeyWithSignedMeterValue_.\r\n",
170	"type": "string",
171	"maxLength": 2500
172	}
173	},
174	"required": ["signedMeterData", "signingMethod", "encodingMethod", "publicKey"]
175	},
176	"UnitOfMeasureType": {
177	"description": "Represents a UnitOfMeasure with a multiplier\r\n",
178	"javaType": "UnitOfMeasure",
179	"type": "object",
180	"additionalProperties": false,
181	"properties": {
182	"customData": {
183	"$ref": "#/definitions/CustomDataType"
184	},
185	"unit": {
186	"description": "Unit of the value. Default = \"Wh\" if the (default) measurand is an \"Energy\" type.\r\nThis field SHALL use a value from the list Standardized Units of Measurements in Part 2 Appendices. \r\nIf an applicable unit is available in that list, otherwise a \"custom\" unit might be used.\r\n",
187	"type": "string",
188	"default": "Wh",
189	"maxLength": 20
190	},
191	"multiplier": {
192	"description": "Multiplier, this value represents the exponent to base 10. I.e. multiplier 3 means 10 raised to the 3rd power. Default is 0.\r\n",
193	"type": "integer",
194	"default": 0
195	}
196	}
197	}
198	},
199	"type": "object",
200	"additionalProperties": false,
201	"properties": {
202	"customData": {
203	"$ref": "#/definitions/CustomDataType"
204	},
205	"evseId": {
206	"description": "Request_ Body. EVSEID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:571101\r\nThis contains a number (>0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter.\r\n",
207	"type": "integer"
208	},
209	"meterValue": {
210	"type": "array",
211	"additionalItems": false,
212	"items": {
213	"$ref": "#/definitions/MeterValueType"
214	},
215	"minItems": 1
216	}
217	},
218	"required": ["evseId", "meterValue"]
219	}