Skip to content

Commit 6fc6ae9

Browse files
SFEMarkSFEMark
committed
Docs pre-review update
Adding photo assets & screenshots. Edits to most docs files and initial review changes.
1 parent 069b197 commit 6fc6ae9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+313
-575
lines changed

‎docs/arduino_example.md

Whitespace-only changes.

‎docs/assets/3d_model/HMV080_Enclosure_Assembly.zip

1.71 MB
Binary file not shown.

‎docs/assets/component_documentation/bst-bmv080-ds000.pdf

6.33 MB
Binary file not shown.

‎docs/assets/img/6554-BMV-Particulate-Matter-Sensor-Assembly-12.jpg

385 KB
Loading

‎docs/assets/img/6554-BMV-Particulate-Matter-Sensor-Assembly-13.jpg

392 KB
Loading

‎docs/assets/img/6554-BMV-Particulate-Matter-Sensor-Assembly-5.jpg

319 KB
Loading

‎docs/assets/img/BMV080_Annotated.jpg

2.65 MB
Loading

‎docs/assets/img/BMV080_Arduino_Example_01_Screenshot.png

80.7 KB
Loading

‎docs/assets/img/BMV080_Arduino_Example_03_Screenshot.png

69 KB
Loading

‎docs/assets/img/BMV080_Arduino_Example_05_Screenshot.png

93.2 KB
Loading

‎docs/assets/img/BMV080_Arduino_Example_06_Screenshot.png

54.1 KB
Loading

‎docs/assets/img/BMV080_Breakout_Board_Secure.jpg

383 KB
Loading

‎docs/assets/img/BMV080_Breakout_Inserted.jpg

218 KB
Loading

‎docs/assets/img/BMV080_DO_NOT_TOUCH.jpg

2.18 MB
Loading

‎docs/assets/img/BMV080_Inner_Shell_Parts.jpg

121 KB
Loading

‎docs/assets/img/BMV080_Lens_Cover_Removal.jpg

161 KB
Loading

‎docs/assets/img/BMV080_Lens_Cover_Replacement.jpg

198 KB
Loading

‎docs/assets/img/BMV080_Notch_Pressed.jpg

428 KB
Loading

‎docs/assets/img/BMV080_O-Ring_Removal.jpg

150 KB
Loading

‎docs/assets/img/BMV080_O-Ring_Replacement.jpg

193 KB
Loading

‎docs/assets/img/BMV080_Qwiic_Assembly.jpg

521 KB
Loading

‎docs/assets/img/BMV080_Removing_Breakout.jpg

402 KB
Loading

‎docs/assets/img/BMV080_Removing_Outer_Shell.jpg

254 KB
Loading

‎docs/assets/img/BMV080_Replacing_Top_Shell.jpg

317 KB
Loading

‎docs/assets/img/BMV080_SPI_Assembly.jpg

268 KB
Loading

‎docs/assets/img/BMV080_Securing_Outer_Shell.jpg

282 KB
Loading

‎docs/assets/img/BMV080_Unlocking_Enclosure.jpg

363 KB
Loading

‎docs/ex1_basic_readings.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,10 @@ This example shows how to read the BMV080 via Qwiic when the sensor is configure
22

33
Head to the example 1 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_01_BasicReadings**).
44

5-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings. If the air in front of the sensor is void of particulate matter, you should see `0.00` for each size.
5+
If you have not already, select your Board (if you're following along with the suggested dev board for this tutorial, select **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings. If the air in front of the sensor is void of particulate matter, you should see `0.00` for each size.
66

7-
<div style="text-align: center;">
8-
<table>
9-
<tr style="vertical-align:middle;">
10-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
11-
</tr>
12-
</table>
13-
</div>
7+
<center>
8+
[![Screenshot of Example 1 serial printout](./assets/img/BMV080_Arduino_Example_01_Screenshot.png){ width="600"}](./assets/img/BMV080_Arduino_Example_01_Screenshot.png "Click to enlarge")
9+
</center>
1410

15-
Try placing a scented candle or spray some air freshener across the sensor. You should see the sensor readings jump up depending on the PM size.
16-
17-
<div style="text-align: center;">
18-
<table>
19-
<tr style="vertical-align:middle;">
20-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
21-
</tr>
22-
</table>
23-
</div>
24-
25-
When the sensor detects an object in front of the it, the output will indicate that the sensor is `obstructed`."
26-
27-
<div style="text-align: center;">
28-
<table>
29-
<tr style="vertical-align:middle;">
30-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
31-
</tr>
32-
</table>
33-
</div>
11+
Try placing something like a scented candle or other source of particulate matter near the sensor. You should see the sensor readings jump up depending on the PM size. When the sensor detects an object in front of the it, the code prints out `obstructed`.

‎docs/ex2_duty_cycle.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,4 @@ This example shows how to read the BMV080 via Qwiic when the sensor is configure
22

33
Head to the example 2 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_02_DutyCycle**).
44

5-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings every 20 seconds.
6-
7-
<div style="text-align: center;">
8-
<table>
9-
<tr style="vertical-align:middle;">
10-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output Every 20 Seconds"></a></td>
11-
</tr>
12-
</table>
13-
</div>
5+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings every 20 seconds.

‎docs/ex3_interrupt.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,11 @@ This example shows how to read the BMV080 via Qwiic when the sensor is configure
55

66
Head to the example 3 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_03_Interrupt**).
77

8-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings every 20 seconds.
8+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings every 20 seconds.
99

10-
<div style="text-align: center;">
11-
<table>
12-
<tr style="vertical-align:middle;">
13-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output Every 20 Seconds"></a></td>
14-
</tr>
15-
</table>
16-
</div>
10+
<center>
11+
[![Screenshot of Example 3 serial printout](./assets/img/BMV080_Arduino_Example_03_Screenshot.png){ width="600"}](./assets/img/BMV080_Arduino_Example_03_Screenshot.png "Click to enlarge")
12+
</center>
1713

1814
!!! tip
1915
You can view the timestamp of each sensor readings in the Arduino Serial Monitor by clicking on the "Toggle Timestamp" button. This button is represented as a clock above the baud rate.

‎docs/ex4_spi.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,4 @@ This example shows how to read the BMV080 via SPI when the sensor is configured
55

66
Head to the example 4 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_04_SPI**).
77

8-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings.
9-
10-
<div style="text-align: center;">
11-
<table>
12-
<tr style="vertical-align:middle;">
13-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
14-
</tr>
15-
</table>
16-
</div>
8+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings.

‎docs/ex5_parameters.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,11 @@ This example shows how to read and set the parameters of the BMV080 via Qwiic. T
33
Head to the example 5 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_05_Parameters**).
44

55

6-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should output the paraemters before outputting the sensor readings every second.
6+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should output the paraemters before outputting the sensor readings every second.
77

8-
<div style="text-align: center;">
9-
<table>
10-
<tr style="vertical-align:middle;">
11-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
12-
</tr>
13-
</table>
14-
</div>
8+
<center>
9+
[![Screenshot of Example 5 serial printout](./assets/img/BMV080_Arduino_Example_05_Screenshot.png){ width="600"}](./assets/img/BMV080_Arduino_Example_05_Screenshot.png "Click to enlarge")
10+
</center>
1511

1612
!!! note
1713
If you do not see the parameters after uploading, you may not have opened the Arduino Serial Monitor when the Arduino output the parameters. Try restarting your Arduino by hitting the reset button.

‎docs/ex6_two_sensors.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ This example shows how to read two BMV080 via Qwiic when each sensor is configur
55

66
Head to the example 6 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_06_TwoSensors**).
77

8-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings from both BMV080s.
8+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings from both BMV080s.
99

10-
<div style="text-align: center;">
11-
<table>
12-
<tr style="vertical-align:middle;">
13-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
14-
</tr>
15-
</table>
16-
</div>
10+
<center>
11+
[![Screenshot of Example 6 serial printout](./assets/img/BMV080_Arduino_Example_06_Screenshot.png){ width="600"}](./assets/img/BMV080_Arduino_Example_06_Screenshot.png "Click to enlarge")
12+
</center>

‎docs/ex7_alphanumeric.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,4 @@ This example shows how to read the BMV080 via Qwiic when the sensor is configure
22

33
Head to the example 7 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_07_Demo_Alphanumeric**).
44

5-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings through the Arduino Serial Monitor and the Qwiic Alphanumeric display. For simplicity, we will only display PM2.5.
6-
7-
<div style="text-align: center;">
8-
<table>
9-
<tr style="vertical-align:middle;">
10-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
11-
</tr>
12-
</table>
13-
</div>
5+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings through the Arduino Serial Monitor and the Qwiic Alphanumeric display. For simplicity, we will only display PM2.5.

‎docs/ex8_oled.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,5 @@ This example shows how to read the BMV080 via Qwiic when the sensor is configure
22

33
Head to the example 8 from the Arduino IDE's menu (located in **File** **Examples** > **SparkFun BMV080 Arduino Library** > **Example_08_Demo_OLED**).
44

5-
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings through the Arduino Serial Monitor and the Qwiic OLED Display (1.3", 128x64).
5+
If you have not already, select your Board and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. The Arduino should begin outputting the sensor readings through the Arduino Serial Monitor and the Qwiic OLED Display (1.3", 128x64).
66

7-
<div style="text-align: center;">
8-
<table>
9-
<tr style="vertical-align:middle;">
10-
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt="BMV080 Arduino Output"></a></td>
11-
</tr>
12-
</table>
13-
</div>

0 commit comments

Comments
 (0)