Skip to content

Commit

Permalink
Camel case v2.
Browse files Browse the repository at this point in the history
  • Loading branch information
nseidle committed Jan 25, 2024
1 parent 966ef45 commit 0754847
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/github/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Spot something wrong? Feel free to contribute our open-source design and documen
## Improve our Documentation
All of this documentation can be modified by you! Please help us make it better.

* These pages are contained in the [`docs` folder of the SparkFun BlueSMiRF V2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/docs).
* These pages are contained in the [`docs` folder of the SparkFun BlueSMiRF v2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/docs).

### Submit a Correction
1. Fork this repo
Expand All @@ -16,7 +16,7 @@ All of this documentation can be modified by you! Please help us make it better.
## Improve our Hardware Design
All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder of the SparkFun BlueSMiRF V2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/Hardware).
* Our board design files are contained in the [`Hardware` folder of the SparkFun BlueSMiRF v2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/Hardware).

### Submit a Design Improvement
1. Fork this repo
Expand Down
4 changes: 2 additions & 2 deletions docs/github/file_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S

All of this documentation can be modified by you! Please help us make it better.

* The documentation files for these pages are contained in the [`docs` folder of the SparkFun BlueSMiRF V2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/docs).
* The documentation files for these pages are contained in the [`docs` folder of the SparkFun BlueSMiRF v2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/docs).

### Spot something wrong?
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/issues) and let us know.
Expand All @@ -30,7 +30,7 @@ If a section of the documentation is incorrect, please [open an issue](https://g

All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder of the SparkFun BlueSMiRF V2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/Hardware).
* Our board design files are contained in the [`Hardware` folder of the SparkFun BlueSMiRF v2 repository](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/tree/main/Hardware).

### Does something not make sense?
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_BlueSMiRF-v2/issues) and let us know.
Expand Down
12 changes: 6 additions & 6 deletions docs/hardware_hookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ Below is one example between the serial basic breakout (CH340, USB-C) and the Bl



Adding a simple 1x6 stackable header between the jumper wires will make a quick adapter with the M/F jumper wires and USB-to-serial converter. You'll just need to match the DTR and GND pins. This is useful for those that need to constantly configure the BlueSMiRF V2's settings and re-reconnect to a USB-to-serial converter.
Adding a simple 1x6 stackable header between the jumper wires will make a quick adapter with the M/F jumper wires and USB-to-serial converter. You'll just need to match the DTR and GND pins. This is useful for those that need to constantly configure the BlueSMiRF v2's settings and re-reconnect to a USB-to-serial converter.

<div style="text-align: center;">
<table>
Expand Down Expand Up @@ -240,21 +240,21 @@ Remember, for those that are using the PTH version, you will need to solder eith

### BlueSMiRF v2 to Standard Serial UART Port

For boards that already include the footprint for a standard serial UART port, you can connect directly to the pins. You will find these on a few Arduino development boards. The Arduino Pro, Arduino Pro Mini, and LilyPad Arduino 328 Main Board are just a few boards that have the standard port. You will also notice certain boards will have the standard serial UART port labeled as the RTCM Correction Port on SparkFun high precision GNSS breakout boards. For certain boards that have a male header soldered, you may need to consider soldering a 1x6 female header on the BlueSMiRF V2 PTH.
For boards that already include the footprint for a standard serial UART port, you can connect directly to the pins. You will find these on a few Arduino development boards. The Arduino Pro, Arduino Pro Mini, and LilyPad Arduino 328 Main Board are just a few boards that have the standard port. You will also notice certain boards will have the standard serial UART port labeled as the RTCM Correction Port on SparkFun high precision GNSS breakout boards. For certain boards that have a male header soldered, you may need to consider soldering a 1x6 female header on the BlueSMiRF v2 PTH.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/24113-BlueSMiRF_v2_Arduino_Pro_Mini_3V3_Power_Supply.jpg"><img src="../assets/img/24113-BlueSMiRF_v2_Arduino_Pro_Mini_3V3_Power_Supply.jpg" width="600px" height="600px" alt="BlueSMiRF v2 Replacing Serial Connection on the Arduino Pro Mini 3.3V Serial Header Port"></a></td>
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/24113-BlueSMiRF_v2_Arduino_RedBoard_IoT_ESP32_ZED-F9P_RTCM_Correction_Port.jpg"><img src="../assets/img/24113-BlueSMiRF_v2_Arduino_RedBoard_IoT_ESP32_ZED-F9P_RTCM_Correction_Port.jpg" width="600px" height="600px" alt="RedBoard IoT Development Board ESP32 Connected to the ZED-F9P with the BlueSMiRF V2 Connected to the ZED-F9P's RTCM Correction Port"></a></td>
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/24113-BlueSMiRF_V2_High_Precision_GNSS_UM980_RTCM_Correction_Port.jpg"><img src="../assets/img/24113-BlueSMiRF_V2_High_Precision_GNSS_UM980_RTCM_Correction_Port.jpg" width="600px" height="600px" alt="High Precision GNSS UM980 with the BlueSMiRF V2 Connected to the UM980's RTCM Correction Port"></a></td>
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/24113-BlueSMiRF_v2_Arduino_RedBoard_IoT_ESP32_ZED-F9P_RTCM_Correction_Port.jpg"><img src="../assets/img/24113-BlueSMiRF_v2_Arduino_RedBoard_IoT_ESP32_ZED-F9P_RTCM_Correction_Port.jpg" width="600px" height="600px" alt="RedBoard IoT Development Board ESP32 Connected to the ZED-F9P with the BlueSMiRF v2 Connected to the ZED-F9P's RTCM Correction Port"></a></td>
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/24113-BlueSMiRF_V2_High_Precision_GNSS_UM980_RTCM_Correction_Port.jpg"><img src="../assets/img/24113-BlueSMiRF_V2_High_Precision_GNSS_UM980_RTCM_Correction_Port.jpg" width="600px" height="600px" alt="High Precision GNSS UM980 with the BlueSMiRF v2 Connected to the UM980's RTCM Correction Port"></a></td>
</tr>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><i>BlueSMiRF v2 Replacing Serial Connection on the Arduino Pro Mini 3.3V Serial Header Port</i>
</td>
<td style="text-align: center; vertical-align: middle;"><i>BlueSMiRF V2 Connected to the ZED-F9P's RTCM Correction Port</i>
<td style="text-align: center; vertical-align: middle;"><i>BlueSMiRF v2 Connected to the ZED-F9P's RTCM Correction Port</i>
</td>
<td style="text-align: center; vertical-align: middle;"><i>UM980 with the BlueSMiRF V2 Connected to the UM980's RTCM Correction Port</i>
<td style="text-align: center; vertical-align: middle;"><i>UM980 with the BlueSMiRF v2 Connected to the UM980's RTCM Correction Port</i>
</td>

</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/hardware_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ There is also a version with PTHs out in the wild and it is essentially the same

### ESP32-PICO-MINI-02

The board includes the smaller ESP32-PICO-MINI-02 module from Espressif. The SparkFun BlueSMiRF v2 is perfect for short range applications that require point-to-point communication. We've written some firmware to allow serial UART data to be sent between two Bluetooth devices. The supported protocols include SPP and BLE. Testing a pair of BlueSMiRF V2s and we got about ~110 feet (~33m) in the SparkFun building. The TX (10k) and RX (50k) buffers are also very large to allow for radio delays. The included firmware also includes a set of AT commands to configure the ESP32. This includes the baud rate, flow control, LED mode, and Over-The-Air (OTA) updates over a 2.4GHz WiFi network to name a few. You can also manually reprogram the ESP32 module using the command line interface as well! Just make sure to connect Tx and Rx between the BlueSMiRF and a USB-to-serial converter.
The board includes the smaller ESP32-PICO-MINI-02 module from Espressif. The SparkFun BlueSMiRF v2 is perfect for short range applications that require point-to-point communication. We've written some firmware to allow serial UART data to be sent between two Bluetooth devices. The supported protocols include SPP and BLE. Testing a pair of BlueSMiRF v2s and we got about ~110 feet (~33m) in the SparkFun building. The TX (10k) and RX (50k) buffers are also very large to allow for radio delays. The included firmware also includes a set of AT commands to configure the ESP32. This includes the baud rate, flow control, LED mode, and Over-The-Air (OTA) updates over a 2.4GHz WiFi network to name a few. You can also manually reprogram the ESP32 module using the command line interface as well! Just make sure to connect Tx and Rx between the BlueSMiRF and a USB-to-serial converter.

<div style="text-align: center;">
<table>
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ To follow along with this tutorial, you will need the following materials. You m

### Tools &nbsp;_(Optional)_

You will need a soldering iron, solder, and [general soldering accessories](https://www.sparkfun.com/categories/49) for a secure connection when using the plated through holes. You may also need to solder headers or wires to any devices that the BlueSMiRF V2 is connecting to.
You will need a soldering iron, solder, and [general soldering accessories](https://www.sparkfun.com/categories/49) for a secure connection when using the plated through holes. You may also need to solder headers or wires to any devices that the BlueSMiRF v2 is connecting to.

* [Soldering Iron [TOL-14456]](https://www.sparkfun.com/products/14456)
* [Solder Lead Free - 15-gram Tube [TOL-9163]](https://www.sparkfun.com/products/9163)
Expand Down
6 changes: 3 additions & 3 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ Press any key to continue . . .
<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/Error_Programming_BlueSMiRF_ESP32.JPG"><img src="../assets/img/Error_Programming_BlueSMiRF_ESP32.JPG" width="600px" height="600px" alt="Successfully Programmed BlueSMiRF V2 - ESP32"></a></td>
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/Error_Programming_BlueSMiRF_ESP32.JPG"><img src="../assets/img/Error_Programming_BlueSMiRF_ESP32.JPG" width="600px" height="600px" alt="Successfully Programmed BlueSMiRF v2 - ESP32"></a></td>
</tr>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><i>Error Programming BlueSMiRF V2 - ESP32</i></td>
<td style="text-align: center; vertical-align: middle;"><i>Error Programming BlueSMiRF v2 - ESP32</i></td>
</tr>
</table>
</div>

Make sure to:

* ensure that the wires are making connection and not loose
* wired correctly between the USB-to-Serial Converter and your BlueSMiRF V2
* wired correctly between the USB-to-Serial Converter and your BlueSMiRF v2
* COM Port is the same one that the USB-to-Serial converter enumerated to on your computer
* install the appropriate drivers
* in Bootloader Mode
Expand Down

0 comments on commit 0754847

Please sign in to comment.