Merge branch 'main' into feature/event-log

Software/src/devboard/utils/events.cpp

@@ -278,6 +278,62 @@ static void set_message(EVENTS_ENUM_TYPE event) {
       snprintf(events.message, sizeof(events.message), "The dummy event was set!");  // Don't change this event message!
       break;
     default:
-      break;
+      return "UNKNOWN";
   }
 }
+
+const char* get_event_message(EVENTS_ENUM_TYPE event) {
+  switch (event) {
+    case EVENT_CAN_FAILURE:
+      return "No CAN communication detected for 60s. Shutting down battery control.";
+    case EVENT_CAN_WARNING:
+      return "ERROR: High amount of corrupted CAN messages detected. Check CAN wire shielding!";
+    case EVENT_WATER_INGRESS:
+      return "Water leakage inside battery detected. Operation halted. Inspect battery!";
+    case EVENT_12V_LOW:
+      return "12V battery source below required voltage to safely close contactors. Inspect the supply/battery!";
+    case EVENT_SOC_PLAUSIBILITY_ERROR:
+      return "ERROR: SOC% reported by battery not plausible. Restart battery!";
+    case EVENT_KWH_PLAUSIBILITY_ERROR:
+      return "Warning: kWh remaining reported by battery not plausible. Battery needs cycling.";
+    case EVENT_BATTERY_CHG_STOP_REQ:
+      return "ERROR: Battery raised caution indicator AND requested charge stop. Inspect battery status!";
+    case EVENT_BATTERY_DISCHG_STOP_REQ:
+      return "ERROR: Battery raised caution indicator AND requested discharge stop. Inspect battery status!";
+    case EVENT_BATTERY_CHG_DISCHG_STOP_REQ:
+      return "ERROR: Battery raised caution indicator AND requested charge/discharge stop. Inspect battery status!";
+    case EVENT_LOW_SOH:
+      return "ERROR: State of health critically low. Battery internal resistance too high to continue. Recycle "
+             "battery.";
+    case EVENT_HVIL_FAILURE:
+      return "ERROR: Battery interlock loop broken. Check that high voltage connectors are seated. Battery will be "
+             "disabled!";
+    case EVENT_INTERNAL_OPEN_FAULT:
+      return "ERROR: High voltage cable removed while battery running. Opening contactors!";
+    case EVENT_CELL_UNDER_VOLTAGE:
+      return "ERROR: CELL UNDERVOLTAGE!!! Stopping battery charging and discharging. Inspect battery!";
+    case EVENT_CELL_OVER_VOLTAGE:
+      return "ERROR: CELL OVERVOLTAGE!!! Stopping battery charging and discharging. Inspect battery!";
+    case EVENT_CELL_DEVIATION_HIGH:
+      return "ERROR: HIGH CELL DEVIATION!!! Inspect battery!";
+    case EVENT_UNKNOWN_EVENT_SET:
+      return "An unknown event was set! Review your code!";
+    case EVENT_DUMMY:
+      return "The dummy event was set!";  // Don't change this event message!
+    default:
+      return "";
+  }
+}
+
+const char* get_event_enum_string(EVENTS_ENUM_TYPE event) {
+  const char* fullString = EVENTS_ENUM_TYPE_STRING[event];
+  if (strncmp(fullString, "EVENT_", 6) == 0) {
+    return fullString + 6;  // Skip the first 6 characters
+  }
+  return fullString;
+}
+
+static void set_event_message(EVENTS_ENUM_TYPE event) {
+  const char* message = get_event_message(event);
+  snprintf(event_message, sizeof(event_message), "%s", message);
+}

Software/src/devboard/utils/events.h

@@ -1,11 +1,32 @@
 #ifndef __EVENTS_H__
 #define __EVENTS_H__
+#include <stdint.h>
 
 #ifndef UNIT_TEST
 #include <Arduino.h>
+extern unsigned long previous_millis;
+extern uint32_t time_seconds;
 #endif
 
-#include <stdint.h>
+#define EVENTS_ENUM_TYPE(XX)            \
+  XX(EVENT_CAN_FAILURE)                 \
+  XX(EVENT_CAN_WARNING)                 \
+  XX(EVENT_WATER_INGRESS)               \
+  XX(EVENT_12V_LOW)                     \
+  XX(EVENT_SOC_PLAUSIBILITY_ERROR)      \
+  XX(EVENT_KWH_PLAUSIBILITY_ERROR)      \
+  XX(EVENT_BATTERY_CHG_STOP_REQ)        \
+  XX(EVENT_BATTERY_DISCHG_STOP_REQ)     \
+  XX(EVENT_BATTERY_CHG_DISCHG_STOP_REQ) \
+  XX(EVENT_LOW_SOH)                     \
+  XX(EVENT_HVIL_FAILURE)                \
+  XX(EVENT_INTERNAL_OPEN_FAULT)         \
+  XX(EVENT_CELL_UNDER_VOLTAGE)          \
+  XX(EVENT_CELL_OVER_VOLTAGE)           \
+  XX(EVENT_CELL_DEVIATION_HIGH)         \
+  XX(EVENT_UNKNOWN_EVENT_SET)           \
+  XX(EVENT_DUMMY)                       \
+  XX(EVENT_NOF_EVENTS)
 
 typedef enum {
   EVENT_CAN_FAILURE = 0u,             // RED event
@@ -28,6 +49,18 @@ typedef enum {
   EVENT_DUMMY,                        // RED event
   EVENT_NOF_EVENTS                    // RED event
 } EVENTS_ENUM_TYPE;
+#define GENERATE_ENUM(ENUM) ENUM,
+#define GENERATE_STRING(STRING) #STRING,
+
+typedef enum { EVENTS_ENUM_TYPE(GENERATE_ENUM) } EVENTS_ENUM_TYPE;
+
+static const char* EVENTS_ENUM_TYPE_STRING[] = {EVENTS_ENUM_TYPE(GENERATE_STRING)};
+
+const char* get_event_enum_string(EVENTS_ENUM_TYPE event);
+
+const char* get_event_message(EVENTS_ENUM_TYPE event);
+
+const char* get_led_color_display_text(u_int8_t led_color);
 
 void init_events(void);
 void set_event_latched(EVENTS_ENUM_TYPE event, uint8_t data);

Software/src/devboard/utils/test_commands.txt

@@ -1 +0,0 @@
-g++ events_test.cpp ../../../test/test_lib.cpp -o events_test.exe -DUNIT_TEST -I.