Skip to content

Commit cfdf88b

Browse files
author
Cesarbautista10
committed
chore: edit README add initial documentation
1 parent a6b4681 commit cfdf88b

7 files changed

Lines changed: 62 additions & 66 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,42 @@
11

2-
# Development Board Template
2+
# UNIT BME688 Environmental Sensor 4-in-1
3+
4+
<div align="center">
5+
<img src="hardware/resources/unit_top_v_1_0_0_bme688_enviromental_sensor_4_in_1.png" width="450px" alt="Development Board">
6+
<p><em></em></p>
7+
</div>
8+
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.
310

4-
A generic and modular development board based on the [Microcontroller Name], designed for rapid prototyping, embedded systems education, IoT experimentation, and wearable devices. This board combines flexible power options, modern connectivity, and accessible interfaces to accelerate your hardware development.
11+
12+
## 🔍 Key Sensor Features
13+
14+
Enhance your application with the sensor's robust capabilities:
515

616
<div align="center">
7-
<img src="hardware/resources/board_image.png" width="450px" alt="Development Board">
8-
<p><em>[Replace with board name or logo]</em></p>
17+
18+
| Feature | Icon | Description |
19+
|---------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
20+
| Relative Humidity | <img src="hardware/resources/img/clouds.gif" width="50" alt="Relative Humidity Icon"> | Accurately measures ambient moisture for precise environmental monitoring. |
21+
| Barometric Pressure | <img src="hardware/resources/img/rain.png" width="50" alt="Barometric Pressure Icon"> | Detects atmospheric pressure changes to support dynamic weather tracking. |
22+
| Excellent Temperature Stability | <img src="hardware/resources/img/temperature.gif" width="50" alt="Temperature Stability Icon"> | Delivers consistent temperature readings even under varying conditions. |
23+
| Gas Sensing | <img src="hardware/resources/img/gas-leak.gif" width="50" alt="Gas Sensing Icon"> | Monitors a range of gases to help identify potential environmental hazards. |
24+
925
</div>
1026

1127
## 📦 Overview
28+
<div align="center">
1229

13-
| Feature | Description |
14-
|------------------------|---------------------------------------------------------------|
15-
| **Microcontroller** | [ESP32-S3, RP2040, STM32, etc.] |
16-
| **Connectivity** | [Wi-Fi, Bluetooth LE, USB, etc.] |
17-
| **I/O Voltage** | [3.3V / 5V compatible] |
18-
| **Power Options** | [USB-C, LiPo Battery, External Vin] |
19-
| **Programming** | [Arduino IDE, PlatformIO, ESP-IDF, MicroPython, etc.] |
20-
| **Expansion** | [QWIIC, Grove, Header Pins, etc.] |
21-
22-
23-
## ⚙️ Technical Specifications
24-
25-
- **Microcontroller:** [Insert name and variant]
26-
- **Core Architecture:** [Xtensa / ARM Cortex-M / RISC-V]
27-
- **Clock Speed:** [e.g., 240 MHz]
28-
- **Flash / RAM:** [e.g., 8 MB Flash, 2 MB PSRAM]
29-
- **Wireless:** [2.4 GHz Wi-Fi, BLE 5.0]
30-
- **Interfaces:**
31-
- UART / I2C / SPI / PWM
32-
- USB Device or Host (if supported)
33-
- **Power:**
34-
- Input via USB-C: 5V
35-
- Regulated Output: 3.3V
36-
- Battery Support: [Yes / No]
37-
- **Dimensions:** [e.g., 55mm x 25mm]
38-
39-
40-
## 🔌 Pinout
41-
42-
Include a diagram like `docs/pinout.png` or describe functionally:
43-
44-
| Pin Label | Function | Notes |
45-
|-----------|------------------|-----------------------------------|
46-
| D0–D13 | GPIO | Digital I/O |
47-
| A0–A7 | ADC | 12-bit resolution |
48-
| TX / RX | UART | Serial communication |
49-
| SDA / SCL | I2C | Compatible with QWIIC modules |
50-
| MISO / MOSI / SCK / CS | SPI | Display or Flash expansion |
51-
| VCC / GND | Power | 3.3V logic and power distribution |
30+
| Feature | Description |
31+
|-------------------------|----------------------------------|
32+
| Sensor | BME688 Environmental Sensor |
33+
| Communication Protocol | I2C and SPI |
34+
| Power Supply | 1.71V to 3.6V |
5235

53-
## 🧪 Use Cases
36+
</div>
5437

55-
- IoT Sensor Nodes
56-
- Wearable Devices
57-
- Environmental Monitoring
58-
- Educational Electronics
59-
- Automation Prototyping
6038

39+
## 🧪 Use Cases
6140

6241

6342
## 🚀 Getting Started
@@ -67,7 +46,7 @@ Include a diagram like `docs/pinout.png` or describe functionally:
6746
- Arduino IDE
6847
- PlatformIO
6948
- ESP-IDF / Pico SDK
70-
3. **Flash** a sample project or use one from `/firmware/`
49+
3. **Flash** a sample project or use one from `/Software/examples`
7150
4. **Power** via USB or external battery (if supported)
7251

7352

@@ -80,7 +59,6 @@ Include a diagram like `docs/pinout.png` or describe functionally:
8059
- [Getting Started Guide](docs/getting_started.md)
8160

8261

83-
8462
## 📝 License
8563

8664
All hardware and documentation in this project are licensed under the **MIT License**.
@@ -89,14 +67,6 @@ Please refer to [`LICENSE.md`](LICENSE.md) for full terms.
8967

9068

9169
<div align="center">
92-
<sub>Template created by UNIT Electronics • Adapt this file to document your board!</sub>
70+
<sub>Template created by UNIT Electronics </sub>
9371
</div>
9472

95-
### ✅ What You Can Do with This Template:
96-
97-
* Fork it for new development board projects.
98-
* Fill in specs, pinout, and MCU details.
99-
* Add images, schematics, and test code.
100-
101-
102-
Would you like a downloadable `.zip` of this full structure including placeholder images and files (`hardware/`, `docs/`, `firmware/`, etc.)?

‎hardware/README.md‎

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,35 @@
55

66
---
77

8-
## PINOUT
9-
10-
11-
12-
13-
8+
## ⚙️ Technical Specifications
9+
10+
| Parameter | Technical Data |
11+
|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
12+
| Package dimensions | 8-Pin LGA with metal<br>3.0 x 3.0 x 0.93 mm³ |
13+
| Operation range (full accuracy) | Pressure: 300...1100 hPa<br>Humidity: 0…100%<br>Temperature: -40…85°C |
14+
| Supply voltage VDDIO | 1.2 ... 3.6 V |
15+
| Supply voltage VDD | 1.71 ... 3.6 V |
16+
| Interface | I²C and SPI |
17+
| 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) |
18+
| Gas sensor - F1 score for H₂S scanning | 0.94 |
19+
| Gas sensor - Standard scan speed | 10.8 s / scan |
20+
| Gas sensor - Electric charge for standard scan | 0.18 mAh (5 scans ~ 1 min) |
21+
| Gas sensor - Response time (τ 33-63%) | &lt; 1 s (for new sensors) |
22+
| Gas sensor - Sensor-to-sensor deviation | +/- 15% |
23+
| Gas sensor - Power consumption | &lt; 0.1 mA in ultra-low power mode |
24+
| 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) |
25+
| Humidity sensor - Response time (τ0-63%) | 8 s |
26+
| Humidity sensor - Accuracy tolerance | ± 3 % relative humidity |
27+
| Humidity sensor - Hysteresis | ≤ 1.5 % relative humidity |
28+
| Pressure sensor - RMS Noise | 0.12 Pa (equiv. to 1.7 cm) |
29+
| Pressure sensor - Sensitivity Error | ± 0.25 % (equiv. to 1 m at 400 m height change) |
30+
| Pressure sensor - Temperature coefficient offset| ±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change) |
31+
32+
## 🔌 Pinout
33+
34+
35+
36+
| Pin Label | Function | Notes |
37+
|-----------|------------------|-----------------------------------|
38+
| VCC | Power Supply | 3.3V or 5V |
39+
| GND | Ground | Common ground for all components |

‎hardware/resources/img/clouds.gif‎

701 KB
Loading

‎hardware/resources/img/gas-leak.gif‎

451 KB
Loading

‎hardware/resources/img/rain.png‎

30.1 KB
Loading

‎hardware/resources/img/temperature.gif‎

1.12 MB
Loading

‎hardware/resources/unit_top_v_1_0_0_bme688_enviromental_sensor_4_in_1.png‎

162 KB
Loading

0 commit comments

Comments
 (0)