Improve documentation.

mlab-modules · Jul 20, 2024 · 13d50a3 · 13d50a3
1 parent 3fc0501
commit 13d50a3
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -1,36 +1,57 @@
-# MODUL01 - Template to create a new MLAB module
+# LION2CELL02 - Dual-cell Li-Ion BMS with I2C interface and USB-C charging.
 
-MLAB's module template repository. Please [use the "Use this template" button](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) to create a new MLAB module from this repository.
+The LION2CELL02 module is designed for managing the charging and protection of 2-cell Li-Ion battery stack. It incorporates advanced features for safe and efficient battery management, utilizing the BQ40Z50-R2 fuel gauge and BQ25792 battery charger ICs.
 
-The new module repository name must be identical to the proposed new module name. Please look in [MLAB design rules](https://wiki.mlab.cz/doku.php?id=en:rules#identification_of_modules) for an acceptable naming convention.
-After creating the new repository, [rename](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch) the default git branch to be named corresponding to the revision of the module. It is generally adding the "A" suffix to the module name. Therefore, a new repository named MODULENAME01 should have the branch name MODULENAME01A. 
+## Features
 
-Then [clone the new MLAB's module repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your workstation. After that perform the following steps in the cloned repository. 
+### BQ40Z50-R2 - Fuel Gauge
+- Utilizes Impedance Track™ technology for accurate charge measurement.
+- High-side protection N-FETs control.
+- Integrated cell balancing during charging or at rest.
+- Programmable protection features (voltage, current, temperature, charge timeout).
+- JEITA, enhanced charging, and adaptive charging algorithms.
+- Supports TURBO Mode 2.0 and Battery Trip Point (BTP).
+- LED display for battery status.
+- SMBus v1.1 interface for communication with the charger and host systems.
 
-## 1. Initialize the assets submodule, and update it to the latest version
-```bash
-git submodule update --init --remote
-```
+### BQ25792 Battery Charger
+- Supports USB BC 1.2 charging standard.
+- High-efficiency buck-boost charging for Li-Ion batteries.
+- Programmable input current, charge current, and charge voltage.
+- Integrated power path management.
+- Protection features including overvoltage, undervoltage, overcurrent, and thermal protection.
+- Low quiescent current for extended battery life.
 
-## 2. Start the design work 
+## USB-C Connectivity
 
-At that point, you should start to design the new MLAB module project by using the [design tools](https://wiki.mlab.cz/doku.php?id=en:tools).
+The LION2CELL02 module includes dual USB-C connectors for pass-through connection. This allows for easy integration with USB-C power sources and downstream devices.
 
-## 3. Copy the fresh automation workflows
-
-The following command copies up-to-date KiCAD automation workflow to the new MLAB module repository.
-```bash
-cd doc/assets/workflows/
-./copy_workflow_to_repo.sh
-```
+## Power Delivery
 
+The module supports BC 1.2 for standard charging. For USB Power Delivery (PD) support, an external USB PD controller is required. The MLAB [USBPDSINK01](https://www.mlab.cz/module/USBPDSINK01/) module can be used to enable PD functionality.
 
-## 4. Replace this readme
+## Usage Instructions
 
-This readme should be replaced by a description of your new module project! :)
-Please look to the README.md in the root of other modules to get inspiration. 
+1. Equip the LION2CELL02 module with pair of your 16850 Li-Ion batteries.
+2. Connect a USB-C power source to the module. For standard charging, ensure the power source complies with BC 1.2.
+3. For USB PD, connect the USBPDSINK01 module to enable PD negotiation and charging.
+4. Monitor the LED indicators for battery status and health.
 
-Thanks for contributing! 
+## Safety and Protection
 
+- The module includes multiple layers of protection for voltage, current, and temperature to ensure safe operation.
+- Integrated cell balancing ensures equal charging across all cells, preventing overcharge and extending battery life.
 
-
+## Applications
+
+- UPS/battery backup systems
+- Stand-alone measurement devices
+- Scientific equipment
+
+## Additional Resources
+
+For further information, refer to the datasheets:
+- [BQ40Z50-R2 Datasheet](https://www.ti.com/product/BQ40Z50-R2)
+- [BQ25792 Datasheet](https://www.ti.com/product/BQ25792)
+
+---
diff --git a/doc/datasheets/bq25792.pdf b/doc/datasheets/bq25792.pdf
diff --git a/doc/datasheets/bq40z50-r2.pdf b/doc/datasheets/bq40z50-r2.pdf
diff --git a/doc/datasheets/placeholdel b/doc/datasheets/placeholdel
diff --git a/hw/sch_pcb/LION2CELL02.kicad_pcb b/hw/sch_pcb/LION2CELL02.kicad_pcb
@@ -22636,7 +22636,7 @@
 			(xy 179.8828 72.6694) (xy 179.8828 133.1214)
 		)
 		(height -9.7028)
-		(gr_text "60,4520 mm"
+		(gr_text "60.4520 mm"
 			(at 187.7856 102.8954 90)
 			(layer "Dwgs.User")
 			(uuid "656bdd4a-558e-489d-8783-2da8e287c447")
@@ -22669,7 +22669,7 @@
 			(xy 179.8828 72.6694) (xy 179.8828 133.1214)
 		)
 		(height -3.6576)
-		(gr_text "2,3800 in"
+		(gr_text "2.3800 in"
 			(at 181.7404 102.8954 90)
 			(layer "Dwgs.User")
 			(uuid "76325b34-fa9c-452d-be24-91dc81a73259")
@@ -22702,7 +22702,7 @@
 			(xy 179.8828 72.6694) (xy 99.1108 72.6694)
 		)
 		(height 9.8044)
-		(gr_text "80,7720 mm"
+		(gr_text "80.7720 mm"
 			(at 139.4968 61.065 0)
 			(layer "Dwgs.User")
 			(uuid "7c499a5c-70ac-47a0-9293-e7ce6049ffd6")
@@ -22735,7 +22735,7 @@
 			(xy 179.8828 72.6694) (xy 99.1108 72.6694)
 		)
 		(height 4.7244)
-		(gr_text "3,1800 in"
+		(gr_text "3.1800 in"
 			(at 139.4968 66.145 0)
 			(layer "Dwgs.User")
 			(uuid "c041eab0-85c5-4b24-b8f7-787548bc3505")

diff --git a/hw/sch_pcb/fuel_gauge.kicad_sch b/hw/sch_pcb/fuel_gauge.kicad_sch
@@ -4703,17 +4703,6 @@
 		)
 		(uuid "4a18d01c-3e4b-4035-9ae3-ca3fa9db7555")
 	)
-	(label "PS+"
-		(at 95.25 123.19 0)
-		(fields_autoplaced yes)
-		(effects
-			(font
-				(size 1.27 1.27)
-			)
-			(justify left bottom)
-		)
-		(uuid "a438b0ea-d5e8-4e5d-ad16-bb7e4be016e7")
-	)
 	(label "BAT"
 		(at 163.83 93.98 180)
 		(fields_autoplaced yes)
@@ -4736,17 +4725,6 @@
 		)
 		(uuid "eabe4126-5f44-4b93-996c-95d61a4ee94e")
 	)
-	(label "PS-"
-		(at 95.25 115.57 0)
-		(fields_autoplaced yes)
-		(effects
-			(font
-				(size 1.27 1.27)
-			)
-			(justify left bottom)
-		)
-		(uuid "f4b38580-a07c-4d37-95e4-101e36ca37c3")
-	)
 	(hierarchical_label "PACK+"
 		(shape bidirectional)
 		(at 168.91 66.04 0)