@bsv/dpp-profiles 0.3.0-beta.1

package/generated/payload-schema/battery@2.restricted.schema.json

@@ -0,0 +1,377 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:bsv:dpp:profile:battery@2:payload-restricted",
+  "title": "Battery passport (battery@2), restricted payload",
+  "description": "battery@2: the restricted tiers held off chain, encrypted, and committed by field 11. JSON Schema validity is one check; obligation under a condition (needs-review), units, provenance and legal applicability are separate checks.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "serviceDate": {
+      "type": "string",
+      "format": "date",
+      "title": "Put into service",
+      "description": "required; Annex XIII (4); applicability category-in"
+    },
+    "status": {
+      "enum": [
+        "Original",
+        "Reused",
+        "Repurposed",
+        "Remanufactured",
+        "Waste"
+      ],
+      "title": "Status",
+      "description": "required; Annex XIII 4(c); Art. 77(7)"
+    },
+    "testReports": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object"
+        }
+      ],
+      "title": "Test reports",
+      "description": "required; Annex XIII (3)"
+    },
+    "electrodeMaterials": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "component": {
+            "enum": [
+              "cathode",
+              "anode",
+              "electrolyte",
+              "separator",
+              "casing"
+            ]
+          },
+          "material": {
+            "type": "string",
+            "minLength": 1
+          },
+          "share": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 100
+          }
+        },
+        "required": [
+          "component",
+          "material"
+        ]
+      },
+      "title": "Cathode, anode and electrolyte materials",
+      "description": "required; Annex XIII (2a)"
+    },
+    "dismantlingManual": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object"
+        }
+      ],
+      "title": "Dismantling manual",
+      "description": "required; Annex XIII (2c)"
+    },
+    "partNumbersUrl": {
+      "type": "string",
+      "format": "uri",
+      "title": "Part numbers",
+      "description": "required; Annex XIII (2b)"
+    },
+    "sparePartsAddress": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "street": {
+          "type": "string",
+          "minLength": 1
+        },
+        "locality": {
+          "type": "string",
+          "minLength": 1
+        },
+        "postcode": {
+          "type": "string",
+          "minLength": 1
+        },
+        "region": {
+          "type": "string",
+          "minLength": 1
+        },
+        "country": {
+          "type": "string",
+          "pattern": "^[A-Z]{2}$"
+        }
+      },
+      "required": [
+        "street",
+        "locality",
+        "country"
+      ],
+      "title": "Spare parts: postal address",
+      "description": "required; Annex XIII (2b)"
+    },
+    "sparePartsEmail": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 254,
+      "pattern": "^[^@\\s]+@[^@\\s.]+(\\.[^@\\s.]+)+$",
+      "title": "Spare parts: e-mail",
+      "description": "required; Annex XIII (2b)"
+    },
+    "sparePartsUrl": {
+      "type": "string",
+      "format": "uri",
+      "title": "Spare parts: web address",
+      "description": "required; Annex XIII (2b)"
+    },
+    "safetyMeasures": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object"
+        }
+      ],
+      "title": "Safety measures",
+      "description": "required; Annex XIII (2d)"
+    },
+    "remainingCapacityAh": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Remaining capacity",
+      "description": "required; Annex VII Part A(1); applicability category-in"
+    },
+    "capacityFade": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Capacity fade",
+      "description": "required; Annex IV Part A(1)"
+    },
+    "certifiedEnergyKwh": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Usable energy",
+      "description": "recommended; added by the consortium, based on UN GTR No 22; applicability category-in"
+    },
+    "remainingEnergyKwh": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Remaining usable energy",
+      "description": "recommended; added by the consortium, based on UN GTR No 22; applicability category-in"
+    },
+    "soce": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "State of certified energy",
+      "description": "required; UN GTR No 22; applicability category-in"
+    },
+    "stateOfCharge": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "State of charge",
+      "description": "required; Annex XIII 4(d)"
+    },
+    "powerRemaining": {
+      "type": "integer",
+      "minimum": 0,
+      "title": "Remaining power",
+      "description": "required; Annex VII Part A(2); Annex IV; applicability category-in"
+    },
+    "powerFade": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Power fade",
+      "description": "required; Annex IV Part A(2)"
+    },
+    "powerToEnergy": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Power to energy ratio",
+      "description": "recommended; Annex IV Part B(2)"
+    },
+    "roundTripRemaining": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Round trip efficiency, remaining",
+      "description": "required; Annex VII Part A(3); applicability category-in"
+    },
+    "roundTripFade": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Round trip efficiency fade",
+      "description": "required; Annex IV Part A(4)"
+    },
+    "selfDischargeInitial": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Self-discharge, initial",
+      "description": "recommended; Annex VII Part A(4); applicability category-in"
+    },
+    "selfDischargeCurrent": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Self-discharge, current",
+      "description": "recommended; Annex VII Part A(4); applicability category-in"
+    },
+    "selfDischargeEvolution": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Self-discharge over time",
+      "description": "required; Annex VII Part A(4); applicability category-in"
+    },
+    "resistanceIncreasePack": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Resistance increase, pack",
+      "description": "required; Annex IV Part A(3)"
+    },
+    "resistanceIncreaseCell": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Resistance increase, cell",
+      "description": "recommended; Annex IV Part A(3)"
+    },
+    "resistanceIncreaseModule": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "Resistance increase, module",
+      "description": "recommended; Annex IV Part A(3)"
+    },
+    "expectedYears": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Expected life in years",
+      "description": "required; Annex IV Part A(5)"
+    },
+    "cyclesUsed": {
+      "type": "integer",
+      "minimum": 0,
+      "title": "Cycles so far",
+      "description": "required; Annex XIII (4d)"
+    },
+    "energyThroughput": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Energy through the battery",
+      "description": "required; Annex VII Part B(2); applicability category-in"
+    },
+    "capacityThroughput": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Capacity through the battery",
+      "description": "required; Annex VII Part B(3); applicability category-in"
+    },
+    "temperatureRecord": {
+      "type": "number",
+      "minimum": -60,
+      "maximum": 150,
+      "title": "Temperature record",
+      "description": "required; Annex XIII (4d)"
+    },
+    "timeAboveRange": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Time above range",
+      "description": "required; Annex VII Part B(4); applicability category-in"
+    },
+    "timeBelowRange": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Time below range",
+      "description": "required; Annex VII Part B(4); applicability category-in"
+    },
+    "chargingAboveRange": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Charging above range",
+      "description": "required; Annex VII Part B(4); applicability category-in"
+    },
+    "chargingBelowRange": {
+      "type": "number",
+      "minimum": 0,
+      "title": "Charging below range",
+      "description": "required; Annex VII Part B(4); applicability category-in"
+    },
+    "deepDischargeEvents": {
+      "type": "integer",
+      "minimum": 0,
+      "title": "Deep discharges",
+      "description": "required; Annex VII; applicability category-in"
+    },
+    "overchargeEvents": {
+      "type": "integer",
+      "minimum": 0,
+      "title": "Overcharges",
+      "description": "recommended; added by the consortium"
+    },
+    "accidents": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri"
+        },
+        {
+          "type": "object"
+        }
+      ],
+      "title": "Accidents",
+      "description": "required; Annex XIII (4d)"
+    },
+    "stateOfHealth": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "title": "State of health",
+      "description": "recommended; app addition; the spec decomposes SoH into Annex VII Part A parameters"
+    },
+    "measured": {
+      "enum": [
+        "manufacturer",
+        "authorised-service",
+        "independent-lab",
+        "operator",
+        "repurposer",
+        "recycler"
+      ],
+      "title": "Measured by",
+      "description": "recommended; app addition"
+    }
+  },
+  "required": [
+    "capacityFade",
+    "dismantlingManual",
+    "electrodeMaterials",
+    "expectedYears",
+    "partNumbersUrl",
+    "powerFade",
+    "resistanceIncreasePack",
+    "roundTripFade",
+    "safetyMeasures",
+    "sparePartsAddress",
+    "sparePartsEmail",
+    "sparePartsUrl"
+  ]
+}