Skip to content

Commit a048c8e

Browse files
FeerFloresFeerFlores
committed
chore: update README.md
1 parent e31bfc4 commit a048c8e

6 files changed

Lines changed: 59 additions & 56 deletions

‎hardware/README.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22

33
<div align="center">
44

5-
<a href="./unit_sch_V_0_0_1_ue0095_BME688.pdf"><img src="resources/Schematics_icon.jpg?raw=false" width="500px"><br/> Schematics</a>
5+
<a href="./unit_sch_V_0_0_1_ue0095_BME688.pdf"><img src="resources/Schematics_icon.jpg?raw=false" width="450px"><br/> Schematics</a>
66
</div>
77

88
---
99

1010
## ⚙️ Technical Specifications
1111

12-
| Parameter | Technical Data |
13-
|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| Package dimensions | 8-Pin LGA with metal<br>3.0 x 3.0 x 0.93 mm³ |
15-
| Operation range (full accuracy) | Pressure: 300...1100 hPa<br>Humidity: 0…100%<br>Temperature: -40…85°C |
16-
| Supply voltage VDDIO | 1.2 ... 3.6 V |
17-
| Supply voltage VDD | 1.71 ... 3.6 V |
18-
| Interface | I²C and SPI |
12+
| Parameter | Technical Data |
13+
|-------------------------------------------------|------------------------------------------------------------|
14+
| Package dimensions | 8-Pin LGA with metal<br>3.0 x 3.0 x 0.93 mm³ |
15+
| Operation range (full accuracy) | Pressure: 300...1100 hPa<br>Humidity: 0…100%<br>Temperature: -40…85°C |
16+
| Supply voltage VDDIO | 1.2 ... 3.6 V |
17+
| Supply voltage VDD | 1.71 ... 3.6 V |
18+
| Interface | I²C and SPI |
1919
| Average current consumption | 2.1 µA at 1 Hz humidity and temperature<br>3.1 µA at 1 Hz pressure and temperature<br>3.7 µA at 1 Hz humidity, pressure and temperature<br>90 µA at ULP mode for p/h/T &amp; air quality<br>0.9 mA at LP mode for p/h/T &amp; air quality<br>3.9 mA in standard gas scan mode (gas scan mode &amp; scan rate can be optimized on applications with BME AI studio) |
20-
| Gas sensor - F1 score for H₂S scanning | 0.94 |
21-
| Gas sensor - Standard scan speed | 10.8 s / scan |
22-
| Gas sensor - Electric charge for standard scan | 0.18 mAh (5 scans ~ 1 min) |
23-
| Gas sensor - Response time (τ 33-63%) | &lt; 1 s (for new sensors) |
24-
| Gas sensor - Sensor-to-sensor deviation | +/- 15% |
25-
| Gas sensor - Power consumption | &lt; 0.1 mA in ultra-low power mode |
26-
| Gas sensor - Output data processing | Major direct outputs: Index for Air Quality (IAQ), bVOC-&amp; CO₂-equivalents (ppm), Gas scan result (%) &amp; many more (all listed in datasheet in Table 20: BSEC outputs) |
27-
| Humidity sensor - Response time (τ0-63%) | 8 s |
28-
| Humidity sensor - Accuracy tolerance | ± 3 % relative humidity |
29-
| Humidity sensor - Hysteresis | ≤ 1.5 % relative humidity |
30-
| Pressure sensor - RMS Noise | 0.12 Pa (equiv. to 1.7 cm) |
31-
| Pressure sensor - Sensitivity Error | ± 0.25 % (equiv. to 1 m at 400 m height change) |
32-
| Pressure sensor - Temperature coefficient offset| ±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change) |
20+
| Gas sensor - F1 score for H₂S scanning | 0.94 |
21+
| Gas sensor - Standard scan speed | 10.8 s / scan |
22+
| Gas sensor - Electric charge for standard scan | 0.18 mAh (5 scans ~ 1 min) |
23+
| Gas sensor - Response time (τ 33-63%) | &lt; 1 s (for new sensors) |
24+
| Gas sensor - Sensor-to-sensor deviation | +/- 15% |
25+
| Gas sensor - Power consumption | &lt; 0.1 mA in ultra-low power mode |
26+
| Gas sensor - Output data processing | Major direct outputs: Index for Air Quality (IAQ), bVOC-&amp; CO₂-equivalents (ppm), Gas scan result (%) &amp; many more (all listed in datasheet in Table 20: BSEC outputs) |
27+
| Humidity sensor - Response time (τ0-63%) | 8 s |
28+
| Humidity sensor - Accuracy tolerance | ± 3 % relative humidity |
29+
| Humidity sensor - Hysteresis | ≤ 1.5 % relative humidity |
30+
| Pressure sensor - RMS Noise | 0.12 Pa (equiv. to 1.7 cm) |
31+
| Pressure sensor - Sensitivity Error | ± 0.25 % (equiv. to 1 m at 400 m height change) |
32+
| Pressure sensor - Temperature coefficient offset| ±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change) |
3333

3434
## 🔌 Pinout
3535

3636
<div align="center">
37-
<a href="#"><img src="resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_en.jpg" width="500px"><br/>Pinout</a>
37+
<a href="#"><img src="resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_en.png" width="500px"><br/>Pinout</a>
3838
<br/>
3939
<br/>
4040

‎hardware/resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_en.jpg‎

-1.27 MB
Binary file not shown.

‎hardware/resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_en.png‎

515 KB
Loading

‎hardware/resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_es.jpg‎

-1.29 MB
Binary file not shown.

‎hardware/resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_es.png‎

515 KB
Loading

‎software/documentation/README.md‎

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,86 +14,89 @@ Fill in each section without deleting or modifying the existing headings.
1414

1515
# BME688 Environmental Sensor 4-in-1
1616

17-
![Product](../../hardware/resources/unit_top_v_1_0_0_bme688_enviromental_sensor_4_in_1.png) <!-- FILL HERE: replace image if needed -->
17+
![Product](../../hardware/resources/unit_top_v_1_0_0_bme688_enviromental_sensor_4_in_1.png)
1818

1919
## Introduction
2020

21-
<!-- FILL HERE -->
22-
The **BME688 Environmental Sensor 4-in-1** is a versatile sensor module that combines temperature, humidity, pressure, and gas sensing capabilities in a single compact package.
21+
The BME688 Environmental Sensor 4-in-1 is a versatile sensor module that combines temperature, humidity, pressure, and gas sensing capabilities in a single compact package.
2322

2423
## Functional Description
2524

26-
<!-- FILL HERE -->
2725
- Accurately measures ambient moisture for precise environmental monitoring.
2826
- Detects atmospheric pressure changes to support dynamic weather tracking.
2927
- Delivers consistent temperature readings even under varying conditions.
3028
- Monitors a range of gases to help identify potential environmental hazards.
3129

3230
## Electrical Characteristics & Signal Overview
3331

34-
<!-- FILL HERE -->
35-
- current draw, logic levels, ADC resolution, touchpad sensitivity
3632
- Power supply: 1.71V to 3.6V
37-
-
33+
- Low power consumption: sleep < 0.1 µA, typical operation < 3 µA
34+
3835

3936
## Applications
4037

41-
<!-- FILL HERE -->
42-
- **Environmental Monitoring**: Ideal for tracking air quality, humidity, temperature, and pressure in smart homes and industrial applications.
43-
- **IoT Devices**: Can be integrated into IoT systems for real-time environmental data collection and analysis.
44-
- **Weather Stations**: Useful in DIY weather stations for accurate weather forecasting and monitoring.
45-
- **Smart Agriculture**: Helps in monitoring soil and air conditions to optimize crop growth and yield.
46-
- **Wearable Devices**: Can be used in health and fitness wearables to monitor
38+
- Environmental Monitoring: Ideal for tracking air quality, humidity, temperature, and pressure in smart homes and industrial applications.
39+
- IoT Devices: Can be integrated into IoT systems for real-time environmental data collection and analysis.
40+
- Weather Stations: Useful in DIY weather stations for accurate weather forecasting and monitoring.
41+
- Smart Agriculture: Helps in monitoring soil and air conditions to optimize crop growth and yield.
42+
- Wearable Devices: Can be used in health and fitness wearables to monitor
4743

4844
## Features
4945

50-
<!-- FILL HERE -->
51-
- List of main technical features of the microcontroller and board design
46+
- Temperature measurement: –40 to +85 °C, ±0.5 °C accuracy
47+
- Humidity measurement: 0 to 100 % RH, ±3 % accuracy
48+
- Barometric pressure: 300 to 1100 hPa, ±1 hPa accuracy
49+
- VOC detection: Indoor Air Quality (IAQ) index
50+
- Dual interface: I²C (Qwiic) and SPI
51+
- Compact form factor: Qwiic connector + standard through-hole pins
5252

5353
## Pin & Connector Layout
5454

55-
| Group | Available Pins | Suggested Use |
56-
|-----------|----------------|----------------------------------------|
57-
| GPIO | <!-- FILL --> | <!-- FILL --> |
58-
| UART | <!-- FILL --> | <!-- FILL --> |
59-
| TouchPad | <!-- FILL --> | <!-- FILL --> |
60-
| Analog | <!-- FILL --> | <!-- FILL --> |
61-
| SPI | SCK, SDI, SDO | <!-- FILL --> |
62-
| I²C | QWIIC Connector | <!-- FILL --> |
55+
| Group | Available Pins | Suggested Use |
56+
|-----------|------------------------------------------------|---------------------------------------------------|
57+
| GPIO | – | Not applicable |
58+
| UART | – | Not supported |
59+
| TouchPad | – | Not supported |
60+
| Analog | – | Not supported |
61+
| SPI | CSB, SDI (MOSI), SDO (MISO), SCK | High-speed SPI to read sensor data |
62+
| I²C | SDA, SCL (via Qwiic connector) | Standard I²C for configuration & data acquisition |
6363

6464
## Settings
6565

6666
### Interface Overview
6767

68-
| Interface | Signals / Pins | Typical Use |
69-
|------------|------------------------------|---------------------------|
70-
| UART | <!-- FILL --> | <!-- FILL --> |
71-
| I2C | CSB must be connected to VDD | <!-- FILL --> |
72-
| SPI | CSB must be connected to GND | <!-- FILL --> |
73-
| USB | <!-- FILL --> | <!-- FILL --> |
68+
| Interface | Signals / Pins | Typical Use |
69+
|-----------|-----------------------------------------|--------------------------------------|
70+
| UART | – | Unavailable |
71+
| I²C | SDA, SCL (CSB held high) | Default interface (Qwiic connector) |
72+
| SPI | CSB = GND, SDI (MOSI), SCK, SDO (MISO) | High-speed alternative |
73+
| USB | – | Unavailable on this module |
7474

7575
### Supports
7676

7777
| Symbol | I/O | Description |
7878
|--------|-------------|------------------------------------|
7979
| VCC | Input | 3.3V or 5V |
8080
| GND | GND | Common ground for all components |
81-
| IO | Bidirectional | <!-- FILL --> |
81+
8282

8383
## Block Diagram
8484

85-
![Function Diagram](images/pinout.png) <!-- FILL HERE: replace image if needed -->
85+
![Function diagram](../../hardware/resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_en.png) <!-- FILL HERE: replace image if needed -->
8686

8787
## Dimensions
8888

8989
![Dimensions](../../hardware/resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png) <!-- FILL HERE: replace image if needed -->
9090

9191
## Usage
9292

93-
<!-- FILL HERE -->
94-
Mention supported development platforms and toolchains
93+
This module works with multiple platforms and toolchains:
9594

96-
- (e.g., Arduino IDE, ESP-IDF, PlatformIO, etc.)
95+
- Arduino IDE (Adafruit BME680/BME688 library)
96+
- PlatformIO (Arduino or Espressif frameworks)
97+
- Raspberry Pi / Python (Adafruit CircuitPython-BME680)
98+
- MicroPython (I²C/SPI firmware)
99+
- ESP32 / ESP8266 (Arduino or ESP-IDF)
97100

98101
## Downloads
99102

0 commit comments

Comments
 (0)