ocpp-messages 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 embyt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# Open Charge Point Protocol (OCPP) v1.6 and v2.0.1 type declarations
+
+This package provides TypeScript type declarations for the OCPP (Open Charge Point Protocol). It includes type definitions for all OCPP message types and their properties.
+
+## OCPP versions supported:
+
+- 1.6
+- 2.0.1
+
+## Installation
+
+```bash
+npm install --save-dev ocpp-messages
+```
+
+## Usage
+
+Import the provided type definitions into your TypeScript project:
+
+```typescript
+import { StatusNotificationRequest } from "ocpp-messages/v1.6";
+
+// Use the types in your code
+const statusRequest: StatusNotificationRequest = {
+  // ...
+};
+```
+
+## Contributing
+
+Contributions are welcome! If you find any issues or would like to add new features or improvements, please open an issue or submit a pull request on the GitHub repository.
+
+## License
+
+This package is licensed under the MIT License.

package/compile.js

@@ -0,0 +1,17 @@
+"use strict";
+const { compileFromFile } = require("json-schema-to-typescript");
+const fs = require("fs");
+fs.readdir(__dirname + "/schema/v1.6", function (err, files) {
+  //handling error
+  if (err) {
+    return console.log("Unable to scan directory: " + err);
+  }
+  //listing all files using forEach
+  files.forEach(function (file) {
+    // compile from file
+    compileFromFile(`${__dirname}/schema/v1.6/${file}`).then((ts) =>
+      fs.writeFileSync(`${__dirname}/v1.6/${file.replace(".json", ".d.ts")}`, ts),
+    );
+    console.log(file);
+  });
+});

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "ocpp-messages",
+  "version": "0.1.0",
+  "description": "TypeScript definitions for Open Charge Point Protocol (OCPP)",
+  "main": "",
+  "author": "Roman Morawek, embyt GmbH",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/embyt/ocpp-messages.git"
+  },
+  "bugs": {
+    "url": "https://github.com/embyt/ocpp-messages/issues"
+  },
+  "homepage": "https://github.com/embyt/ocpp-messages",
+  "keywords": [
+    "ocpp",
+    "ocpp types",
+    "@types ocpp",
+    "open charge point protocol",
+    "v1.6",
+    "v2.0"
+  ],
+  "devDependencies": {
+    "json-schema-to-typescript": "^13.1.1"
+  },
+  "scripts": {}
+}

package/schema/v1.6/Authorize.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "AuthorizeRequest",
+    "type": "object",
+    "properties": {
+        "idTag": {
+            "type": "string",
+            "maxLength": 20
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "idTag"
+    ]
+}

package/schema/v1.6/AuthorizeResponse.json

@@ -0,0 +1,37 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "AuthorizeResponse",
+    "type": "object",
+    "properties": {
+        "idTagInfo": {
+            "type": "object",
+            "properties": {
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "Accepted",
+                        "Blocked",
+                        "Expired",
+                        "Invalid",
+                        "ConcurrentTx"
+                    ]
+                },
+                "expiryDate": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "parentIdTag": {
+                    "type": "string",
+                    "maxLength": 20
+                }
+            },
+            "required": [
+                "status"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "idTagInfo"
+    ]
+}

package/schema/v1.6/BootNotification.json

@@ -0,0 +1,48 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "BootNotificationRequest",
+    "type": "object",
+    "properties": {
+        "chargePointVendor": {
+            "type": "string",
+            "maxLength": 20
+        },
+        "chargePointModel": {
+            "type": "string",
+            "maxLength": 20
+        },
+        "chargePointSerialNumber": {
+            "type": "string",
+            "maxLength": 25
+        },
+        "chargeBoxSerialNumber": {
+            "type": "string",
+            "maxLength": 25
+        },
+        "firmwareVersion": {
+            "type": "string",
+            "maxLength": 50
+        },
+        "iccid": {
+            "type": "string",
+            "maxLength": 20
+        },
+        "imsi": {
+            "type": "string",
+            "maxLength": 20
+        },
+        "meterType": {
+            "type": "string",
+            "maxLength": 25
+        },
+        "meterSerialNumber": {
+            "type": "string",
+            "maxLength": 25
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "chargePointVendor",
+        "chargePointModel"
+    ]
+}

package/schema/v1.6/BootNotificationResponse.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "BootNotificationResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Pending",
+                "Rejected"
+            ]
+        },
+        "currentTime": {
+            "type": "string",
+            "format": "date-time"
+        },
+        "interval": {
+            "type": "number"
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status",
+        "currentTime",
+        "interval"
+    ]
+}

package/schema/v1.6/CancelReservation.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "CancelReservationRequest",
+    "type": "object",
+    "properties": {
+        "reservationId": {
+            "type": "integer"
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "reservationId"
+    ]
+}

package/schema/v1.6/CancelReservationResponse.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "CancelReservationResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/ChangeAvailability.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ChangeAvailabilityRequest",
+    "type": "object",
+    "properties": {
+        "connectorId": {
+            "type": "integer"
+        },
+        "type": {
+            "type": "string",
+            "enum": [
+                "Inoperative",
+                "Operative"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "connectorId",
+        "type"
+    ]
+}

package/schema/v1.6/ChangeAvailabilityResponse.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ChangeAvailabilityResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected",
+                "Scheduled"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/ChangeConfiguration.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ChangeConfigurationRequest",
+    "type": "object",
+    "properties": {
+        "key": {
+            "type": "string",
+            "maxLength": 50
+        },
+        "value": {
+            "type": "string",
+            "maxLength": 500
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "key",
+        "value"
+    ]
+}

package/schema/v1.6/ChangeConfigurationResponse.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ChangeConfigurationResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected",
+                "RebootRequired",
+                "NotSupported"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/ClearCache.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ClearCacheRequest",
+    "type": "object",
+    "properties": {},
+    "additionalProperties": false
+}

package/schema/v1.6/ClearCacheResponse.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ClearCacheResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/ClearChargingProfile.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ClearChargingProfileRequest",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "integer"
+        },
+        "connectorId": {
+            "type": "integer"
+        },
+        "chargingProfilePurpose": {
+            "type": "string",
+            "enum": [
+                "ChargePointMaxProfile",
+                "TxDefaultProfile",
+                "TxProfile"
+            ]
+        },
+        "stackLevel": {
+            "type": "integer"
+        }
+    },
+    "additionalProperties": false
+}

package/schema/v1.6/ClearChargingProfileResponse.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "ClearChargingProfileResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Unknown"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/DataTransfer.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "DataTransferRequest",
+    "type": "object",
+    "properties": {
+        "vendorId": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "messageId": {
+            "type": "string",
+            "maxLength": 50
+        },
+        "data": {
+            "type": "string"
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "vendorId"
+    ]
+}

package/schema/v1.6/DataTransferResponse.json

@@ -0,0 +1,23 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "DataTransferResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected",
+                "UnknownMessageId",
+                "UnknownVendorId"
+            ]
+        },
+        "data": {
+            "type": "string"
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/DiagnosticsStatusNotification.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "DiagnosticsStatusNotificationRequest",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Idle",
+                "Uploaded",
+                "UploadFailed",
+                "Uploading"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/DiagnosticsStatusNotificationResponse.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "DiagnosticsStatusNotificationResponse",
+    "type": "object",
+    "properties": {},
+    "additionalProperties": false
+}

package/schema/v1.6/FirmwareStatusNotification.json

@@ -0,0 +1,23 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "FirmwareStatusNotificationRequest",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Downloaded",
+                "DownloadFailed",
+                "Downloading",
+                "Idle",
+                "InstallationFailed",
+                "Installing",
+                "Installed"
+            ]
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/FirmwareStatusNotificationResponse.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "FirmwareStatusNotificationResponse",
+    "type": "object",
+    "properties": {},
+    "additionalProperties": false
+}

package/schema/v1.6/GetCompositeSchedule.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "GetCompositeScheduleRequest",
+    "type": "object",
+    "properties": {
+        "connectorId": {
+        	"type": "integer"
+        },
+	"duration": {
+		"type": "integer"
+	},
+	"chargingRateUnit": {
+		"type": "string",
+		"enum": [
+			"A",
+			"W"
+			]
+		}
+    },
+    "additionalProperties": false,
+    "required": [
+        "connectorId",
+	    "duration"
+    ]
+}

package/schema/v1.6/GetCompositeScheduleResponse.json

@@ -0,0 +1,74 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "GetCompositeScheduleResponse",
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected"
+            ]
+        },
+	"connectorId": {
+		"type": "integer"
+        },
+	"scheduleStart": {
+		"type": "string",
+		"format": "date-time"
+	},
+	"chargingSchedule": {
+		"type": "object",
+		"properties": {
+			"duration": {
+				"type": "integer"
+			},
+			"startSchedule": {
+				"type": "string",
+				"format": "date-time"
+			},
+			"chargingRateUnit": {
+				"type": "string",
+				"enum": [
+					"A",
+					"W"
+					]
+			},
+			"chargingSchedulePeriod": {
+				"type": "array",
+				"items": {
+					"type": "object",
+					"properties": {
+						"startPeriod": {
+							"type": "integer"
+						},
+						"limit": {
+							"type": "number",
+						    "multipleOf" : 0.1
+						},
+						"numberPhases": {
+							"type": "integer"
+						}
+					},
+					"required": [
+						"startPeriod",
+						"limit"
+						]
+				}
+			},
+			"minChargingRate": {
+				"type": "number",
+				"multipleOf" : 0.1
+			}
+		},
+		"required": [
+			"chargingRateUnit",
+			"chargingSchedulePeriod"
+		]
+		}
+	},
+    "additionalProperties": false,
+    "required": [
+        "status"
+    ]
+}

package/schema/v1.6/GetConfiguration.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "GetConfigurationRequest",
+    "type": "object",
+    "properties": {
+        "key": {
+            "type": "array",
+            "items": {
+                "type": "string",
+				"maxLength": 50
+            }
+        }
+    },
+    "additionalProperties": false
+}