Skip to content

Commit 163b082

Browse files
committed
Auto-update documentation in docs/
- Built from latest README content - Generated: Wed Nov 12 18:01:34 UTC 2025 - Commit: 357fbf7 - Updated by GitHub Actions workflow
1 parent 357fbf7 commit 163b082

10 files changed

Lines changed: 33 additions & 29 deletions

File tree

docs/hardware/dimensions.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ <h1 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h1>
183183

184184
<nav class="nav-wrapper" aria-label="Page navigation">
185185
<!-- Mobile navigation buttons -->
186-
<a rel="prev" href="../hardware/pinout.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
186+
<a rel="prev" href="../hardware/topology.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
187187
<i class="fa fa-angle-left"></i>
188188
</a>
189189

190-
<a rel="next prefetch" href="../hardware/topology.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
190+
<a rel="next prefetch" href="../software/getting-started.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
191191
<i class="fa fa-angle-right"></i>
192192
</a>
193193

@@ -197,11 +197,11 @@ <h1 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h1>
197197
</div>
198198

199199
<nav class="nav-wide-wrapper" aria-label="Page navigation">
200-
<a rel="prev" href="../hardware/pinout.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
200+
<a rel="prev" href="../hardware/topology.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
201201
<i class="fa fa-angle-left"></i>
202202
</a>
203203

204-
<a rel="next prefetch" href="../hardware/topology.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
204+
<a rel="next prefetch" href="../software/getting-started.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
205205
<i class="fa fa-angle-right"></i>
206206
</a>
207207
</nav>

docs/hardware/overview.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ <h2 id="technical-specifications"><a class="header" href="#technical-specificati
211211
<tr><td>Pressure sensor - RMS Noise</td><td>0.12 Pa (equiv. to 1.7 cm)</td></tr>
212212
<tr><td>Pressure sensor - Sensitivity Error</td><td>± 0.25 % (equiv. to 1 m at 400 m height change)</td></tr>
213213
<tr><td>Pressure sensor - Temperature coefficient offset</td><td>±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change)</td></tr>
214+
<tr><td>I2C Address</td><td>0x77</td></tr>
214215
</tbody></table>
215216
</div>
216217
<h2 id="pinout"><a class="header" href="#pinout">Pinout</a></h2>
@@ -229,10 +230,6 @@ <h3 id="pinout-details"><a class="header" href="#pinout-details"><strong>Pinout
229230
<tr><td>SDO</td><td>SPI data out</td></tr>
230231
</tbody></table>
231232
</div></div>
232-
<h2 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h2>
233-
<div style="text-align: center;">
234-
<div align="center"><a href="../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
235-
</div>
236233
<h2 id="topology"><a class="header" href="#topology">Topology</a></h2>
237234
<div style="text-align: center;">
238235
<div align="center"><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" style="max-width: 500px; height: auto;" alt="Topology"><br/> Topology</a></div>
@@ -247,6 +244,10 @@ <h2 id="topology"><a class="header" href="#topology">Topology</a></h2>
247244
<tr><td>J1</td><td>QWIIC Connector (JST 1 mm pitch) for I2C</td></tr>
248245
</tbody></table>
249246
</div></div>
247+
<h2 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h2>
248+
<div style="text-align: center;">
249+
<div align="center"><a href="../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
250+
</div>
250251
</main>
251252

252253
<nav class="nav-wrapper" aria-label="Page navigation">

docs/hardware/pinout.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h3 id="pinout-details"><a class="header" href="#pinout-details"><strong>Pinout
199199
<i class="fa fa-angle-left"></i>
200200
</a>
201201

202-
<a rel="next prefetch" href="../hardware/dimensions.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
202+
<a rel="next prefetch" href="../hardware/topology.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
203203
<i class="fa fa-angle-right"></i>
204204
</a>
205205

@@ -213,7 +213,7 @@ <h3 id="pinout-details"><a class="header" href="#pinout-details"><strong>Pinout
213213
<i class="fa fa-angle-left"></i>
214214
</a>
215215

216-
<a rel="next prefetch" href="../hardware/dimensions.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
216+
<a rel="next prefetch" href="../hardware/topology.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
217217
<i class="fa fa-angle-right"></i>
218218
</a>
219219
</nav>

docs/hardware/technical-specifications.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ <h1 id="technical-specifications"><a class="header" href="#technical-specificati
196196
<tr><td>Pressure sensor - RMS Noise</td><td>0.12 Pa (equiv. to 1.7 cm)</td></tr>
197197
<tr><td>Pressure sensor - Sensitivity Error</td><td>± 0.25 % (equiv. to 1 m at 400 m height change)</td></tr>
198198
<tr><td>Pressure sensor - Temperature coefficient offset</td><td>±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change)</td></tr>
199+
<tr><td>I2C Address</td><td>0x77</td></tr>
199200
</tbody></table>
200201
</div>
201202
</main>

docs/hardware/topology.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ <h1 id="topology"><a class="header" href="#topology">Topology</a></h1>
193193

194194
<nav class="nav-wrapper" aria-label="Page navigation">
195195
<!-- Mobile navigation buttons -->
196-
<a rel="prev" href="../hardware/dimensions.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
196+
<a rel="prev" href="../hardware/pinout.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
197197
<i class="fa fa-angle-left"></i>
198198
</a>
199199

200-
<a rel="next prefetch" href="../software/getting-started.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
200+
<a rel="next prefetch" href="../hardware/dimensions.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
201201
<i class="fa fa-angle-right"></i>
202202
</a>
203203

@@ -207,11 +207,11 @@ <h1 id="topology"><a class="header" href="#topology">Topology</a></h1>
207207
</div>
208208

209209
<nav class="nav-wide-wrapper" aria-label="Page navigation">
210-
<a rel="prev" href="../hardware/dimensions.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
210+
<a rel="prev" href="../hardware/pinout.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
211211
<i class="fa fa-angle-left"></i>
212212
</a>
213213

214-
<a rel="next prefetch" href="../software/getting-started.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
214+
<a rel="next prefetch" href="../hardware/dimensions.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
215215
<i class="fa fa-angle-right"></i>
216216
</a>
217217
</nav>

docs/print.html

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ <h2 id="technical-specifications"><a class="header" href="#technical-specificati
274274
<tr><td>Pressure sensor - RMS Noise</td><td>0.12 Pa (equiv. to 1.7 cm)</td></tr>
275275
<tr><td>Pressure sensor - Sensitivity Error</td><td>± 0.25 % (equiv. to 1 m at 400 m height change)</td></tr>
276276
<tr><td>Pressure sensor - Temperature coefficient offset</td><td>±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change)</td></tr>
277+
<tr><td>I2C Address</td><td>0x77</td></tr>
277278
</tbody></table>
278279
</div>
279280
<h2 id="pinout"><a class="header" href="#pinout">Pinout</a></h2>
@@ -292,10 +293,6 @@ <h3 id="pinout-details"><a class="header" href="#pinout-details"><strong>Pinout
292293
<tr><td>SDO</td><td>SPI data out</td></tr>
293294
</tbody></table>
294295
</div></div>
295-
<h2 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h2>
296-
<div style="text-align: center;">
297-
<div align="center"><a href="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
298-
</div>
299296
<h2 id="topology"><a class="header" href="#topology">Topology</a></h2>
300297
<div style="text-align: center;">
301298
<div align="center"><a href="hardware/../resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Topology"><br/> Topology</a></div>
@@ -309,7 +306,11 @@ <h2 id="topology"><a class="header" href="#topology">Topology</a></h2>
309306
<tr><td>JP1</td><td>2.54 mm Castellated Holes</td></tr>
310307
<tr><td>J1</td><td>QWIIC Connector (JST 1 mm pitch) for I2C</td></tr>
311308
</tbody></table>
312-
</div></div><div style="break-before: page; page-break-before: always;"></div><h1 id="key-technical-specifications-1"><a class="header" href="#key-technical-specifications-1">Key Technical Specifications</a></h1>
309+
</div></div>
310+
<h2 id="dimensions"><a class="header" href="#dimensions">Dimensions</a></h2>
311+
<div style="text-align: center;">
312+
<div align="center"><a href="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
313+
</div><div style="break-before: page; page-break-before: always;"></div><h1 id="key-technical-specifications-1"><a class="header" href="#key-technical-specifications-1">Key Technical Specifications</a></h1>
313314
<ul>
314315
<li>Operating Voltage: 1.71V to 3.6V</li>
315316
<li>Supply Current: 0.9 µA (sleep), 2.1 µA (ULP), ~920 µA (gas scan)</li>
@@ -341,6 +342,7 @@ <h2 id="topology"><a class="header" href="#topology">Topology</a></h2>
341342
<tr><td>Pressure sensor - RMS Noise</td><td>0.12 Pa (equiv. to 1.7 cm)</td></tr>
342343
<tr><td>Pressure sensor - Sensitivity Error</td><td>± 0.25 % (equiv. to 1 m at 400 m height change)</td></tr>
343344
<tr><td>Pressure sensor - Temperature coefficient offset</td><td>±1.3 Pa/K (equiv. to ±10.9 cm at 1°C temperature change)</td></tr>
345+
<tr><td>I2C Address</td><td>0x77</td></tr>
344346
</tbody></table>
345347
</div><div style="break-before: page; page-break-before: always;"></div><h1 id="pinout-1"><a class="header" href="#pinout-1">Pinout</a></h1>
346348
<div align="center">
@@ -357,10 +359,7 @@ <h3 id="pinout-details-1"><a class="header" href="#pinout-details-1"><strong>Pin
357359
<tr><td>CSB</td><td>Chip select (SPI, active low)</td></tr>
358360
<tr><td>SDO</td><td>SPI data out</td></tr>
359361
</tbody></table>
360-
</div></div><div style="break-before: page; page-break-before: always;"></div><h1 id="dimensions-1"><a class="header" href="#dimensions-1">Dimensions</a></h1>
361-
<div style="text-align: center;">
362-
<div align="center"><a href="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
363-
</div><div style="break-before: page; page-break-before: always;"></div><h1 id="topology-1"><a class="header" href="#topology-1">Topology</a></h1>
362+
</div></div><div style="break-before: page; page-break-before: always;"></div><h1 id="topology-1"><a class="header" href="#topology-1">Topology</a></h1>
364363
<div style="text-align: center;">
365364
<div align="center"><a href="hardware/../resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_topology_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Topology"><br/> Topology</a></div>
366365
</div>
@@ -373,7 +372,10 @@ <h3 id="pinout-details-1"><a class="header" href="#pinout-details-1"><strong>Pin
373372
<tr><td>JP1</td><td>2.54 mm Castellated Holes</td></tr>
374373
<tr><td>J1</td><td>QWIIC Connector (JST 1 mm pitch) for I2C</td></tr>
375374
</tbody></table>
376-
</div></div><div style="break-before: page; page-break-before: always;"></div><h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
375+
</div></div><div style="break-before: page; page-break-before: always;"></div><h1 id="dimensions-1"><a class="header" href="#dimensions-1">Dimensions</a></h1>
376+
<div style="text-align: center;">
377+
<div align="center"><a href="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png"><img src="hardware/../resources/unit_dimension_v_1_0_0_bme688_environmental_sensor_4_in_1.png" style="max-width: 500px; height: auto;" alt="Dimensions"><br/> Dimensions</a></div>
378+
</div><div style="break-before: page; page-break-before: always;"></div><h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
377379
<h2 id="quick-setup-1"><a class="header" href="#quick-setup-1">Quick Setup</a></h2>
378380
<h3 id="1-hardware-connections"><a class="header" href="#1-hardware-connections">1. Hardware Connections</a></h3>
379381
<ul>

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.

docs/software/getting-started.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ <h3 id="2-software-installation"><a class="header" href="#2-software-installatio
191191

192192
<nav class="nav-wrapper" aria-label="Page navigation">
193193
<!-- Mobile navigation buttons -->
194-
<a rel="prev" href="../hardware/topology.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
194+
<a rel="prev" href="../hardware/dimensions.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
195195
<i class="fa fa-angle-left"></i>
196196
</a>
197197

@@ -205,7 +205,7 @@ <h3 id="2-software-installation"><a class="header" href="#2-software-installatio
205205
</div>
206206

207207
<nav class="nav-wide-wrapper" aria-label="Page navigation">
208-
<a rel="prev" href="../hardware/topology.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
208+
<a rel="prev" href="../hardware/dimensions.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
209209
<i class="fa fa-angle-left"></i>
210210
</a>
211211

docs/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<!-- Custom theme stylesheets -->
2828
</head>
2929
<body class="sidebar-iframe-inner">
30-
<ol class="chapter"><li class="chapter-item expanded affix "><a href="introduction.html" target="_parent">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Hardware</li><li class="chapter-item expanded "><a href="hardware/overview.html" target="_parent"><strong aria-hidden="true">1.</strong> Overview</a></li><li class="chapter-item expanded "><a href="hardware/key-technical-specifications.html" target="_parent"><strong aria-hidden="true">2.</strong> Key Technical Specifications</a></li><li class="chapter-item expanded "><a href="hardware/technical-specifications.html" target="_parent"><strong aria-hidden="true">3.</strong> Technical Specifications</a></li><li class="chapter-item expanded "><a href="hardware/pinout.html" target="_parent"><strong aria-hidden="true">4.</strong> Pinout</a></li><li class="chapter-item expanded "><a href="hardware/dimensions.html" target="_parent"><strong aria-hidden="true">5.</strong> Dimensions</a></li><li class="chapter-item expanded "><a href="hardware/topology.html" target="_parent"><strong aria-hidden="true">6.</strong> Topology</a></li><li class="chapter-item expanded affix "><li class="part-title">Software</li><li class="chapter-item expanded "><a href="software/getting-started.html" target="_parent"><strong aria-hidden="true">7.</strong> Getting Started</a></li><li class="chapter-item expanded "><a href="software/examples.html" target="_parent"><strong aria-hidden="true">8.</strong> Examples</a></li><li class="chapter-item expanded affix "><li class="part-title">Resources</li><li class="chapter-item expanded "><a href="resources.html" target="_parent"><strong aria-hidden="true">9.</strong> Datasheet &amp; Documentation</a></li><li class="chapter-item expanded affix "><li class="part-title">Additional Information</li><li class="chapter-item expanded "><a href="license.html" target="_parent"><strong aria-hidden="true">10.</strong> License</a></li></ol>
30+
<ol class="chapter"><li class="chapter-item expanded affix "><a href="introduction.html" target="_parent">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Hardware</li><li class="chapter-item expanded "><a href="hardware/overview.html" target="_parent"><strong aria-hidden="true">1.</strong> Overview</a></li><li class="chapter-item expanded "><a href="hardware/key-technical-specifications.html" target="_parent"><strong aria-hidden="true">2.</strong> Key Technical Specifications</a></li><li class="chapter-item expanded "><a href="hardware/technical-specifications.html" target="_parent"><strong aria-hidden="true">3.</strong> Technical Specifications</a></li><li class="chapter-item expanded "><a href="hardware/pinout.html" target="_parent"><strong aria-hidden="true">4.</strong> Pinout</a></li><li class="chapter-item expanded "><a href="hardware/topology.html" target="_parent"><strong aria-hidden="true">5.</strong> Topology</a></li><li class="chapter-item expanded "><a href="hardware/dimensions.html" target="_parent"><strong aria-hidden="true">6.</strong> Dimensions</a></li><li class="chapter-item expanded affix "><li class="part-title">Software</li><li class="chapter-item expanded "><a href="software/getting-started.html" target="_parent"><strong aria-hidden="true">7.</strong> Getting Started</a></li><li class="chapter-item expanded "><a href="software/examples.html" target="_parent"><strong aria-hidden="true">8.</strong> Examples</a></li><li class="chapter-item expanded affix "><li class="part-title">Resources</li><li class="chapter-item expanded "><a href="resources.html" target="_parent"><strong aria-hidden="true">9.</strong> Datasheet &amp; Documentation</a></li><li class="chapter-item expanded affix "><li class="part-title">Additional Information</li><li class="chapter-item expanded "><a href="license.html" target="_parent"><strong aria-hidden="true">10.</strong> License</a></li></ol>
3131
</body>
3232
<script>
3333
document.addEventListener("DOMContentLoaded", function() {

0 commit comments

Comments
 (0)