Skip to content

Commit 45e3c02

Browse files
bboyhobboyho
committed
Add quickstart guide
1 parent c304b18 commit 45e3c02

File tree

3 files changed

+109
-0
lines changed

3 files changed

+109
-0
lines changed

‎docs/quickstart.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
Below are the instructions to quickly get started Qwiic Air Quality Sensor with an Arduino! For more in depth information about the sensor and examples, make sure to check out the rest of the tutorial!
2+
3+
1.) Connect a Qwiic cable between the Qwiic Air Quality Sensor and the SparkFun IoT RedBoard - ESP32.
4+
5+
<div style="text-align: center;">
6+
<table>
7+
<tr style="vertical-align:middle;">
8+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Qwiic Air Quality Sensor Connected to SparkFun IoT RedBoard - ESP32"></a></td>
9+
</tr>
10+
<tr style="vertical-align:middle;">
11+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Qwiic Air Quality Sensor Connected to SparkFun IoT RedBoard - ESP32</i></td>
12+
</tr>
13+
</table>
14+
</div>
15+
16+
2.) Connect a USB cable between your computer and the SparkFun IoT RedBoard.
17+
18+
<div style="text-align: center;">
19+
<table>
20+
<tr style="vertical-align:middle;">
21+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="USB Cable to SparkFun IoT RedBoard"></a></td>
22+
</tr>
23+
<tr style="vertical-align:middle;">
24+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>USB Cable to SparkFun IoT RedBoard</i></td>
25+
</tr>
26+
</table>
27+
</div>
28+
29+
3.) Select the board definition (in this case, it was **SparkFun ESP32 IoT RedBoard**).
30+
31+
<div style="text-align: center;">
32+
<table>
33+
<tr style="vertical-align:middle;">
34+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Select Board Definition from Arduino IDE"></a></td>
35+
</tr>
36+
<tr style="vertical-align:middle;">
37+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Select Board Definition from Arduino IDE</i></td>
38+
</tr>
39+
</table>
40+
</div>
41+
42+
4.) Select the COM port (in this case, it was **COM13**).
43+
44+
<div style="text-align: center;">
45+
<table>
46+
<tr style="vertical-align:middle;">
47+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Select COM Port from Arduino IDE"></a></td>
48+
</tr>
49+
<tr style="vertical-align:middle;">
50+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Select COM Port from Arduino IDE</i></td>
51+
</tr>
52+
</table>
53+
</div>
54+
55+
5.) In the Arduino Library Manager, search for the "**SparkFun BMV080**" to install the [SparkFun BMV080 Arduino Library](https://github.com/sparkfun/SparkFun_BMV080_Arduino_Library).
56+
57+
<div style="text-align: center;">
58+
<table>
59+
<tr style="vertical-align:middle;">
60+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Install Arduino Library"></a></td>
61+
</tr>
62+
<tr style="vertical-align:middle;">
63+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Install Arduino Library</i></td>
64+
</tr>
65+
</table>
66+
</div>
67+
68+
6.) Open example 1 through the Arduino IDE's menu: **File** > **Examples** > **SparkFun BMV080 Arduino Library** > **Example_01_BasicReadings**.
69+
70+
<div style="text-align: center;">
71+
<table>
72+
<tr style="vertical-align:middle;">
73+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Open Example 1"></a></td>
74+
</tr>
75+
<tr style="vertical-align:middle;">
76+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Open Example 1</i></td>
77+
</tr>
78+
</table>
79+
</div>
80+
81+
7.) Upload example code.
82+
83+
<div style="text-align: center;">
84+
<table>
85+
<tr style="vertical-align:middle;">
86+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="Upload example code"></a></td>
87+
</tr>
88+
<tr style="vertical-align:middle;">
89+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>Upload example code</i></td>
90+
</tr>
91+
</table>
92+
</div>
93+
94+
8.) Open Arduino Serial Monitor at **115200** to begin detecting particulate matter!
95+
96+
<div style="text-align: center;">
97+
<table>
98+
<tr style="vertical-align:middle;">
99+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
100+
</tr>
101+
<tr style="vertical-align:middle;">
102+
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;"><i>BMV080 Arduino Output</i></td>
103+
</tr>
104+
</table>
105+
</div>

‎docs/single_page.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ hide:
55
icon: fontawesome/solid/scroll
66
---
77

8+
# Quickstart Guide
9+
--8<-- "./docs/quickstart.md"
10+
811
# Introduction
912
--8<-- "./docs/introduction.md"
1013

‎mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ extra_javascript:
256256

257257
# Configures webpage navigation
258258
nav:
259+
- Quickstart Guide: quickstart.md
259260
- Getting Started:
260261
- Introduction: introduction.md
261262
- Hardware Overview: hardware_overview.md

0 commit comments

Comments
 (0)