Skip to content

Commit 7744685

Browse files
committed
chore: update README.md
1 parent 843adba commit 7744685

3 files changed

Lines changed: 46 additions & 25 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

2-
# UNIT BME688 Environmental Sensor 4-in-1
2+
# BME688 Environmental Sensor 4-in-1
33

44
<div align="center">
55
<img src="hardware/resources/unit_top_v_1_0_0_bme688_enviromental_sensor_4_in_1.png" width="450px" alt="Development Board">
66
<p><em></em></p>
77
</div>
88

9-
The **UNIT 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. It utilizes the BME688 sensor from Bosch, which is known for its high accuracy and low power consumption. This module is ideal for applications in environmental monitoring, IoT devices, and smart home systems.
9+
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. It utilizes the BME688 sensor from Bosch, which is known for its high accuracy and low power consumption. This module is ideal for applications in environmental monitoring, IoT devices, and smart home systems.
1010

1111

1212
## 🔍 Key Sensor Features

hardware/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Hardware
22

3+
<div align="center">
34

45
<a href="./unit_sch_V_0_0_1_ue0095_BME688.pdf"><img src="resources/Schematics_icon.jpg?raw=false" width="500px"><br/> Schematics</a>
6+
</div>
57

68
---
79

@@ -31,13 +33,19 @@
3133

3234
## 🔌 Pinout
3335

36+
<div align="center">
37+
<a href="#"><img src="hardware/resources/charger_pinout.jpg" width="500px"><br/>Pinout</a>
38+
<br/>
39+
<br/>
3440

3541

36-
| Pin Label | Function | Notes |
42+
| Pin Label | Function | Notes |
3743
|-----------|------------------|-----------------------------------|
38-
| VCC | Power Supply | 3.3V or 5V |
44+
| VCC | Power Supply | 3.3V or 5V |
3945
| GND | Ground | Common ground for all components |
4046

47+
</div>
48+
4149
## 📏 Dimensions
4250

4351
<div style="text-align: center;">
@@ -49,7 +57,9 @@
4957
<div style="text-align: center;">
5058
<a href="./resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="./resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png" width="500px"><br/> Topology</a>
5159
</div>
52-
60+
<br/>
61+
62+
<div align="center">
5363

5464
| Ref. | Description |
5565
|------|------------------------------------------|
@@ -59,3 +69,4 @@
5969
| JP1 | 2.54 mm Castellated Holes |
6070
| J1 | QWIIC Connector (JST 1 mm pitch) for I2C |
6171

72+
</div>

software/documentation/README.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "Template Development Board"
2+
title: "BME688 Environmental Sensor 4-in-1"
33
version: "1.0"
44
modified: "2025-04-30"
5-
output: "template_development_board"
6-
subtitle: "Generic development board template for documentation"
5+
output: "bme688_environmental_sensor_4-in-1"
6+
subtitle: "Versatile sensor module"
77
---
88

99
<!--
@@ -12,29 +12,38 @@ This file serves as an input to generate a datasheet-style technical PDF.
1212
Fill in each section without deleting or modifying the existing headings.
1313
-->
1414

15-
# Template Development Board
15+
# BME688 Environmental Sensor 4-in-1
1616

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

1919
## Introduction
2020

2121
<!-- FILL HERE -->
22-
Briefly describe the purpose, advantages, and general use of the development board.
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.
2323

2424
## Functional Description
2525

2626
<!-- FILL HERE -->
27-
- Bullet points describing key functional features
27+
- Accurately measures ambient moisture for precise environmental monitoring.
28+
- Detects atmospheric pressure changes to support dynamic weather tracking.
29+
- Delivers consistent temperature readings even under varying conditions.
30+
- Monitors a range of gases to help identify potential environmental hazards.
2831

2932
## Electrical Characteristics & Signal Overview
3033

3134
<!-- FILL HERE -->
32-
- Operating voltage, current draw, logic levels, ADC resolution, touchpad sensitivity
35+
- current draw, logic levels, ADC resolution, touchpad sensitivity
36+
- Power supply: 1.71V to 3.6V
37+
-
3338

3439
## Applications
3540

3641
<!-- FILL HERE -->
37-
- Suggested applications (e.g., IoT, automation, monitoring, etc.)
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
3847

3948
## Features
4049

@@ -49,34 +58,35 @@ Briefly describe the purpose, advantages, and general use of the development boa
4958
| UART | <!-- FILL --> | <!-- FILL --> |
5059
| TouchPad | <!-- FILL --> | <!-- FILL --> |
5160
| Analog | <!-- FILL --> | <!-- FILL --> |
52-
| SPI | <!-- FILL --> | <!-- FILL --> |
61+
| SPI | SCK, SDI, SDO | <!-- FILL --> |
62+
| I²C | QWIIC Connector | <!-- FILL --> |
5363

5464
## Settings
5565

5666
### Interface Overview
5767

58-
| Interface | Signals / Pins | Typical Use |
59-
|------------|------------------------|------------------------------------------|
60-
| UART | <!-- FILL --> | <!-- FILL --> |
61-
| I2C | <!-- FILL --> | <!-- FILL --> |
62-
| SPI | <!-- FILL --> | <!-- FILL --> |
63-
| USB | <!-- FILL --> | <!-- FILL --> |
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 --> |
6474

6575
### Supports
6676

6777
| Symbol | I/O | Description |
6878
|--------|-------------|------------------------------------|
69-
| VCC | Input | <!-- FILL --> |
70-
| GND | GND | <!-- FILL --> |
71-
| IO | Bidirectional | <!-- FILL --> |
79+
| VCC | Input | 3.3V or 5V |
80+
| GND | GND | Common ground for all components |
81+
| IO | Bidirectional | <!-- FILL --> |
7282

7383
## Block Diagram
7484

7585
![Function Diagram](images/pinout.png) <!-- FILL HERE: replace image if needed -->
7686

7787
## Dimensions
7888

79-
![Dimensions](images/dimension.png) <!-- FILL HERE: replace image if needed -->
89+
![Dimensions](../../hardware/resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png) <!-- FILL HERE: replace image if needed -->
8090

8191
## Usage
8292

0 commit comments

Comments
 (0)