Update README.md

Add a diagram of the internal connection.
mlab-modules · Dec 21, 2023 · 1f6441e · 1f6441e
1 parent e5d930c
commit 1f6441e
Showing 1 changed file with 87 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,21 @@ The BATDATUNIT01 is a versatile battery and data module incorporating an ATmea12
 - **USB-C Charging**: Enables hassle-free charging with a modern USB-C interface, ensuring the module is readily powered for sustained use.
 - **Charging and Monitoring Circuits**: The [BQ25628E](https://www.ti.com/product/BQ25628) circuit oversees the charging, while the [BQ34Z100](https://www.ti.com/product/BQ34Z100) gauge monitors the battery state for optimal energy management.
 
+## Applications
+
+The BATDATUNIT01 is designed for versatility:
+
+- As a **power module for semiconductor particle detectors** like the [AIRDOS04](https://github.com/UniversalScientificTechnologies/AIRDOS04), it ensures uninterrupted data acquisition in environmental monitoring.
+- It can be integrated into **remote sensing stations**, where it provides consistent power and data logging capabilities for long-term ecological studies.
+- In **automated weather stations**, the module's resilience and sensor suite offer valuable insights into meteorological conditions.
+- The module can be deployed in **mobile robotics** for energy supply and environmental data collection, aiding navigation and decision-making processes.
+- It is also ideal for **educational purposes**, as a hands-on tool to teach about energy management, data acquisition, and sensor integration.
+
+The robust design and connectivity options make the BATDATUNIT01 a dependable choice for powering and managing data across many scientific applications.
+
+For more detailed information on interfacing and protocols, please refer to the [ATmea1284p datasheet](https://ww1.microchip.com/downloads/en/DeviceDoc/doc8059.pdf) and the communication standards for [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter), [I2C](https://www.i2c-bus.org/), [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface), and [GPIO](https://en.wikipedia.org/wiki/General-purpose_input/output).
+
+
 ## Design
 
 Designed for convenience, the module allows for fast detachment from the measuring part without tools, streamlining the replacement process. Data can be downloaded during battery charging thanks to onboard memory.
@@ -19,21 +34,82 @@ Designed for convenience, the module allows for fast detachment from the measuri
 
 ![BATDATAUNIT01 bottom view](/doc/gen/img/BATDATUNIT01-bottom.svg)
 
-## Connectivity
+### Internal structure
 
-A durable connector brings together data and detection elements with impressive mechanical resilience. It hosts UART, I2C, SPI buses, and extra GPIO signals, providing extensive interfacing options with various systems.
+```mermaid
 
-## Applications
+    flowchart TD
 
-The BATDATUNIT01 is designed for versatility:
+    subgraph a[User interfaceI]
+        USB[[USB-C\nData + power]]
+        UI1([User interface \n Button + battery indicator])
+        UI2([User interface \n Button + 3x LED])
+    
+    end
 
-- As a **power module for semiconductor particle detectors** like the [AIRDOS04](https://github.com/UniversalScientificTechnologies/AIRDOS04), it ensures uninterrupted data acquisition in environmental monitoring.
-- It can be integrated into **remote sensing stations**, where it provides consistent power and data logging capabilities for long-term ecological studies.
-- In **automated weather stations**, the module's resilience and sensor suite offer valuable insights into meteorological conditions.
-- The module can be deployed in **mobile robotics** for energy supply and environmental data collection, aiding navigation and decision-making processes.
-- It is also ideal for **educational purposes**, as a hands-on tool to teach about energy management, data acquisition, and sensor integration.
+    USB --USB --> USW
 
-The robust design and connectivity options make the BATDATUNIT01 a dependable choice for powering and managing data across many scientific applications.
+    FTDI -- I2C --> I2CSW
+    FTDI -- UART <--> MCU
+    MCU -- I2C --> I2CSW[I2C mux]
+    MCU[Microcontroller]
+    MCU --SPI <--> SDW
+    MCU --> SDW
 
-For more detailed information on interfacing and protocols, please refer to the [ATmea1284p datasheet](https://ww1.microchip.com/downloads/en/DeviceDoc/doc8059.pdf) and the communication standards for [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter), [I2C](https://www.i2c-bus.org/), [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface), and [GPIO](https://en.wikipedia.org/wiki/General-purpose_input/output).
+    subgraph one[Memory interface]
+    SDR[SD card] <--> SDI
+    SDI[SD card interface] <--> USW
+    USW[USB-SWITCH]
+    SDW[SD card \n SPI-SWITCH] <--> SDI
+    end
+
+
+    subgraph three[Digital part ]
+    USW -- USB <--> FTDI[FTDI\nI2C + UART]
+
+    I2CSW --I2C--> HYG[Hygrometer]
+    I2CSW --I2C--> ALT[Pressure sensor]
+
+    I2CSW -- I2C --> I2Cen
+
+    end
+
+
+    I2CSW --I2C--> GAUGE
+    I2CSW --I2C--> charger
+
+
+    GAUGE --> UI1
+    MCU --> UI2
+
+    GAUGE --> PWR3v3
+    GAUGE --> PWR3v3E
+    GAUGE --> PWR5vE
+    
+    USW -- USB <--> FTDI[FTDI\nI2C + UART]
+    USB -- Power --> charger
+
+    subgraph two[POWER sources]
+    PWR3v3[Power supply\nfor internal 3.3V]
+    PWR3v3E[Power supply\nfor detector 3.3V]
+    PWR5vE[Power supply\nfor detector 5V]
+    
+    charger --> GAUGE[Accumulators gauge]
+    GAUGE <==> LIION[(5x Li-ion cells)]
+    end
+    PWR3v3 --> MCU
+
+    PWR3v3E --> DI
+    PWR5vE --> DI
+
+    I2Cen[I2C switch] -- I2C --> DI
+    DI[[Detector interface]] == GPIO, SPI <==> MCU
+
+
+
+```
+
+## Connectivity
+
+A durable connector brings together data and detection elements with impressive mechanical resilience. It hosts UART, I2C, SPI buses, and extra GPIO signals, providing extensive interfacing options with various systems.