Fixed no voltage measurement bug. Improved print and LCD display after I2C reconnection.

Author: ArminJo

README.md

@@ -1,23 +1,43 @@
+<div align = center>
+
 # [SMB](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino) - Smart Battery Module (Laptop Battery Pack) Info
-### Version 4.1.0
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-[![Commits since latest](https://img.shields.io/github/commits-since/ArminJo/Smart-Battery-Module-Info_For_Arduino/latest)](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/commits/master)
-[![Build Status](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/workflows/TestCompile/badge.svg)](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/actions)
-![Hit Counter](https://visitor-badge.laobi.icu/badge?page_id=ArminJo_Smart-Battery-Module-Info_For_Arduino)
+Prints SBM controller info.<br/>
+Based on the unmaintained [PackProbe program](https://github.com/PowerCartel/PackProbe) from Power Cartel http://powercartel.com/projects/packprobe/.
 
-Prints SBM controller info
 
-Based on the unmaintained [PackProbe program](https://github.com/PowerCartel/PackProbe) from Power Cartel http://powercartel.com/projects/packprobe/.
+[![Badge License: GPLv3](https://img.shields.io/badge/License-GPLv3-brightgreen.svg)](https://www.gnu.org/licenses/gpl-3.0)
+ &nbsp; &nbsp;
+[![Badge Version](https://img.shields.io/github/v/release/ArminJo/Smart-Battery-Module-Info_For_Arduino?include_prereleases&color=yellow&logo=DocuSign&logoColor=white)](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/releases/latest)
+ &nbsp; &nbsp;
+[![Badge Commits since latest](https://img.shields.io/github/commits-since/ArminJo/Smart-Battery-Module-Info_For_Arduino/latest?color=yellow)](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/commits/master)
+ &nbsp; &nbsp;
+[![Badge Build Status](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/workflows/TestCompile/badge.svg)](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/actions)
+ &nbsp; &nbsp;
+![Badge Hit Counter](https://visitor-badge.laobi.icu/badge?page_id=ArminJo_Smart-Battery-Module-Info_For_Arduino)
+<br/>
+<br/>
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
+
+</div>
+
+#### If you find this program useful, please give it a star.
+
+<br/>
+
 
 # Disclaimer
 **I do not know how to enter full access mode, clear permanent failure or unlock any controller IC.** Unfortunately according to most datasheets, you need an unlock key.
 See also this [article from 2011](https://media.blackhat.com/bh-us-11/Miller/BH_US_11_Miller_Battery_Firmware_Public_WP.pdf).
 Extract: *Macbook batteries ship with a default unseal password (0x36720414).  This was found by reverse engineering a Macbook battery update.  On Macbook batteries, the full access mode password is also hardcoded and default (0xffffffff).* 
 
-## Compile with the Arduino IDE
+<br/>
+
+# Compile with the Arduino IDE
 Download and extract the repository. In the Arduino IDE open the sketch with File -> Open... and select the SBMInfo folder. 
 
-## Identifying the right connection
+<br/>
+
+# Identifying the right connection
 Valuable information about battery pinout can also be found [here](https://www.laptopu.ro/community/laptop-battery-pinout/) or [here](https://powercartel.com/projects/packprobe/battery-connection/).<br/>
 The minimal connector layout is: | GROUND | THERMISTOR (103AT) | CLOCK | DATA | VCC (11 or 14 volt) | (clock and data my be switched).
 - The **thermistor** connection has 10 k&ohm; to ground at 25 degree celsius.
@@ -50,11 +70,15 @@ An example schematic for a SBM module can be found in the datasheet of TI bq2931
 
 ![Simple breadboard setup](pictures/Breadboard.jpg)
 
+<br/>
+
 # Support for automatic discharge and charge
 The charge control pin (9) is high as long as relative charge is below 95%. It can be used to control a NPN transistor, which collector controls a high side P FET.<br/>
 The discharge control pin (10) is high as long as relative charge is above 5% and voltage, if available, is below 3300 mV. It can be used to control a logic level FET directly.<br/>
 The switch off values can be changed [here](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/blob/master/SBMInfo/SBMInfo.ino#L42)
 
+<br/>
+
 # LCD display content
 ### LCD Display before device connected
 1. line: "SBMInfo" | Version |  VCC voltage
@@ -79,18 +103,20 @@ The switch off values can be changed [here](https://github.com/ArminJo/Smart-Bat
 |-|-|
 | ![LCD start](pictures/LCDDisplay_DynamicData.jpg) | ![Dynamic data discharging](pictures/LCDDisplay_DynamicData_Discharging.jpg) |
 
-## German Documentation
+<br/>
+
+# Deutsche Documentation
 Gibt die Daten des SMB Controllers aus.
 Basiert auf https://github.com/PowerCartel/PackProbe von Power Cartel http://powercartel.com/projects/packprobe/. Hier gibt es auch weitere wertvolle Informationen.
 
-## Finden der Anschlüsse.
-In der Version 4.0 ist eine Spannungs und Widerstandsmessung mittels 4 Widerständen integriert, um die I2C Pins zu identifizieren.
-Die Clock und Data Eingänge waren bei meinen Packs die Anschlüsse mit einem Widerstand von ca. 300 k bis 1 M&ohm; nach Masse.
+## Finden der Anschl&uuml;sse.
+In der Version 4.0 ist eine Spannungs und Widerstandsmessung mittels 4 Widerst&auml;nden integriert, um die I2C Pins zu identifizieren.
+Die Clock und Data Eing&auml;nge waren bei meinen Packs die Anschl&uuml;sse mit einem Widerstand von ca. 300 k bis 1 M&ohm; nach Masse.
 Nach dem Booten sucht das Programm nach einem angeschlossenen I2C Device.
-Man kann also alle möglichen Pinkombinationen von Clock und Data am Battery Pack ausprobieren.
-Bei der Richtigen hört das Blinken der Led auf und es kommt sofort die Ausgabe `Found I2C device attached at address: 0x0B` und direkt danach werden die Daten ausgegeben.
+Man kann also alle m&ouml;glichen Pinkombinationen von Clock und Data am Battery Pack ausprobieren.
+Bei der Richtigen h&ouml;rt das Blinken der Led auf und es kommt sofort die Ausgabe `Found I2C device attached at address: 0x0B` und direkt danach werden die Daten ausgegeben.
 
-Bei den Laptop Battery Packs war Plus und Masse immer außen.
+Bei den Laptop Battery Packs war Plus und Masse immer au&szlig;en.
 Wenn mehr als 5 Kontakte vorhanden waren, waren sie wie folgt belegt:
 - Masse und Plus doppelt. z.B. + | + | Thermistor | Data | Clock | - | -
 - Ein Enable (nur im Laptop mit Masse verbunden) und eine Signal Anschluss (nur im Battery Pack mit Masse verbunden). z.B. VCC | VCC | CLOCK | DATA | Signal | Enable | THERMISTOR | GROUND | GROUND |
@@ -99,19 +125,22 @@ Der Thermo-Sensor Anschluss war uneinheitlich, mal nicht messbar beschaltet, mal
 
 Zur Verbindung mit den Kontakten habe ich normales 1,5 qmm Kupferkabel aus der Hausinstallation genommen, dessen eines Ende ich mit einem Hammer etwas plattgeklopft hab. Stecknadeln oder Breadboard Wires gehen auch.
 
-Die Daten werden nur einmalig nach dem Reset ausgegeben, nur die veränderlichen Werte wie Spannung / Strom / Temperatur / Ladung werden alle 3 Sekunden auf Veränderungen gecheckt.
+Die Daten werden nur einmalig nach dem Reset ausgegeben, nur die ver&auml;nderlichen Werte wie Spannung / Strom / Temperatur / Ladung werden alle 3 Sekunden auf Ver&auml;nderungen gecheckt.
 
 Tested with bq20z70, bq20z451, bq2084, bq80201DBT, bq40z50.
 
 Einen Schaltplan zu den Batterie Modulen gibt es im Datenblatt zum TI bq29311 auf Seite 9.
 
-### Sample output:
+<br/>
+
+# Sample output:
 Sample outputs can be found in folder [extras](https://github.com/ArminJo/Smart-Battery-Module-Info_For_Arduino/tree/master/extras).
 
 ```
 START ../src/SBMInfo.cpp
-Version 4.0 from Oct 12 2021
-No LiPo supply detected -> fast display timing
+Version 4.3 from Nov 23 2023
+Configured to set charge control pin 9 to low above 95 %
+Configured to stop discharge control pin 10 to low below 5 % or 3300 mV
 Found attached I2C device at 0xB
 
 Battery mode                        0x6081 | 0b110000010000001
@@ -163,7 +192,11 @@ Battery status                      0xC0 | 0b11000000
                                     80 Initialized
                                     40 Discharging
 
-Pack config and status              0x6B | 0b11010110000
+Pack config and status              0x8230 | 0b1000001000110000
+                                    - Pack not inserted
+                                    - Voltage > EDV2
+                                    - Pack sealed
+                                    - Discharge is qualified for capacity learning
 
 
 *** DYNAMIC NON STANDARD INFO ***
@@ -193,15 +226,21 @@ Minutes remaining until empty       4 h 7 min
 Average minutes remaining until empty: 16 h 11 min
 ```
 
-### Fritzing board
+<br/>
+
+# Fritzing board
 ![Fritzing board](extras/SBMInfo_Steckplatine.png)
-### Fritzing schematics
+# Fritzing schematics
 ![Fritzing schematics](extras/SBMInfo_Schaltplan.png)
 
 # Revision History
+### Version 4.3
+- Fixed no voltage measurement bug.
+- Improved print and LCD display after I2C reconnection.
+
 ### Version 4.2
 - Removed compile time warnings.
- 
+
 ### Version 4.1.0
 - Support for automatic discharge and charge.
 - Improved output.
@@ -214,5 +253,3 @@ Average minutes remaining until empty: 16 h 11 min
 
 ### Version 3.1.1
 - Better prints at scanning.
-
-#### If you find this program useful, please give it a star.

SBMInfo/ADCUtils.h

@@ -112,9 +112,6 @@
 #error "No temperature channel definitions specified for this AVR CPU"
 #endif
 
-extern float sVCCVoltage;
-extern uint16_t sVCCVoltageMillivolt;
-
 extern long sLastVCCCheckMillis;
 extern uint8_t sVCCTooLowCounter;
 
@@ -124,7 +121,6 @@ uint16_t waitAndReadADCChannelWithReference(uint8_t aADCChannelNumber, uint8_t a
 uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t aADCChannelNumber, uint8_t aReference);
 uint16_t readADCChannelWithOversample(uint8_t aADCChannelNumber, uint8_t aOversampleExponent);
 void setADCChannelAndReferenceForNextConversion(uint8_t aADCChannelNumber, uint8_t aReference);
-uint16_t readADCChannelWithReferenceOversample(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent);
 uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent);
 uint16_t readADCChannelWithReferenceMultiSamples(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aNumberOfSamples);
 uint16_t readADCChannelWithReferenceMax(uint8_t aADCChannelNumber, uint8_t aReference, uint16_t aNumberOfSamples);
@@ -139,9 +135,7 @@ uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aADCChannelNumber, ui
  */
 float getVCCVoltageSimple(void);
 void readVCCVoltageSimple(void);
-uint16_t getVCCVoltageMillivoltSimple(void);
 void readVCCVoltageMillivoltSimple(void);
-float getVCCVoltage(void);
 void readVCCVoltage(void);
 uint16_t getVCCVoltageMillivolt(void);
 void readVCCVoltageMillivolt(void);
@@ -163,4 +157,17 @@ bool isVCCTooHigh();
 bool isVCCTooHighSimple();
 
 #endif //  defined(__AVR__) ...
+
+/*
+ * Variables and functions defined as dummies to allow for seamless compiling on non AVR platforms
+ */
+extern float sVCCVoltage;
+extern uint16_t sVCCVoltageMillivolt;
+
+uint16_t readADCChannelWithReferenceOversample(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent);
+
+uint16_t getVCCVoltageMillivoltSimple(void);
+float getVCCVoltage(void);
+float getCPUTemperature(void);
+
 #endif // _ADC_UTILS_H

SBMInfo/ADCUtils.hpp

@@ -481,7 +481,7 @@ void readAndPrintVCCVoltageMillivolt(Print *aSerial) {
 void readVCCVoltageSimple(void) {
     // use AVCC with (optional) external capacitor at AREF pin as reference
     float tVCC = readADCChannelWithReferenceMultiSamples(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4);
-    sVCCVoltage = (1023 * 1.1 * 4) / tVCC;
+    sVCCVoltage = (1023 * (((float) ADC_INTERNAL_REFERENCE_MILLIVOLT) / 1000) * 4) / tVCC;
 }
 
 /*
@@ -688,10 +688,28 @@ float getCPUTemperature(void) {
 #endif
 }
 
-#elif defined(ARDUINO_ARCH_APOLLO3) // defined(ADC_UTILS_ARE_AVAILABLE)
-    void ADCUtilsDummyToAvoidBFDAssertions(){
-        ;
-    }
+#else // defined(ADC_UTILS_ARE_AVAILABLE)
+// Dummy definition of functions defined in ADCUtils to compile examples without errors
+/*
+ * Persistent storage for VCC value
+ */
+float sVCCVoltage;
+uint16_t sVCCVoltageMillivolt;
+
+uint16_t getVCCVoltageMillivoltSimple(void){
+    return 3300;
+}
+
+uint16_t readADCChannelWithReferenceOversample(uint8_t aChannelNumber __attribute__((unused)),
+        uint8_t aReference __attribute__((unused)), uint8_t aOversampleExponent __attribute__((unused))) {
+    return 0;
+}
+float getCPUTemperature() {
+    return 20.0;
+}
+float getVCCVoltage() {
+    return 3.3;
+}
 #endif // defined(ADC_UTILS_ARE_AVAILABLE)
 
 #if defined(LOCAL_DEBUG)