initial draft of standard params

Author: jay-oswald

.vehicle_profiles/merge.js

@@ -1,17 +1,30 @@
 import { glob } from 'glob'
 import { readFile, writeFile } from 'fs/promises';
+import editJsonFile from 'edit-json-file'
 
 const source_folder = '../vehicle_profiles';
 const target = '../vehicle_profiles.json'
 
-const files = await glob(source_folder + '/**/*.json');
+const files = await glob(source_folder + '/bmw/*.json');
+const params = JSON.parse(await readFile('params.json'));
 
 let result = {
     'cars': []
 };
 
 async function add_json(path){
     let data = JSON.parse(await readFile(path));
+    let newParams = [];
+    Object.keys(data.pids).forEach(key => {
+        for( const [param, exp] of Object.entries(data.pids[key].parameters)){
+            newParams.push({
+                "name": param,
+                "expression": exp,
+                ...params[param].settings
+            })
+        }
+        data.pids[key].parameters = newParams;
+    })
     result.cars.push(data)
 }
 
@@ -48,4 +61,14 @@ const supportedVehiclesListFilepath = await glob('../docs/content/*.Config/*.Aut
 if(supportedVehiclesListFilepath.length == 0 || supportedVehiclesListFilepath.length != 1) {
     throw new Error('Unable to determine automateDirectory');
 }
-await writeFile(supportedVehiclesListFilepath[0], supportedVehiclesListContent);
+await writeFile(supportedVehiclesListFilepath[0], supportedVehiclesListContent);
+
+
+let param_array = Object.getOwnPropertyNames(params);
+let schema_file = editJsonFile('schema.json');
+const PARAM_PATH = "properties.pids.items.properties.parameters.propertyNames.enum";
+let existing_params = schema_file.get(PARAM_PATH);
+if(existing_params !== param_array){
+    schema_file.set(PARAM_PATH, param_array);
+    schema_file.save();
+}

.vehicle_profiles/package-lock.json

@@ -12,6 +12,7 @@
   "type": "module",
   "dependencies": {
     "ajv": "^8.17.1",
+    "edit-json-file": "^1.8.1",
     "glob": "^11.0.0"
   }
 }

.vehicle_profiles/package.json

@@ -0,0 +1,11 @@
+{
+    "SOC": {
+        "description": "State Of Charge",
+        "settings": {
+            "unit": "%",
+            "class": "battery",
+            "min": "0",
+            "max": "100"
+        }
+    }
+}

.vehicle_profiles/params.json

@@ -1,64 +1,41 @@
 {
-    "title": "WiCan Vehicle Profile",
-    "description": "Data about various models of cars and their settings",
-    "type": "object",
-    "properties": {
-        "car_model": {
-            "description": "Name of car model, should include Make and Model(s)",
-            "type": "string"
-        },
-        "init": {
-            "description": "Init String, don't forget the final ;",
+  "title": "WiCan Vehicle Profile",
+  "description": "Data about various models of cars and their settings",
+  "type": "object",
+  "properties": {
+    "car_model": {
+      "description": "Name of car model, should include Make and Model(s)",
+      "type": "string"
+    },
+    "init": {
+      "description": "Init String, don't forget the final ;",
+      "type": "string"
+    },
+    "pids": {
+      "description": "Array of PID's and their parameters",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "pid"
+        ],
+        "properties": {
+          "pid": {
+            "description": "The PID for this group of parameters",
             "type": "string"
-        },
-        "pids": {
-            "description": "Array of PID's and their parameters",
-            "type": "array",
-            "minItems": 1,
-            "items": {
-                "type": "object",
-                "required": ["pid"],
-                "properties": {
-                    "pid": {
-                        "description": "The PID for this group of parameters",
-                        "type": "string"
-                    },
-                    "parameters": {
-                        "description": "Array of Parameters for this PID",
-                        "type": "array",
-                        "minItems": 1,
-                        "items": {
-                            "type": "object",
-                            "required": ["name", "expression", "unit", "class"],
-                            "properties": {
-                                "name": {
-                                    "description": "Used in MQTT JSON, no spaces",
-                                    "type": "string"
-                                },
-                                "expression": {
-                                    "description": "Expression to calculate value",
-                                    "type": "string"
-                                },
-                                "unit": {
-                                    "description": "Unit for this  parameter",
-                                    "type": "string"
-                                },
-                                "class": {
-                                    "description": "Class of sensor, See Home Assistant sensor classes https://www.home-assistant.io/integrations/sensor/#device-class or https://www.home-assistant.io/integrations/binary_sensor/#device-class",
-                                    "type": "string"
-                                },
-                                "type": {
-                                    "description": "Type of sensor",
-                                    "type": "string",
-                                    "enum": ["sensor", "binary_sensor"]
-                                }
-                            }
-                        }
-                    }
-                }
+          },
+          "parameters": {
+            "description": "Object of Paramater and Expressions",
+            "type": "object",
+            "propertyNames": {
+              "enum": [
+                "SOC"
+              ]
             }
+          }
         }
-    },
-    "additionalProperties": false,
-    "required": [ "car_model", "init", "pids"]
+      }
+    }
+  }
 }

.vehicle_profiles/schema.json

@@ -7,7 +7,7 @@ const schema = JSON.parse(await readFile("schema.json", "utf-8"))
 const validate = ajv.compile(schema)
 
 const source_folder = '../vehicle_profiles';
-const files = await glob(source_folder + '/**/*.json')
+const files = await glob(source_folder + '/bmw/*.json')
 
 let errors = 0;