Merge pull request #183 from jay-oswald/vehicle-profiles-class

meatpiHQ · web-flow · commit 7cce24de043a · 2024-08-27T22:09:37.000+10:00
add class to vehicle profiles
diff --git a/.vehicle_profiles/schema.json b/.vehicle_profiles/schema.json
@@ -17,6 +17,7 @@
             "minItems": 1,
             "items": {
                 "type": "object",
+                "required": ["pid"],
                 "properties": {
                     "pid": {
                         "description": "The PID for this group of parameters",
@@ -28,6 +29,7 @@
                         "minItems": 1,
                         "items": {
                             "type": "object",
+                            "required": ["name", "expression", "unit", "class"],
                             "properties": {
                                 "name": {
                                     "description": "Used in MQTT JSON, no spaces",
@@ -40,6 +42,10 @@
                                 "unit": {
                                     "description": "Unit for this  parameter",
                                     "type": "string"
+                                },
+                                "class": {
+                                    "description": "Class of sensor, See Home Assistant sensor classes",
+                                    "type": "string"
                                 }
                             }
                         }
diff --git a/vehicle_profiles/README.md b/vehicle_profiles/README.md
@@ -17,7 +17,9 @@ If you would like to add/update a car please make sure it is formatted properly,
 
 **expression**: The expression used to calculate the parameter value
 
-**unit**: The unit of the parameter, e.g., %, °C, or others
+**unit**: The unit of the parameter, e.g., %, °C, or others, see [Home Assistant List](https://www.home-assistant.io/integrations/sensor/#device-class)
+
+**class**: The class of the sensor, see [Home Assistant List](https://www.home-assistant.io/integrations/sensor/#device-class)
 
 **Example:**
 ```
diff --git a/vehicle_profiles/bmw/i3.json b/vehicle_profiles/bmw/i3.json
@@ -8,7 +8,8 @@
                 {
                     "name": "SoC",
                     "expression": "[B11:B12]/10",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 }
             ]
         }
diff --git a/vehicle_profiles/byd/atto3.json b/vehicle_profiles/byd/atto3.json
@@ -8,7 +8,8 @@
                 {
                     "name": "SOC",
                     "expression": "(B5*256)+B4)/100",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 }
             ]
         }
diff --git a/vehicle_profiles/generic.json b/vehicle_profiles/generic.json
@@ -8,7 +8,8 @@
                 {
                     "name": "Engine RPM",
                     "expression": "[B3:B4]*0.25",
-                    "unit": "RPM"
+                    "unit": "RPM",
+                    "class": "frequency"
                 }
             ]
         },
@@ -18,7 +19,8 @@
                 {
                     "name": "Vehicle Speed",
                     "expression": "B3",
-                    "unit": "KM"
+                    "unit": "km/h",
+                    "class": "speed"
                 }
             ]
         },
@@ -28,12 +30,14 @@
                 {
                     "name": "value1",
                     "expression": "B10/10",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 },
                 {
                     "name": "value2",
                     "expression": "(B19+B20)/2",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 }
             ]
         }
diff --git a/vehicle_profiles/hyundai/ioniq5-6.json b/vehicle_profiles/hyundai/ioniq5-6.json
@@ -8,12 +8,14 @@
                 {
                     "name": "SOC_BMS",
                     "expression": "B10/2",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 },
                 {
                     "name": "Aux_Batt_Volts",
                     "expression": "B38*0.1",
-                    "unit": "V"
+                    "unit": "V",
+                    "class": "voltage"
                 }
             ]
         },
@@ -23,7 +25,8 @@
                 {
                     "name": "SOH",
                     "expression": "[B34:B35]/10",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 }
             ]
         }
diff --git a/vehicle_profiles/renault/kangoo-ze.json b/vehicle_profiles/renault/kangoo-ze.json
@@ -8,7 +8,8 @@
                 {
                     "name": "SoC",
                     "expression": "((B4*256)+B5)/50",
-                    "unit": "%"
+                    "unit": "%",
+                    "class": "battery"
                 }
             ]
         }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`{`
`9`	`9`	`"name": "SoC",`
`10`	`10`	`"expression": "[B11:B12]/10",`
`11`		`- "unit": "%"`
	`11`	`+ "unit": "%",`
	`12`	`+ "class": "battery"`
`12`	`13`	`}`
`13`	`14`	`]`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`{`
`9`	`9`	`"name": "Engine RPM",`
`10`	`10`	`"expression": "[B3:B4]*0.25",`
`11`		`- "unit": "RPM"`
	`11`	`+ "unit": "RPM",`
	`12`	`+ "class": "frequency"`
`12`	`13`	`}`
`13`	`14`	`]`
`14`	`15`	`},`
`@@ -18,7 +19,8 @@`
`18`	`19`	`{`
`19`	`20`	`"name": "Vehicle Speed",`
`20`	`21`	`"expression": "B3",`
`21`		`- "unit": "KM"`
	`22`	`+ "unit": "km/h",`
	`23`	`+ "class": "speed"`
`22`	`24`	`}`
`23`	`25`	`]`
`24`	`26`	`},`
`@@ -28,12 +30,14 @@`
`28`	`30`	`{`
`29`	`31`	`"name": "value1",`
`30`	`32`	`"expression": "B10/10",`
`31`		`- "unit": "%"`
	`33`	`+ "unit": "%",`
	`34`	`+ "class": "battery"`
`32`	`35`	`},`
`33`	`36`	`{`
`34`	`37`	`"name": "value2",`
`35`	`38`	`"expression": "(B19+B20)/2",`
`36`		`- "unit": "%"`
	`39`	`+ "unit": "%",`
	`40`	`+ "class": "battery"`
`37`	`41`	`}`
`38`	`42`	`]`
`39`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,14 @@`
`8`	`8`	`{`
`9`	`9`	`"name": "SOC_BMS",`
`10`	`10`	`"expression": "B10/2",`
`11`		`- "unit": "%"`
	`11`	`+ "unit": "%",`
	`12`	`+ "class": "battery"`
`12`	`13`	`},`
`13`	`14`	`{`
`14`	`15`	`"name": "Aux_Batt_Volts",`
`15`	`16`	`"expression": "B38*0.1",`
`16`		`- "unit": "V"`
	`17`	`+ "unit": "V",`
	`18`	`+ "class": "voltage"`
`17`	`19`	`}`
`18`	`20`	`]`
`19`	`21`	`},`
`@@ -23,7 +25,8 @@`
`23`	`25`	`{`
`24`	`26`	`"name": "SOH",`
`25`	`27`	`"expression": "[B34:B35]/10",`
`26`		`- "unit": "%"`
	`28`	`+ "unit": "%",`
	`29`	`+ "class": "battery"`
`27`	`30`	`}`
`28`	`31`	`]`
`29`	`32`	`}`