FIRM-167 Hexray SoC

can_bus/hexray/BMS/BMS_rx.json

@@ -9,6 +9,7 @@
     "Debug_CanMode",
     "Debug_Charging",
     "Debug_SetBSPDTestCurrent",
-    "Debug_CellBalancing"
+    "Debug_CellBalancing",
+    "Debug_ResetSoc"
   ]
 }

can_bus/hexray/BMS/BMS_tx.json

@@ -191,19 +191,25 @@
       }
     }
   },
-  "HvBatteryProperties": {
-    "msg_id": 455,
-    "cycle_time": 1000,
-    "description": "HV Battery Properties",
+  "VoltageAndChargeStats": {
+    "msg_id": 458,
+    "cycle_time": 100,
+    "description": "BMS Cell Voltage readings",
     "signals": {
-      "HvBatterySoc": {
-        "start_bit": 0,
-        "bits": 8,
+      "SocPercent": {
+        "resolution": 0.1,
         "min": 0,
         "max": 100,
-        "scale": 1,
-        "offset": 0,
         "unit": "%"
+      },
+      "SocCoulombs": {
+        "resolution": 1,
+        "min": 0,
+        "max": 100000,
+        "unit": "C"
+      },
+      "SocDirty": {
+        "bits": 1
       }
     }
   },

firmware/hexray/BMS/CMakeLists.txt

@@ -24,6 +24,7 @@ file(GLOB_RECURSE IO_SRCS CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/src/io/
 set(IO_SHARED_SRCS
         "${SHARED_IO_INCLUDE_DIR_CPP}/io_time.cpp"
         "${SHARED_IO_INCLUDE_DIR_CPP}/io_shdnLoopNode.cpp"
+        "${SHARED_IO_INCLUDE_DIR_CPP}/io_filesystem.cpp"
 )
 set(IO_INCLUDE_DIRS
         "${CMAKE_CURRENT_SOURCE_DIR}/src/io"
@@ -38,9 +39,9 @@ set(HW_SHARED_SRCS
         "${SHARED_HW_INCLUDE_DIR_CPP}/hw_spi.cpp"
         "${SHARED_HW_INCLUDE_DIR_CPP}/hw_pwmOutput.cpp"
         "${SHARED_HW_INCLUDE_DIR_CPP}/hw_can_hx.cpp"
+        "${SHARED_HW_INCLUDE_DIR_CPP}/hw_sd.cpp"
         "${SHARED_HW_INCLUDE_DIR_CPP}/hw_bootup.cpp"
         "${SHARED_HW_INCLUDE_DIR_CPP}/hw_resetReason.cpp"
-        "${SHARED_HW_INCLUDE_DIR_CPP}/hw_bootup.cpp"
 )
 set(HW_INCLUDE_DIRS
         "${CMAKE_CURRENT_SOURCE_DIR}/src/hw"
@@ -136,7 +137,7 @@ if ("${TARGET}" STREQUAL "binary")
             "${CMAKE_CURRENT_BINARY_DIR}/app"
     )
 
-    target_link_libraries("hexray_BMS_app.elf" PRIVATE "hexray_BMS_stm32" "hexray_BMS_jsoncan" "hexray_BMS_commit_info" "m")
+    target_link_libraries("hexray_BMS_app.elf" PRIVATE "hexray_BMS_stm32" "hexray_BMS_jsoncan" "hexray_BMS_commit_info" "m" "logfs_cm7")
     target_compile_definitions("hexray_BMS_app.elf" PRIVATE BMS)
 
     add_chimera_stm32h7("hexray_BMS_chimera" "${CHIMERA_SRCS}" "${CHIMERA_INCLUDE_DIRS}" "hexray_chimera_v2_proto_cm7")

firmware/hexray/BMS/src/app/app_soc.cpp

@@ -0,0 +1,173 @@
+#include "app_soc.hpp"
+#include "app_canTx.hpp"
+#include "app_math.hpp"
+#include "app_socStorage.hpp"
+#include "app_tractiveSystem.hpp"
+#include "io_irs.hpp"
+#include "io_time.hpp"
+
+#include <array>
+#include <cmath>
+#include <cstdint>
+
+namespace
+{
+constexpr double MS_TO_S        = 0.001;
+constexpr double AH_TO_COULOMBS = 3600.0;
+
+constexpr uint32_t V_TO_SOC_LUT_SIZE = 201U;
+constexpr float    LUT_BASE_SOC      = 0.0f;
+
+constexpr double STATE_OF_HEALTH = 1.0f;
+// TODO: Replace with cell capacity and cells in parallel constants in app_segments once that's finished
+constexpr double SERIES_ELEMENT_FULL_CHARGE_C = 3.0 * AH_TO_COULOMBS * 4.0 * STATE_OF_HEALTH;
+
+// Charge in cell in coulombs.
+double soc_charge_c = -1.0;
+
+// Charge loss at time t-1.
+float soc_prev_current_A = 0.0f;
+
+// Indicates if SOC from SD was invalid at startup.
+bool soc_is_dirty = true;
+
+uint32_t soc_prev_update_ms = 0U;
+
+// index 0 represents 0.0% SoC, final index represents 100%. 0.5% increments.
+constexpr std::array<float, V_TO_SOC_LUT_SIZE> ocv_soc_lut = { {
+    2.478484f, 2.548948f, 2.555629f, 2.636801f, 2.717973f, 2.795096f, 2.845899f, 2.896701f, 2.947503f, 2.979689f,
+    3.009237f, 3.038785f, 3.062674f, 3.083212f, 3.103750f, 3.124092f, 3.144124f, 3.164156f, 3.183431f, 3.197409f,
+    3.211386f, 3.225364f, 3.240896f, 3.256680f, 3.272465f, 3.284931f, 3.295543f, 3.306156f, 3.304352f, 3.317410f,
+    3.331939f, 3.344696f, 3.356658f, 3.368619f, 3.380526f, 3.391995f, 3.403385f, 3.414583f, 3.421610f, 3.426887f,
+    3.432164f, 3.436899f, 3.440721f, 3.444543f, 3.448370f, 3.452317f, 3.456320f, 3.460323f, 3.465373f, 3.470832f,
+    3.476372f, 3.482455f, 3.488869f, 3.495323f, 3.501739f, 3.508092f, 3.514425f, 3.520623f, 3.526513f, 3.532403f,
+    3.538241f, 3.543478f, 3.548635f, 3.553792f, 3.558754f, 3.563582f, 3.568411f, 3.573168f, 3.577760f, 3.582344f,
+    3.586892f, 3.591139f, 3.595281f, 3.599423f, 3.603309f, 3.607144f, 3.610956f, 3.614661f, 3.618294f, 3.621917f,
+    3.625508f, 3.629068f, 3.632628f, 3.636199f, 3.639814f, 3.643430f, 3.647046f, 3.650764f, 3.654502f, 3.658240f,
+    3.662069f, 3.666019f, 3.669968f, 3.673983f, 3.678140f, 3.682339f, 3.686552f, 3.690932f, 3.695370f, 3.699882f,
+    3.704528f, 3.709202f, 3.713828f, 3.718485f, 3.723182f, 3.727879f, 3.732598f, 3.737347f, 3.742095f, 3.746847f,
+    3.751637f, 3.756426f, 3.761216f, 3.766030f, 3.770867f, 3.775704f, 3.780582f, 3.785519f, 3.790488f, 3.795490f,
+    3.800562f, 3.805651f, 3.810753f, 3.815940f, 3.821127f, 3.826319f, 3.831529f, 3.836744f, 3.841952f, 3.847058f,
+    3.852135f, 3.857211f, 3.862209f, 3.867022f, 3.871836f, 3.876640f, 3.881274f, 3.885880f, 3.890486f, 3.894997f,
+    3.899466f, 3.903929f, 3.908409f, 3.912903f, 3.917498f, 3.922166f, 3.926984f, 3.931814f, 3.936749f, 3.941997f,
+    3.947246f, 3.952528f, 3.958148f, 3.963841f, 3.969533f, 3.975359f, 3.981300f, 3.987241f, 3.993173f, 3.999034f,
+    4.004879f, 4.010713f, 4.016239f, 4.021650f, 4.027055f, 4.032055f, 4.036909f, 4.041577f, 4.045854f, 4.049776f,
+    4.053605f, 4.057009f, 4.059732f, 4.062456f, 4.065076f, 4.066936f, 4.068797f, 4.070658f, 4.072325f, 4.073932f,
+    4.075540f, 4.077227f, 4.079082f, 4.080939f, 4.082910f, 4.085239f, 4.087742f, 4.090254f, 4.093629f, 4.097167f,
+    4.100969f, 4.105953f, 4.111315f, 4.117198f, 4.124902f, 4.134033f, 4.143165f, 4.155217f, 4.171970f, 4.188723f,
+    4.205476f,
+} };
+
+float getSocFromOcv(const float voltage)
+{
+    if (!std::isfinite(voltage) || (voltage <= ocv_soc_lut[0U]))
+    {
+        return LUT_BASE_SOC;
+    }
+
+    if (voltage > ocv_soc_lut[V_TO_SOC_LUT_SIZE - 1U])
+    {
+        return LUT_BASE_SOC + static_cast<float>(V_TO_SOC_LUT_SIZE - 1U) * 0.5f;
+    }
+
+    uint32_t lower_index = 0U;
+    uint32_t upper_index = V_TO_SOC_LUT_SIZE - 1U;
+
+    while (lower_index < upper_index)
+    {
+        const uint32_t mid_index = lower_index + (upper_index - lower_index) / 2U;
+
+        if (voltage > ocv_soc_lut[mid_index])
+        {
+            lower_index = mid_index + 1U;
+        }
+        else
+        {
+            upper_index = mid_index;
+        }
+    }
+
+    return LUT_BASE_SOC + static_cast<float>(lower_index) * 0.5f;
+}
+
+uint32_t getMinSocCoulombs()
+{
+    if (soc_charge_c < 0.0)
+    {
+        return 0U;
+    }
+    return static_cast<uint32_t>(soc_charge_c);
+}
+
+void updateSocStats()
+{
+    const float current = app::ts::getCurrent();
+
+    const uint32_t current_time_ms = io::time::getCurrentMs();
+    const uint32_t elapsed_time_ms = current_time_ms - soc_prev_update_ms;
+    soc_prev_update_ms             = current_time_ms;
+
+    const double elapsed_time_s = static_cast<double>(elapsed_time_ms) * MS_TO_S;
+
+    app::math::trapezoidalRule(soc_charge_c, soc_prev_current_A, current, elapsed_time_s);
+}
+
+} // namespace
+
+namespace app::soc
+{
+void init()
+{
+    if (const auto saved_soc_percent = app::socStorage::readSocFromSd();
+        saved_soc_percent && IS_IN_RANGE(0.0f, 100.0f, *saved_soc_percent))
+    {
+        soc_charge_c = static_cast<double>(*saved_soc_percent) / 100.0 * SERIES_ELEMENT_FULL_CHARGE_C;
+        soc_is_dirty = false;
+    }
+    else
+    {
+        soc_prev_current_A = 0.0f;
+        soc_is_dirty       = true;
+        soc_charge_c       = -1.0;
+    }
+
+    soc_prev_update_ms = io::time::getCurrentMs();
+}
+
+bool getDirty()
+{
+    return soc_is_dirty;
+}
+
+float getMinSocPercent()
+{
+    return static_cast<float>(soc_charge_c / SERIES_ELEMENT_FULL_CHARGE_C * 100.0);
+}
+
+void resetSocFromVoltage()
+{
+    // TODO: Use minimum cell voltage once app::segments is migrated in Hexray BMS.
+    (void)getSocFromOcv(0.0f);
+    soc_is_dirty = true;
+}
+
+void resetSocCustomValue(const float soc_percent)
+{
+    soc_charge_c = static_cast<double>(soc_percent) / 100.0 * SERIES_ELEMENT_FULL_CHARGE_C;
+
+    soc_is_dirty = true;
+}
+
+void broadcast()
+{
+    app::can_tx::BMS_SocPercent_set(getMinSocPercent());
+    app::can_tx::BMS_SocCoulombs_set(getMinSocCoulombs());
+    app::can_tx::BMS_SocDirty_set(getDirty());
+    if (io::irs::negativeState() == app::can_utils::ContactorState::CONTACTOR_STATE_CLOSED &&
+        io::irs::positiveState() == app::can_utils::ContactorState::CONTACTOR_STATE_CLOSED)
+    {
+        updateSocStats();
+    }
+}
+
+} // namespace app::soc

firmware/hexray/BMS/src/app/app_soc.hpp

@@ -0,0 +1,37 @@
+#pragma once
+
+#include <cstdint>
+
+namespace app::soc
+{
+/**
+ * @brief Initialize the SOC module.
+ */
+void init();
+
+/**
+ * @brief Return whether the SoC estimate is dirty and needs to be updated.
+ */
+bool getDirty();
+
+/**
+ * @brief Get current minimum SoC in percent.
+ */
+float getMinSocPercent();
+
+/**
+ * @brief Reset SoC estimate using a voltage-based method.
+ */
+void resetSocFromVoltage();
+
+/**
+ * @brief Reset SoC estimate using a specific value in percent.
+ */
+void resetSocCustomValue(float soc_percent);
+
+/**
+ * @brief Broadcast SOC related CAN signals.
+ */
+void broadcast();
+
+} // namespace app::soc