Add binary sensor types

Marcel Koonstra · Marcel Koonstra · commit b33dd58734ad · 2024-10-21T15:19:07.000+02:00
diff --git a/.vehicle_profiles/schema.json b/.vehicle_profiles/schema.json
@@ -44,8 +44,13 @@
                                     "type": "string"
                                 },
                                 "class": {
-                                    "description": "Class of sensor, See Home Assistant sensor classes",
+                                    "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"]
                                 }
                             }
                         }
diff --git a/main/autopid.c b/main/autopid.c
@@ -199,7 +199,8 @@ void autopid_pub_discovery(void)
             }
 
             // Format discovery topic
-            if (asprintf(&discovery_topic, "homeassistant/sensor/%s/%s/config",
+            if (asprintf(&discovery_topic, "homeassistant/%s/%s/%s/config",
+                         car.pids[i].parameters[j].sensor_type == BINARY_SENSOR ? "binary_sensor" : "sensor",
                          device_id, car.pids[i].parameters[j].name) == -1)
             {
                 // Handle error
@@ -236,9 +237,6 @@ void autopid_pub_discovery(void)
     }
 }
 
-
-
-
 void parse_elm327_response(char *buffer, unsigned char *data, uint32_t *data_length)
 {
     int k = 0;
@@ -627,7 +625,15 @@ static void autopid_task(void *pvParameters)
 
                                                     result = round(result * 100.0) / 100.0;
                                                     // Add the name and result to the JSON object
-                                                    cJSON_AddNumberToObject(rsp_json, car.pids[i].parameters[j].name, result);
+                                                    if (car.pids[i].parameters[j].sensor_type == SENSOR)
+                                                    {
+                                                        cJSON_AddNumberToObject(rsp_json, car.pids[i].parameters[j].name, result);
+                                                    }
+                                                    else if (car.pids[i].parameters[j].sensor_type == BINARY_SENSOR)
+                                                    {
+                                                        cJSON_AddStringToObject(rsp_json, car.pids[i].parameters[j].name, result > 0 ? "ON" : "OFF");
+                                                    }
+                                                    
                                                     ESP_LOGI(TAG, "Expression result, Name: %s: %lf", car.pids[i].parameters[j].name, result);
                                                     specific_pid_response = 1;
                                                 }
@@ -1182,6 +1188,18 @@ static void autopid_load_car_specific(char* car_mod)
                             {
                                 car.pids[i].parameters[j].class = strdup("");  // Assign an empty string if not available
                             }
+
+                            // Parse sensor type
+                            cJSON *sensor_type = cJSON_GetObjectItemCaseSensitive(parameter_item, "type");
+                            if (sensor_type != NULL && cJSON_IsString(sensor_type) && strcmp(sensor_type->valuestring, "binary_sensor") == 0)
+                            {
+                                car.pids[i].parameters[j].sensor_type = BINARY_SENSOR;
+                            }
+                            else
+                            {
+                                car.pids[i].parameters[j].sensor_type = SENSOR;
+                            }
+
                             j++;
                         }
                     }
diff --git a/main/autopid.h b/main/autopid.h
@@ -55,12 +55,19 @@ typedef struct {
     uint8_t type;               // Log type, could be MQTT or file-based
 }__attribute__((aligned(1),packed)) pid_req_t ;
 
+typedef enum
+{
+    SENSOR = 0,
+    BINARY_SENSOR = 1,
+} sensor_type_t;
+
 typedef struct
 {
     char *name;
     char *expression;
     char *unit;
     char *class;
+    sensor_type_t sensor_type;
 } parameter_data_t;
 
 typedef struct
diff --git a/main/config_server.c b/main/config_server.c
@@ -635,6 +635,7 @@ static esp_err_t load_car_config_handler(httpd_req_t *req)
 
             cJSON_AddStringToObject(parameter_details, "class", car->pids[i].parameters[j].class);
             cJSON_AddStringToObject(parameter_details, "unit", car->pids[i].parameters[j].unit);
+            cJSON_AddStringToObject(parameter_details, "sensor_type", car->pids[i].parameters[j].sensor_type == BINARY_SENSOR ? "binary_sensor" : "sensor");
             cJSON_AddItemToObject(parameters_object, car->pids[i].parameters[j].name, parameter_details);
         }
     }
diff --git a/vehicle_profiles/hyundai/ioniq-2017.json b/vehicle_profiles/hyundai/ioniq-2017.json
@@ -32,19 +32,22 @@
           "name": "Charger_Connected",
           "expression": "B14:5",
           "unit": "",
-          "class": ""
+          "class": "plug",
+          "type": "binary_sensor"
         },
         {
           "name": "Charging",
           "expression": "B14:7",
           "unit": "",
-          "class": ""
+          "class": "battery_charging",
+          "type": "binary_sensor"
         },
         {
           "name": "HV_Charger_Connected",
           "expression": "B14:6",
           "unit": "",
-          "class": ""
+          "class": "plug",
+          "type": "binary_sensor"
         }
       ]
     }
diff --git a/vehicle_profiles/kia/niro-phev.json b/vehicle_profiles/kia/niro-phev.json
@@ -32,7 +32,8 @@
             "name": "Charger_Connected",
             "expression": "B14:7",
             "unit": "",
-            "class": ""
+            "class": "plug",
+            "type": "binary_sensor"
           }
         ]
       }
diff --git a/vehicle_profiles/kia/nirosoulkona-ev.json b/vehicle_profiles/kia/nirosoulkona-ev.json
@@ -172,13 +172,15 @@
           "name": "Car_Ready",
           "expression": "B26:3",
           "unit": "none",
-          "class": "none"
+          "class": "none",
+          "type": "binary_sensor"
         },
         {
           "name": "Car_ParkBreak",
           "expression": "B26:5",
           "unit": "none",
-          "class": "none"
+          "class": "none",
+          "type": "binary_sensor"
         }
       ]
     }

Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,13 @@`
`44`	`44`	`"type": "string"`
`45`	`45`	`},`
`46`	`46`	`"class": {`
`47`		`- "description": "Class of sensor, See Home Assistant sensor classes",`
	`47`	`+ "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",`
`48`	`48`	`"type": "string"`
	`49`	`+ },`
	`50`	`+ "type": {`
	`51`	`+ "description": "Type of sensor",`
	`52`	`+ "type": "string",`
	`53`	`+ "enum": ["sensor", "binary_sensor"]`
`49`	`54`	`}`
`50`	`55`	`}`
`51`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,8 @@ void autopid_pub_discovery(void)`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`// Format discovery topic`
`202`		`- if (asprintf(&discovery_topic, "homeassistant/sensor/%s/%s/config",`
	`202`	`+ if (asprintf(&discovery_topic, "homeassistant/%s/%s/%s/config",`
	`203`	`+ car.pids[i].parameters[j].sensor_type == BINARY_SENSOR ? "binary_sensor" : "sensor",`
`203`	`204`	`device_id, car.pids[i].parameters[j].name) == -1)`
`204`	`205`	`{`
`205`	`206`	`// Handle error`
`@@ -236,9 +237,6 @@ void autopid_pub_discovery(void)`
`236`	`237`	`}`
`237`	`238`	`}`
`238`	`239`
`239`		`-`
`240`		`-`
`241`		`-`
`242`	`240`	`void parse_elm327_response(char buffer, unsigned char data, uint32_t *data_length)`
`243`	`241`	`{`
`244`	`242`	`int k = 0;`
`@@ -627,7 +625,15 @@ static void autopid_task(void *pvParameters)`
`627`	`625`
`628`	`626`	`result = round(result * 100.0) / 100.0;`
`629`	`627`	`// Add the name and result to the JSON object`
`630`		`- cJSON_AddNumberToObject(rsp_json, car.pids[i].parameters[j].name, result);`
	`628`	`+ if (car.pids[i].parameters[j].sensor_type == SENSOR)`
	`629`	`+ {`
	`630`	`+ cJSON_AddNumberToObject(rsp_json, car.pids[i].parameters[j].name, result);`
	`631`	`+ }`
	`632`	`+ else if (car.pids[i].parameters[j].sensor_type == BINARY_SENSOR)`
	`633`	`+ {`
	`634`	`+ cJSON_AddStringToObject(rsp_json, car.pids[i].parameters[j].name, result > 0 ? "ON" : "OFF");`
	`635`	`+ }`
	`636`	`+`
`631`	`637`	`ESP_LOGI(TAG, "Expression result, Name: %s: %lf", car.pids[i].parameters[j].name, result);`
`632`	`638`	`specific_pid_response = 1;`
`633`	`639`	`}`
`@@ -1182,6 +1188,18 @@ static void autopid_load_car_specific(char* car_mod)`
`1182`	`1188`	`{`
`1183`	`1189`	`car.pids[i].parameters[j].class = strdup(""); // Assign an empty string if not available`
`1184`	`1190`	`}`
	`1191`	`+`
	`1192`	`+ // Parse sensor type`
	`1193`	`+ cJSON *sensor_type = cJSON_GetObjectItemCaseSensitive(parameter_item, "type");`
	`1194`	`+ if (sensor_type != NULL && cJSON_IsString(sensor_type) && strcmp(sensor_type->valuestring, "binary_sensor") == 0)`
	`1195`	`+ {`
	`1196`	`+ car.pids[i].parameters[j].sensor_type = BINARY_SENSOR;`
	`1197`	`+ }`
	`1198`	`+ else`
	`1199`	`+ {`
	`1200`	`+ car.pids[i].parameters[j].sensor_type = SENSOR;`
	`1201`	`+ }`
	`1202`	`+`
`1185`	`1203`	`j++;`
`1186`	`1204`	`}`
`1187`	`1205`	`}`
Original file line number	Diff line number	Diff line change
`@@ -635,6 +635,7 @@ static esp_err_t load_car_config_handler(httpd_req_t *req)`
`635`	`635`
`636`	`636`	`cJSON_AddStringToObject(parameter_details, "class", car->pids[i].parameters[j].class);`
`637`	`637`	`cJSON_AddStringToObject(parameter_details, "unit", car->pids[i].parameters[j].unit);`
	`638`	`+ cJSON_AddStringToObject(parameter_details, "sensor_type", car->pids[i].parameters[j].sensor_type == BINARY_SENSOR ? "binary_sensor" : "sensor");`
`638`	`639`	`cJSON_AddItemToObject(parameters_object, car->pids[i].parameters[j].name, parameter_details);`
`639`	`640`	`}`
`640`	`641`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,19 +32,22 @@`
`32`	`32`	`"name": "Charger_Connected",`
`33`	`33`	`"expression": "B14:5",`
`34`	`34`	`"unit": "",`
`35`		`- "class": ""`
	`35`	`+ "class": "plug",`
	`36`	`+ "type": "binary_sensor"`
`36`	`37`	`},`
`37`	`38`	`{`
`38`	`39`	`"name": "Charging",`
`39`	`40`	`"expression": "B14:7",`
`40`	`41`	`"unit": "",`
`41`		`- "class": ""`
	`42`	`+ "class": "battery_charging",`
	`43`	`+ "type": "binary_sensor"`
`42`	`44`	`},`
`43`	`45`	`{`
`44`	`46`	`"name": "HV_Charger_Connected",`
`45`	`47`	`"expression": "B14:6",`
`46`	`48`	`"unit": "",`
`47`		`- "class": ""`
	`49`	`+ "class": "plug",`
	`50`	`+ "type": "binary_sensor"`
`48`	`51`	`}`
`49`	`52`	`]`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,8 @@`
`32`	`32`	`"name": "Charger_Connected",`
`33`	`33`	`"expression": "B14:7",`
`34`	`34`	`"unit": "",`
`35`		`- "class": ""`
	`35`	`+ "class": "plug",`
	`36`	`+ "type": "binary_sensor"`
`36`	`37`	`}`
`37`	`38`	`]`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -172,13 +172,15 @@`
`172`	`172`	`"name": "Car_Ready",`
`173`	`173`	`"expression": "B26:3",`
`174`	`174`	`"unit": "none",`
`175`		`- "class": "none"`
	`175`	`+ "class": "none",`
	`176`	`+ "type": "binary_sensor"`
`176`	`177`	`},`
`177`	`178`	`{`
`178`	`179`	`"name": "Car_ParkBreak",`
`179`	`180`	`"expression": "B26:5",`
`180`	`181`	`"unit": "none",`
`181`		`- "class": "none"`
	`182`	`+ "class": "none",`
	`183`	`+ "type": "binary_sensor"`
`182`	`184`	`}`
`183`	`185`	`]`
`184`	`186`	`}`