Skip to content

Commit 75bd75a

Browse files
committed
Auto-update documentation in docs/
- Built from latest README content - Generated: Thu Oct 2 18:46:30 UTC 2025 - Commit: 566947b - Updated by GitHub Actions workflow
1 parent 566947b commit 75bd75a

4 files changed

Lines changed: 43 additions & 28 deletions

File tree

docs/index.html

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,8 @@ <h3 id="quick-setup"><a class="header" href="#quick-setup">Quick Setup</a></h3>
189189
<a href="https://uelectronics.com/"><div align="center"><img src="https://img.shields.io/badge/Buy%20Now-orange?style=for-the-badge" alt="Buy Now" style="max-width: 80%; height: auto;"></div></a>
190190
<a href="https://unit-electronics-mx.github.io/unit_bme688_environmental_sensor_4_in_1/mdbook/software/getting-started.html"><div align="center"><img src="https://img.shields.io/badge/Getting%20Started-purple?style=for-the-badge" alt="Getting Started" style="max-width: 80%; height: auto;"></div></a></p>
191191
</div>
192-
<h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
192+
<div align="center">
193+
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
193194
<div class="table-wrapper"><table><thead><tr><th>Parameter</th><th>Value/Description</th></tr></thead><tbody>
194195
<tr><td>Operating Voltage</td><td>1.71V to 3.6V</td></tr>
195196
<tr><td>Supply Current</td><td>0.9 µA (sleep), 2.1 µA (ULP), ~920 µA (gas scan)</td></tr>
@@ -200,7 +201,7 @@ <h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
200201
<tr><td>Interfaces</td><td>I²C and SPI (up to 3.4 MHz)</td></tr>
201202
<tr><td>Package Size</td><td>3.0 × 3.0 × 0.93 mm³</td></tr>
202203
</tbody></table>
203-
</div>
204+
</div></div>
204205
<h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h2>
205206
<ul>
206207
<li><strong>Relative Humidity</strong>: Accurately measures ambient moisture for precise environmental monitoring.</li>
@@ -211,21 +212,25 @@ <h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h
211212
<li><strong>Interfaces:</strong> I²C and SPI</li>
212213
<li><strong>Input Voltage via VCC Pin:</strong> 3.6–6.0 V (through onboard voltage regulator)</li>
213214
</ul>
214-
<h2 id="-use-cases"><a class="header" href="#-use-cases">🧪 Use Cases</a></h2>
215+
<h2 id="use-cases"><a class="header" href="#use-cases">Use Cases</a></h2>
215216
<ul>
216217
<li><strong>Environmental Monitoring:</strong> Tracks air quality, humidity, temperature, and pressure in smart homes and industrial settings.</li>
217218
<li><strong>IoT Devices:</strong> Integrates into IoT systems for real-time environmental data collection and analysis.</li>
218219
<li><strong>Weather Stations:</strong> Enables accurate weather forecasting and monitoring in DIY weather station projects.</li>
219220
<li><strong>Smart Agriculture:</strong> Monitors soil and air conditions to optimize crop growth and yield.</li>
220221
<li><strong>Wearable Devices:</strong> Supports health and fitness wearables for environmental parameter monitoring.</li>
221222
</ul>
222-
<h2 id="-resources"><a class="header" href="#-resources">📚 Resources</a></h2>
223+
<h2 id="resources"><a class="header" href="#resources">Resources</a></h2>
223224
<ul>
224-
<li><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></li>
225-
<li><a href="docs/dimensions.dxf"><a href="resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png">Board Dimensions (DXF)</a></li>
226-
<li><a href="docs/pinout.png"><a href="resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_es.png">Pinout Diagram</a></a></li>
227-
<li><a href="firmware/">Firmware Examples</a></li>
228-
<li><a href="docs/getting_started.html">Getting Started Guide</a></li>
225+
<li>
226+
<p><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></p>
227+
</li>
228+
<li>
229+
<p><a href="hardware/pinout.pdf"><a href="resources/hardware/unit_pinout_v_0_0_2_ue0095_bme688_4_in_1_en.pdf">Pinout Diagram</a></a></p>
230+
</li>
231+
<li>
232+
<p><a href="https://www.bosch-sensortec.com/products/environmental-sensors/gas-sensors/bme688/#documents">Datasheet (Compatible with BME688)</a></p>
233+
</li>
229234
</ul>
230235
<h2 id="-license"><a class="header" href="#-license">📝 License</a></h2>
231236
<p>All hardware and documentation in this project are licensed under the <strong>MIT License</strong>.<br />

docs/introduction.html

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,8 @@ <h3 id="quick-setup"><a class="header" href="#quick-setup">Quick Setup</a></h3>
189189
<a href="https://uelectronics.com/"><div align="center"><img src="https://img.shields.io/badge/Buy%20Now-orange?style=for-the-badge" alt="Buy Now" style="max-width: 80%; height: auto;"></div></a>
190190
<a href="https://unit-electronics-mx.github.io/unit_bme688_environmental_sensor_4_in_1/mdbook/software/getting-started.html"><div align="center"><img src="https://img.shields.io/badge/Getting%20Started-purple?style=for-the-badge" alt="Getting Started" style="max-width: 80%; height: auto;"></div></a></p>
191191
</div>
192-
<h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
192+
<div align="center">
193+
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
193194
<div class="table-wrapper"><table><thead><tr><th>Parameter</th><th>Value/Description</th></tr></thead><tbody>
194195
<tr><td>Operating Voltage</td><td>1.71V to 3.6V</td></tr>
195196
<tr><td>Supply Current</td><td>0.9 µA (sleep), 2.1 µA (ULP), ~920 µA (gas scan)</td></tr>
@@ -200,7 +201,7 @@ <h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
200201
<tr><td>Interfaces</td><td>I²C and SPI (up to 3.4 MHz)</td></tr>
201202
<tr><td>Package Size</td><td>3.0 × 3.0 × 0.93 mm³</td></tr>
202203
</tbody></table>
203-
</div>
204+
</div></div>
204205
<h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h2>
205206
<ul>
206207
<li><strong>Relative Humidity</strong>: Accurately measures ambient moisture for precise environmental monitoring.</li>
@@ -211,21 +212,25 @@ <h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h
211212
<li><strong>Interfaces:</strong> I²C and SPI</li>
212213
<li><strong>Input Voltage via VCC Pin:</strong> 3.6–6.0 V (through onboard voltage regulator)</li>
213214
</ul>
214-
<h2 id="-use-cases"><a class="header" href="#-use-cases">🧪 Use Cases</a></h2>
215+
<h2 id="use-cases"><a class="header" href="#use-cases">Use Cases</a></h2>
215216
<ul>
216217
<li><strong>Environmental Monitoring:</strong> Tracks air quality, humidity, temperature, and pressure in smart homes and industrial settings.</li>
217218
<li><strong>IoT Devices:</strong> Integrates into IoT systems for real-time environmental data collection and analysis.</li>
218219
<li><strong>Weather Stations:</strong> Enables accurate weather forecasting and monitoring in DIY weather station projects.</li>
219220
<li><strong>Smart Agriculture:</strong> Monitors soil and air conditions to optimize crop growth and yield.</li>
220221
<li><strong>Wearable Devices:</strong> Supports health and fitness wearables for environmental parameter monitoring.</li>
221222
</ul>
222-
<h2 id="-resources"><a class="header" href="#-resources">📚 Resources</a></h2>
223+
<h2 id="resources"><a class="header" href="#resources">Resources</a></h2>
223224
<ul>
224-
<li><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></li>
225-
<li><a href="docs/dimensions.dxf"><a href="resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png">Board Dimensions (DXF)</a></li>
226-
<li><a href="docs/pinout.png"><a href="resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_es.png">Pinout Diagram</a></a></li>
227-
<li><a href="firmware/">Firmware Examples</a></li>
228-
<li><a href="docs/getting_started.html">Getting Started Guide</a></li>
225+
<li>
226+
<p><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></p>
227+
</li>
228+
<li>
229+
<p><a href="hardware/pinout.pdf"><a href="resources/hardware/unit_pinout_v_0_0_2_ue0095_bme688_4_in_1_en.pdf">Pinout Diagram</a></a></p>
230+
</li>
231+
<li>
232+
<p><a href="https://www.bosch-sensortec.com/products/environmental-sensors/gas-sensors/bme688/#documents">Datasheet (Compatible with BME688)</a></p>
233+
</li>
229234
</ul>
230235
<h2 id="-license"><a class="header" href="#-license">📝 License</a></h2>
231236
<p>All hardware and documentation in this project are licensed under the <strong>MIT License</strong>.<br />

docs/print.html

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,8 @@ <h3 id="quick-setup"><a class="header" href="#quick-setup">Quick Setup</a></h3>
190190
<a href="https://uelectronics.com/"><div align="center"><img src="https://img.shields.io/badge/Buy%20Now-orange?style=for-the-badge" alt="Buy Now" style="max-width: 80%; height: auto;"></div></a>
191191
<a href="https://unit-electronics-mx.github.io/unit_bme688_environmental_sensor_4_in_1/mdbook/software/getting-started.html"><div align="center"><img src="https://img.shields.io/badge/Getting%20Started-purple?style=for-the-badge" alt="Getting Started" style="max-width: 80%; height: auto;"></div></a></p>
192192
</div>
193-
<h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
193+
<div align="center">
194+
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
194195
<div class="table-wrapper"><table><thead><tr><th>Parameter</th><th>Value/Description</th></tr></thead><tbody>
195196
<tr><td>Operating Voltage</td><td>1.71V to 3.6V</td></tr>
196197
<tr><td>Supply Current</td><td>0.9 µA (sleep), 2.1 µA (ULP), ~920 µA (gas scan)</td></tr>
@@ -201,7 +202,7 @@ <h2 id="-overview"><a class="header" href="#-overview">📦 Overview</a></h2>
201202
<tr><td>Interfaces</td><td>I²C and SPI (up to 3.4 MHz)</td></tr>
202203
<tr><td>Package Size</td><td>3.0 × 3.0 × 0.93 mm³</td></tr>
203204
</tbody></table>
204-
</div>
205+
</div></div>
205206
<h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h2>
206207
<ul>
207208
<li><strong>Relative Humidity</strong>: Accurately measures ambient moisture for precise environmental monitoring.</li>
@@ -212,21 +213,25 @@ <h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h
212213
<li><strong>Interfaces:</strong> I²C and SPI</li>
213214
<li><strong>Input Voltage via VCC Pin:</strong> 3.6–6.0 V (through onboard voltage regulator)</li>
214215
</ul>
215-
<h2 id="-use-cases"><a class="header" href="#-use-cases">🧪 Use Cases</a></h2>
216+
<h2 id="use-cases"><a class="header" href="#use-cases">Use Cases</a></h2>
216217
<ul>
217218
<li><strong>Environmental Monitoring:</strong> Tracks air quality, humidity, temperature, and pressure in smart homes and industrial settings.</li>
218219
<li><strong>IoT Devices:</strong> Integrates into IoT systems for real-time environmental data collection and analysis.</li>
219220
<li><strong>Weather Stations:</strong> Enables accurate weather forecasting and monitoring in DIY weather station projects.</li>
220221
<li><strong>Smart Agriculture:</strong> Monitors soil and air conditions to optimize crop growth and yield.</li>
221222
<li><strong>Wearable Devices:</strong> Supports health and fitness wearables for environmental parameter monitoring.</li>
222223
</ul>
223-
<h2 id="-resources"><a class="header" href="#-resources">📚 Resources</a></h2>
224+
<h2 id="resources"><a class="header" href="#resources">Resources</a></h2>
224225
<ul>
225-
<li><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></li>
226-
<li><a href="docs/dimensions.dxf"><a href="resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png">Board Dimensions (DXF)</a></li>
227-
<li><a href="docs/pinout.png"><a href="resources/unit_pinout_v_0_0_1_ue0095_bm3688_4_in_1_es.png">Pinout Diagram</a></a></li>
228-
<li><a href="firmware/">Firmware Examples</a></li>
229-
<li><a href="docs/getting_started.html">Getting Started Guide</a></li>
226+
<li>
227+
<p><a href="hardware/schematic.pdf"><a href="resources/hardware/unit_sch_v_1_0_0_bme688_environmental_sensor_4_in_1.pdf">Schematic Diagram</a></a></p>
228+
</li>
229+
<li>
230+
<p><a href="hardware/pinout.pdf"><a href="resources/hardware/unit_pinout_v_0_0_2_ue0095_bme688_4_in_1_en.pdf">Pinout Diagram</a></a></p>
231+
</li>
232+
<li>
233+
<p><a href="https://www.bosch-sensortec.com/products/environmental-sensors/gas-sensors/bme688/#documents">Datasheet (Compatible with BME688)</a></p>
234+
</li>
230235
</ul>
231236
<h2 id="-license"><a class="header" href="#-license">📝 License</a></h2>
232237
<p>All hardware and documentation in this project are licensed under the <strong>MIT License</strong>.<br />

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)