refactor: simplify battery monitoring logic, remove unused fields, and replace BQ34Z100G1 integration with WCH I2C implementation

Software/MainBoard/rust/src/hal/battery.rs

@@ -1,39 +1,30 @@
-use crate::fat_error::{FatError, FatResult};
 use crate::hal::Box;
+use crate::fat_error::{FatError, FatResult};
 use async_trait::async_trait;
-use bq34z100::{Bq34z100g1, Bq34z100g1Driver, Flags};
 use embassy_embedded_hal::shared_bus::blocking::i2c::I2cDevice;
 use embassy_sync::blocking_mutex::raw::CriticalSectionRawMutex;
-use esp_hal::delay::Delay;
 use esp_hal::i2c::master::I2c;
 use esp_hal::Blocking;
-use measurements::Temperature;
+use lib_bms_protocol::{BatteryState as bstate, BmsReadable, Config, FirmwareVersion, ProtocolVersion};
 use serde::Serialize;
 
 #[async_trait(?Send)]
 pub trait BatteryInteraction {
-    async fn state_charge_percent(&mut self) -> FatResult<f32>;
-    async fn remaining_milli_ampere_hour(&mut self) -> FatResult<u16>;
-    async fn max_milli_ampere_hour(&mut self) -> FatResult<u16>;
-    async fn design_milli_ampere_hour(&mut self) -> FatResult<u16>;
-    async fn voltage_milli_volt(&mut self) -> FatResult<u16>;
-    async fn average_current_milli_ampere(&mut self) -> FatResult<i16>;
-    async fn cycle_count(&mut self) -> FatResult<u16>;
-    async fn state_health_percent(&mut self) -> FatResult<u16>;
-    async fn bat_temperature(&mut self) -> FatResult<u16>;
-    async fn get_battery_state(&mut self) -> FatResult<BatteryState>;
+    async fn get_state(&mut self) -> FatResult<BatteryState>;
+    async fn get_firmware(&mut self) -> FatResult<FirmwareVersion>;
+    async fn get_protocol(&mut self) -> FatResult<ProtocolVersion>;
+    async fn reset(&mut self) -> FatResult<()>;
 }
 
 #[derive(Debug, Serialize)]
 pub struct BatteryInfo {
-    pub voltage_milli_volt: u16,
-    pub average_current_milli_ampere: i16,
-    pub cycle_count: u16,
-    pub design_milli_ampere_hour: u16,
-    pub remaining_milli_ampere_hour: u16,
-    pub state_of_charge: f32,
-    pub state_of_health: u16,
-    pub temperature: u16,
+    pub voltage_milli_volt: u32,
+    pub average_current_milli_ampere: i32,
+    pub design_milli_ampere_hour: u32,
+    pub remaining_milli_ampere_hour: u32,
+    pub state_of_charge: u8,
+    pub state_of_health: u32,
+    pub temperature: i32,
 }
 
 #[derive(Debug, Serialize)]
@@ -46,213 +37,62 @@ pub enum BatteryState {
 pub struct NoBatteryMonitor {}
 #[async_trait(?Send)]
 impl BatteryInteraction for NoBatteryMonitor {
-    async fn state_charge_percent(&mut self) -> FatResult<f32> {
-        // No monitor configured: assume full battery for lightstate logic
-        Ok(100.0)
-    }
-
-    async fn remaining_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn max_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn design_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn voltage_milli_volt(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn average_current_milli_ampere(&mut self) -> FatResult<i16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn cycle_count(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn state_health_percent(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn bat_temperature(&mut self) -> FatResult<u16> {
-        Err(FatError::NoBatteryMonitor)
-    }
-
-    async fn get_battery_state(&mut self) -> FatResult<BatteryState> {
+    async fn get_state(&mut self) -> FatResult<BatteryState> {
         Ok(BatteryState::Unknown)
     }
+
+    async fn get_firmware(&mut self) -> FatResult<FirmwareVersion> {
+        Err(FatError::NoBatteryMonitor)
+    }
+
+    async fn get_protocol(&mut self) -> FatResult<ProtocolVersion> {
+        Err(FatError::NoBatteryMonitor)
+    }
+
+    async fn reset(&mut self) -> FatResult<()> {
+        Err(FatError::NoBatteryMonitor)
+    }
 }
 
 //TODO implement this battery monitor kind once controller is complete
 #[allow(dead_code)]
 pub struct WchI2cSlave {}
 
-pub type I2cDev = I2cDevice<'static, CriticalSectionRawMutex, I2c<'static, Blocking>>;
-
-pub struct BQ34Z100G1 {
-    pub battery_driver: Bq34z100g1Driver<I2cDev, Delay>,
+pub struct WCHI2CSlave<'a> {
+    pub(crate) i2c: I2cDevice<'a, CriticalSectionRawMutex, I2c<'a, Blocking>>
 }
 
 #[async_trait(?Send)]
-impl BatteryInteraction for BQ34Z100G1 {
-    async fn state_charge_percent(&mut self) -> FatResult<f32> {
-        self.battery_driver
-            .state_of_charge()
-            .map(|v| v as f32)
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
+impl BatteryInteraction for WCHI2CSlave<'_> {
 
-    async fn remaining_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .remaining_capacity()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
 
-    async fn max_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .full_charge_capacity()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
+    async fn get_state(&mut self) -> FatResult<BatteryState> {
+        let state = bstate::read_from_i2c(&mut self.i2c)?;
+        let config = Config::read_from_i2c(&mut self.i2c)?;
 
-    async fn design_milli_ampere_hour(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .design_capacity()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
+        let state_of_charge = (state.remaining_capacity_mah * 100 / state.lifetime_capacity_mah) as u8;
+        let state_of_health = state.lifetime_capacity_mah / config.capacity_mah * 100;
 
-    async fn voltage_milli_volt(&mut self) -> FatResult<u16> {
-        self.battery_driver.voltage().map_err(|e| FatError::String {
-            error: alloc::format!("{e:?}"),
-        })
-    }
-
-    async fn average_current_milli_ampere(&mut self) -> FatResult<i16> {
-        self.battery_driver
-            .average_current()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
-
-    async fn cycle_count(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .cycle_count()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
-
-    async fn state_health_percent(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .state_of_health()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
-
-    async fn bat_temperature(&mut self) -> FatResult<u16> {
-        self.battery_driver
-            .temperature()
-            .map_err(|e| FatError::String {
-                error: alloc::format!("{e:?}"),
-            })
-    }
-
-    async fn get_battery_state(&mut self) -> FatResult<BatteryState> {
         Ok(BatteryState::Info(BatteryInfo {
-            voltage_milli_volt: self.voltage_milli_volt().await?,
-            average_current_milli_ampere: self.average_current_milli_ampere().await?,
-            cycle_count: self.cycle_count().await?,
-            design_milli_ampere_hour: self.design_milli_ampere_hour().await?,
-            remaining_milli_ampere_hour: self.remaining_milli_ampere_hour().await?,
-            state_of_charge: self.state_charge_percent().await?,
-            state_of_health: self.state_health_percent().await?,
-            temperature: self.bat_temperature().await?,
+            voltage_milli_volt: state.current_mv,
+            average_current_milli_ampere: 1337,
+            design_milli_ampere_hour: config.capacity_mah,
+            remaining_milli_ampere_hour: state.remaining_capacity_mah,
+            state_of_charge,
+            state_of_health,
+            temperature: state.temperature_celcius,
         }))
     }
-}
 
-pub fn print_battery_bq34z100(
-    battery_driver: &mut Bq34z100g1Driver<I2cDevice<CriticalSectionRawMutex, I2c<Blocking>>, Delay>,
-) -> FatResult<()> {
-    log::info!("Try communicating with battery");
-    let fwversion = battery_driver.fw_version().unwrap_or_else(|e| {
-        log::info!("Firmware {e:?}");
-        0
-    });
-    log::info!("fw version is {fwversion}");
-
-    let design_capacity = battery_driver.design_capacity().unwrap_or_else(|e| {
-        log::info!("Design capacity {e:?}");
-        0
-    });
-    log::info!("Design Capacity {design_capacity}");
-    if design_capacity == 1000 {
-        log::info!("Still stock configuring battery, readouts are likely to be wrong!");
+    async fn get_firmware(&mut self) -> FatResult<FirmwareVersion> {
+        todo!()
     }
 
-    let flags = battery_driver.get_flags_decoded().unwrap_or(Flags {
-        fast_charge_allowed: false,
-        full_chage: false,
-        charging_not_allowed: false,
-        charge_inhibit: false,
-        bat_low: false,
-        bat_high: false,
-        over_temp_discharge: false,
-        over_temp_charge: false,
-        discharge: false,
-        state_of_charge_f: false,
-        state_of_charge_1: false,
-        cf: false,
-        ocv_taken: false,
-    });
-    log::info!("Flags {flags:?}");
+    async fn get_protocol(&mut self) -> FatResult<ProtocolVersion> {
+        todo!()
+    }
 
-    let chem_id = battery_driver.chem_id().unwrap_or_else(|e| {
-        log::info!("Chemid {e:?}");
-        0
-    });
-
-    let bat_temp = battery_driver.internal_temperature().unwrap_or_else(|e| {
-        log::info!("Bat Temp {e:?}");
-        0
-    });
-    let temp_c = Temperature::from_kelvin(bat_temp as f64 / 10_f64).as_celsius();
-    let voltage = battery_driver.voltage().unwrap_or_else(|e| {
-        log::info!("Bat volt {e:?}");
-        0
-    });
-    let current = battery_driver.current().unwrap_or_else(|e| {
-        log::info!("Bat current {e:?}");
-        0
-    });
-    let state = battery_driver.state_of_charge().unwrap_or_else(|e| {
-        log::info!("Bat Soc {e:?}");
-        0
-    });
-    let charge_voltage = battery_driver.charge_voltage().unwrap_or_else(|e| {
-        log::info!("Bat Charge Volt {e:?}");
-        0
-    });
-    let charge_current = battery_driver.charge_current().unwrap_or_else(|e| {
-        log::info!("Bat Charge Current {e:?}");
-        0
-    });
-    log::info!("ChemId: {chem_id} Current voltage {voltage} and current {current} with charge {state}% and temp {temp_c} CVolt: {charge_voltage} CCur {charge_current}");
-    let _ = battery_driver.unsealed();
-    let _ = battery_driver.it_enable();
-    Ok(())
-}
+    async fn reset(&mut self) -> FatResult<()> {
+        todo!()
+    }
+}

Software/MainBoard/rust/src/hal/mod.rs

@@ -1,3 +1,4 @@
+use lib_bms_protocol::BmsReadable;
 pub(crate) mod battery;
 // mod can_api; // replaced by external canapi crate
 pub mod esp;
@@ -8,6 +9,7 @@ mod shared_flash;
 mod v4_hal;
 mod water;
 
+use lib_bms_protocol::ProtocolVersion;
 use crate::alloc::string::ToString;
 use crate::hal::rtc::{DS3231Module, RTCModuleInteraction};
 use esp_hal::peripherals::Peripherals;
@@ -50,7 +52,6 @@ use alloc::format;
 use alloc::sync::Arc;
 use async_trait::async_trait;
 use bincode::{Decode, Encode};
-use bq34z100::Bq34z100g1Driver;
 use canapi::SensorSlot;
 use chrono::{DateTime, FixedOffset, Utc};
 use core::cell::RefCell;
@@ -72,7 +73,7 @@ use esp_hal::gpio::{Input, InputConfig, Pull};
 use measurements::{Current, Voltage};
 
 use crate::fat_error::{ContextExt, FatError, FatResult};
-use crate::hal::battery::{print_battery_bq34z100, BQ34Z100G1};
+use crate::hal::battery::{WCHI2CSlave};
 use crate::hal::little_fs2storage_adapter::LittleFs2Filesystem;
 use crate::hal::water::TankSensor;
 use crate::log::LOG_ACCESS;
@@ -485,6 +486,7 @@ impl PlantHal {
 
         let i2c_bus = I2C_DRIVER.get().await;
         let rtc_device = I2cDevice::new(i2c_bus);
+        let mut bms_device = I2cDevice::new(i2c_bus);
         let eeprom_device = I2cDevice::new(i2c_bus);
 
         let mut rtc: Ds323x<
@@ -519,35 +521,18 @@ impl PlantHal {
                 let battery_interaction: Box<dyn BatteryInteraction + Send> =
                     match config.hardware.battery {
                         BatteryBoardVersion::Disabled => Box::new(NoBatteryMonitor {}),
-                        BatteryBoardVersion::BQ34Z100G1 => {
-                            let battery_device = I2cDevice::new(I2C_DRIVER.get().await);
-                            let mut battery_driver = Bq34z100g1Driver {
-                                i2c: battery_device,
-                                delay: Delay::new(),
-                                flash_block_data: [0; 32],
-                            };
-                            let status = print_battery_bq34z100(&mut battery_driver);
-                            match status {
-                                Ok(_) => {}
-                                Err(err) => {
-                                    LOG_ACCESS
-                                        .lock()
-                                        .await
-                                        .log(
-                                            LogMessage::BatteryCommunicationError,
-                                            0u32,
-                                            0,
-                                            "",
-                                            &format!("{err:?})"),
-                                        )
-                                        .await;
-                                }
-                            }
-                            Box::new(BQ34Z100G1 { battery_driver })
-                        }
                         BatteryBoardVersion::WchI2cSlave => {
-                            // TODO use correct implementation once availible
-                            Box::new(NoBatteryMonitor {})
+                            let version = ProtocolVersion::read_from_i2c(&mut bms_device);
+                            let version_val = match version {
+                                Ok(v) => unsafe { core::mem::transmute::<ProtocolVersion, u32>(v) },
+                                Err(_) => 0,
+                            };
+                            if version_val == 1 {
+                                Box::new(WCHI2CSlave { i2c: bms_device })
+                            } else {
+                                //todo should be an error variant instead?
+                                Box::new(NoBatteryMonitor {})
+                            }
                         }
                     };