ocpp-messages 0.1.0

package/schema/v2.0/MeterValuesRequest_v1p0.json

@@ -0,0 +1,212 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:MeterValuesRequest",
+  "comment": "OCPP 2.0 - v1p0",
+  "definitions": {
+    "EncodingMethodEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "Other",
+        "DLMS Message",
+        "COSEM Protected Data",
+        "EDL"
+      ]
+    },
+    "LocationEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "Body",
+        "Cable",
+        "EV",
+        "Inlet",
+        "Outlet"
+      ]
+    },
+    "MeasurandEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "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": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "L1",
+        "L2",
+        "L3",
+        "N",
+        "L1-N",
+        "L2-N",
+        "L3-N",
+        "L1-L2",
+        "L2-L3",
+        "L3-L1"
+      ]
+    },
+    "ReadingContextEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "Interruption.Begin",
+        "Interruption.End",
+        "Other",
+        "Sample.Clock",
+        "Sample.Periodic",
+        "Transaction.Begin",
+        "Transaction.End",
+        "Trigger"
+      ]
+    },
+    "SignatureMethodEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "ECDSAP256SHA256",
+        "ECDSAP384SHA384",
+        "ECDSA192SHA256"
+      ]
+    },
+    "MeterValueType": {
+      "javaType": "MeterValue",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "sampledValue": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/SampledValueType"
+          },
+          "minItems": 1
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "required": [
+        "timestamp",
+        "sampledValue"
+      ]
+    },
+    "SampledValueType": {
+      "javaType": "SampledValue",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "value": {
+          "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": {
+      "javaType": "SignedMeterValue",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "meterValueSignature": {
+          "type": "string",
+          "maxLength": 2500
+        },
+        "signatureMethod": {
+          "$ref": "#/definitions/SignatureMethodEnumType"
+        },
+        "encodingMethod": {
+          "$ref": "#/definitions/EncodingMethodEnumType"
+        },
+        "encodedMeterValue": {
+          "type": "string",
+          "maxLength": 512
+        }
+      },
+      "required": [
+        "meterValueSignature",
+        "signatureMethod",
+        "encodingMethod",
+        "encodedMeterValue"
+      ]
+    },
+    "UnitOfMeasureType": {
+      "javaType": "UnitOfMeasure",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "unit": {
+          "type": "string",
+          "maxLength": 20
+        },
+        "multiplier": {
+          "type": "integer"
+        }
+      }
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "evseId": {
+      "type": "integer"
+    },
+    "meterValue": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "$ref": "#/definitions/MeterValueType"
+      },
+      "minItems": 1
+    }
+  },
+  "required": [
+    "evseId",
+    "meterValue"
+  ]
+}

package/schema/v2.0/MeterValuesResponse_v1p0.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:MeterValuesResponse",
+  "comment": "OCPP 2.0 - v1p0",
+  "type": "object",
+  "additionalProperties": true
+}

package/schema/v2.0/NotifyCentralChargingNeedsRequest_v1p0.json

@@ -0,0 +1,191 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyCentralChargingNeedsRequest",
+  "comment": "OCPP 2.0 - v1p0",
+  "definitions": {
+    "CostKindEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "CarbonDioxideEmission",
+        "RelativePricePercentage",
+        "RenewableGenerationPercentage"
+      ]
+    },
+    "ConsumptionCostType": {
+      "javaType": "ConsumptionCost",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "startValue": {
+          "type": "number"
+        },
+        "cost": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/CostType"
+          },
+          "minItems": 1,
+          "maxItems": 3
+        }
+      },
+      "required": [
+        "startValue",
+        "cost"
+      ]
+    },
+    "CostType": {
+      "javaType": "Cost",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "costKind": {
+          "$ref": "#/definitions/CostKindEnumType"
+        },
+        "amount": {
+          "type": "number"
+        },
+        "amountMultiplier": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "costKind",
+        "amount"
+      ]
+    },
+    "PMaxScheduleType": {
+      "javaType": "PMaxSchedule",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "relativeTimeInterval": {
+          "$ref": "#/definitions/RelativeTimeIntervalType"
+        },
+        "pMax": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "pMax",
+        "relativeTimeInterval"
+      ]
+    },
+    "RelativeTimeIntervalType": {
+      "javaType": "RelativeTimeInterval",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "start": {
+          "type": "integer"
+        },
+        "duration": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "start"
+      ]
+    },
+    "SalesTariffEntryType": {
+      "javaType": "SalesTariffEntry",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "relativeTimeInterval": {
+          "$ref": "#/definitions/RelativeTimeIntervalType"
+        },
+        "ePriceLevel": {
+          "type": "integer",
+          "minimum": 0.0
+        },
+        "consumptionCost": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/ConsumptionCostType"
+          },
+          "minItems": 1,
+          "maxItems": 3
+        }
+      }
+    },
+    "SalesTariffType": {
+      "javaType": "SalesTariff",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "id": {
+          "type": "integer"
+        },
+        "salesTariffDescription": {
+          "type": "string",
+          "maxLength": 32
+        },
+        "numEPriceLevels": {
+          "type": "integer"
+        },
+        "salesTariffEntry": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/SalesTariffEntryType"
+          },
+          "minItems": 1,
+          "maxItems": 1024
+        }
+      },
+      "required": [
+        "id",
+        "salesTariffEntry"
+      ]
+    },
+    "SAScheduleType": {
+      "javaType": "SASchedule",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "pMaxSchedule": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/PMaxScheduleType"
+          },
+          "minItems": 1,
+          "maxItems": 1024
+        },
+        "saScheduleTupleID": {
+          "type": "integer"
+        },
+        "salesTariff": {
+          "$ref": "#/definitions/SalesTariffType"
+        }
+      },
+      "required": [
+        "saScheduleTupleID",
+        "pMaxSchedule"
+      ]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "evseId": {
+      "type": "integer"
+    },
+    "saSchedule": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "$ref": "#/definitions/SAScheduleType"
+      },
+      "minItems": 1,
+      "maxItems": 3
+    }
+  },
+  "required": [
+    "evseId",
+    "saSchedule"
+  ]
+}

package/schema/v2.0/NotifyCentralChargingNeedsResponse_v1p0.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyCentralChargingNeedsResponse",
+  "comment": "OCPP 2.0 - v1p0",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "status": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "Accepted",
+        "Rejected"
+      ]
+    }
+  },
+  "required": [
+    "status"
+  ]
+}

package/schema/v2.0/NotifyChargingLimitRequest_v1p0.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyChargingLimitRequest",
+  "comment": "OCPP 2.0 - v1p0",
+  "definitions": {
+    "ChargingLimitSourceEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "EMS",
+        "Other",
+        "SO",
+        "CSO"
+      ]
+    },
+    "ChargingRateUnitEnumType": {
+      "type": "string",
+      "additionalProperties": true,
+      "enum": [
+        "W",
+        "A"
+      ]
+    },
+    "ChargingLimitType": {
+      "javaType": "ChargingLimit",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "chargingLimitSource": {
+          "$ref": "#/definitions/ChargingLimitSourceEnumType"
+        },
+        "isGridCritical": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "chargingLimitSource"
+      ]
+    },
+    "ChargingSchedulePeriodType": {
+      "javaType": "ChargingSchedulePeriod",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "startPeriod": {
+          "type": "integer"
+        },
+        "limit": {
+          "type": "number"
+        },
+        "numberPhases": {
+          "type": "integer"
+        },
+        "phaseToUse": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "startPeriod",
+        "limit"
+      ]
+    },
+    "ChargingScheduleType": {
+      "javaType": "ChargingSchedule",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "startSchedule": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "duration": {
+          "type": "integer"
+        },
+        "chargingRateUnit": {
+          "$ref": "#/definitions/ChargingRateUnitEnumType"
+        },
+        "chargingSchedulePeriod": {
+          "type": "array",
+          "additionalItems": false,
+          "items": {
+            "$ref": "#/definitions/ChargingSchedulePeriodType"
+          },
+          "minItems": 1
+        },
+        "minChargingRate": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "chargingRateUnit",
+        "chargingSchedulePeriod"
+      ]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "chargingSchedule": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "$ref": "#/definitions/ChargingScheduleType"
+      },
+      "minItems": 1
+    },
+    "evseId": {
+      "type": "integer"
+    },
+    "chargingLimit": {
+      "$ref": "#/definitions/ChargingLimitType"
+    }
+  },
+  "required": [
+    "chargingLimit"
+  ]
+}

package/schema/v2.0/NotifyChargingLimitResponse_v1p0.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyChargingLimitResponse",
+  "comment": "OCPP 2.0 - v1p0",
+  "type": "object",
+  "additionalProperties": true
+}

package/schema/v2.0/NotifyCustomerInformationRequest_v1p0.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyCustomerInformationRequest",
+  "comment": "OCPP 2.0 - v1p0",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "data": {
+      "type": "string",
+      "maxLength": 512
+    },
+    "tbc": {
+      "type": "boolean"
+    },
+    "seqNo": {
+      "type": "integer"
+    },
+    "generatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "requestId": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "data",
+    "tbc",
+    "seqNo",
+    "generatedAt"
+  ]
+}

package/schema/v2.0/NotifyCustomerInformationResponse_v1p0.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "urn:OCPP:Cp:2:2018:4:NotifyCustomerInformationResponse",
+  "comment": "OCPP 2.0 - v1p0",
+  "type": "object",
+  "additionalProperties": true
+}