@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.
326 lines (325 loc) • 14.4 kB
JSON
{
"$id": "MeterValuesRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"LocationEnumType": {
"description": "Indicates 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", "Upstream"],
"tsEnumNames": ["Body", "Cable", "EV", "Inlet", "Outlet", "Upstream"]
},
"MeasurandEnumType": {
"description": "Type of measurement. Default = \"Energy.Active.Import.Register\"\r\n",
"javaType": "MeasurandEnum",
"type": "string",
"default": "Energy.Active.Import.Register",
"additionalProperties": false,
"enum": [
"Current.Export",
"Current.Export.Offered",
"Current.Export.Minimum",
"Current.Import",
"Current.Import.Offered",
"Current.Import.Minimum",
"Current.Offered",
"Display.PresentSOC",
"Display.MinimumSOC",
"Display.TargetSOC",
"Display.MaximumSOC",
"Display.RemainingTimeToMinimumSOC",
"Display.RemainingTimeToTargetSOC",
"Display.RemainingTimeToMaximumSOC",
"Display.ChargingComplete",
"Display.BatteryEnergyCapacity",
"Display.InletHot",
"Energy.Active.Export.Interval",
"Energy.Active.Export.Register",
"Energy.Active.Import.Interval",
"Energy.Active.Import.Register",
"Energy.Active.Import.CableLoss",
"Energy.Active.Import.LocalGeneration.Register",
"Energy.Active.Net",
"Energy.Active.Setpoint.Interval",
"Energy.Apparent.Export",
"Energy.Apparent.Import",
"Energy.Apparent.Net",
"Energy.Reactive.Export.Interval",
"Energy.Reactive.Export.Register",
"Energy.Reactive.Import.Interval",
"Energy.Reactive.Import.Register",
"Energy.Reactive.Net",
"EnergyRequest.Target",
"EnergyRequest.Minimum",
"EnergyRequest.Maximum",
"EnergyRequest.Minimum.V2X",
"EnergyRequest.Maximum.V2X",
"EnergyRequest.Bulk",
"Frequency",
"Power.Active.Export",
"Power.Active.Import",
"Power.Active.Setpoint",
"Power.Active.Residual",
"Power.Export.Minimum",
"Power.Export.Offered",
"Power.Factor",
"Power.Import.Offered",
"Power.Import.Minimum",
"Power.Offered",
"Power.Reactive.Export",
"Power.Reactive.Import",
"SoC",
"Voltage",
"Voltage.Minimum",
"Voltage.Maximum"
],
"tsEnumNames": [
"Current_Export",
"Current_Export_Offered",
"Current_Export_Minimum",
"Current_Import",
"Current_Import_Offered",
"Current_Import_Minimum",
"Current_Offered",
"Display_PresentSOC",
"Display_MinimumSOC",
"Display_TargetSOC",
"Display_MaximumSOC",
"Display_RemainingTimeToMinimumSOC",
"Display_RemainingTimeToTargetSOC",
"Display_RemainingTimeToMaximumSOC",
"Display_ChargingComplete",
"Display_BatteryEnergyCapacity",
"Display_InletHot",
"Energy_Active_Export_Interval",
"Energy_Active_Export_Register",
"Energy_Active_Import_Interval",
"Energy_Active_Import_Register",
"Energy_Active_Import_CableLoss",
"Energy_Active_Import_LocalGeneration_Register",
"Energy_Active_Net",
"Energy_Active_Setpoint_Interval",
"Energy_Apparent_Export",
"Energy_Apparent_Import",
"Energy_Apparent_Net",
"Energy_Reactive_Export_Interval",
"Energy_Reactive_Export_Register",
"Energy_Reactive_Import_Interval",
"Energy_Reactive_Import_Register",
"Energy_Reactive_Net",
"EnergyRequest_Target",
"EnergyRequest_Minimum",
"EnergyRequest_Maximum",
"EnergyRequest_Minimum_V2X",
"EnergyRequest_Maximum_V2X",
"EnergyRequest_Bulk",
"Frequency",
"Power_Active_Export",
"Power_Active_Import",
"Power_Active_Setpoint",
"Power_Active_Residual",
"Power_Export_Minimum",
"Power_Export_Offered",
"Power_Factor",
"Power_Import_Offered",
"Power_Import_Minimum",
"Power_Offered",
"Power_Reactive_Export",
"Power_Reactive_Import",
"SoC",
"Voltage",
"Voltage_Minimum",
"Voltage_Maximum"
]
},
"PhaseEnumType": {
"description": "Indicates 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"],
"tsEnumNames": ["L1", "L2", "L3", "N", "L1_N", "L2_N", "L3_N", "L1_L2", "L2_L3", "L3_L1"]
},
"ReadingContextEnumType": {
"description": "Type 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"
],
"tsEnumNames": [
"Interruption_Begin",
"Interruption_End",
"Other",
"Sample_Clock",
"Sample_Periodic",
"Transaction_Begin",
"Transaction_End",
"Trigger"
]
},
"MeterValueType": {
"description": "Collection 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": {
"sampledValue": {
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/definitions/SampledValueType"
},
"minItems": 1
},
"timestamp": {
"description": "Timestamp for measured value(s).\r\n",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?(?:Z|[+\\-]\\d{2}:\\d{2})$"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["timestamp", "sampledValue"]
},
"SampledValueType": {
"description": "Single 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": {
"value": {
"description": "Indicates the measured value.\r\n\r\n",
"type": "number"
},
"measurand": {
"$ref": "#/definitions/MeasurandEnumType"
},
"context": {
"$ref": "#/definitions/ReadingContextEnumType"
},
"phase": {
"$ref": "#/definitions/PhaseEnumType"
},
"location": {
"$ref": "#/definitions/LocationEnumType"
},
"signedMeterValue": {
"$ref": "#/definitions/SignedMeterValueType"
},
"unitOfMeasure": {
"$ref": "#/definitions/UnitOfMeasureType"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["value"]
},
"SignedMeterValueType": {
"description": "Represent a signed version of the meter value.\r\n",
"javaType": "SignedMeterValue",
"type": "object",
"additionalProperties": false,
"properties": {
"signedMeterData": {
"description": "Base64 encoded, contains the signed data from the meter in the format specified in _encodingMethod_, 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": 32768,
"pattern": "^[A-Za-z0-9+/]*={0,2}$"
},
"signingMethod": {
"description": "*(2.1)* Method used to create the digital signature. Optional, if already included in _signedMeterData_. Standard values for this are defined in Appendix as SigningMethodEnumStringType.\r\n",
"type": "string",
"maxLength": 50
},
"encodingMethod": {
"description": "Format used by the energy meter to encode the meter data. For example: OCMF or EDL.\r\n",
"type": "string",
"maxLength": 50
},
"publicKey": {
"description": "*(2.1)* Base64 encoded, sending depends on configuration variable _PublicKeyWithSignedMeterValue_.\r\n",
"type": "string",
"maxLength": 2500,
"pattern": "^[A-Za-z0-9+/]*={0,2}$"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["signedMeterData", "encodingMethod"]
},
"UnitOfMeasureType": {
"description": "Represents a UnitOfMeasure with a multiplier\r\n",
"javaType": "UnitOfMeasure",
"type": "object",
"additionalProperties": false,
"properties": {
"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\nThe _multiplier_ only multiplies the value of the measurand. It does not specify a conversion between units, for example, kW and W.\r\n",
"type": "integer",
"default": 0,
"minimum": -2147483648,
"maximum": 2147483647
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
}
},
"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": {
"evseId": {
"description": "This contains a number (>0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter.\r\n",
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"meterValue": {
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/definitions/MeterValueType"
},
"minItems": 1
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["evseId", "meterValue"]
}