From 966ef45ecfc0d169438735fdd2410742c1e3f20f Mon Sep 17 00:00:00 2001 From: Nathan Seidle Date: Thu, 25 Jan 2024 15:35:59 -0700 Subject: [PATCH] Fix a few typos. --- docs/firmware_update.md | 8 +++----- docs/hardware_overview.md | 18 ++++++------------ docs/introduction.md | 5 ++--- 3 files changed, 11 insertions(+), 20 deletions(-) diff --git a/docs/firmware_update.md b/docs/firmware_update.md index 13ed786..b19ce4b 100644 --- a/docs/firmware_update.md +++ b/docs/firmware_update.md @@ -1,4 +1,4 @@ -From time to time, SparkFun will release new firmware for the BlueSMiRF V2 product line to add and improve functionality. For most users, firmware can be upgraded over a 2.4GHz WiFi network using the [OTA method](firmware_update.md#updating-firmware-over-the-air). Users can also update the firmware manually using a Command Line Interface (CLI) +From time to time, SparkFun will release new firmware for the BlueSMiRF v2 product line to add and improve functionality. For most users, firmware can be upgraded over a 2.4GHz WiFi network using the [OTA method](firmware_update.md#updating-firmware-over-the-air). Users can also update the firmware manually using a Command Line Interface (CLI) @@ -6,8 +6,6 @@ From time to time, SparkFun will release new firmware for the BlueSMiRF V2 produ Once the `AT-WiFiSSID` and `AT-WiFiPassword` settings have been entered for your local WiFi network, the `ATC` command can be issued to check for new firmware. If new firmware is available, send the `ATU` command to begin an update. - - # Manually Updating Firmware Over Serial Because it's much easier to use, we recommend the OTA firmware update process. If that fails for some reason, the following CLI method can be used. @@ -16,7 +14,7 @@ Because it's much easier to use, we recommend the OTA firmware update process. I ### Entering Bootloader Mode -Hold the **PAIR** button while powering the BlueSMiRF V2. This will cause the ESP32 to enter bootloader mode. Once the BlueSMiRF V2 is in bootloader mode, the **STATUS** LED will be dimly lit and the **CONNECT** LED will be off. +Hold the **PAIR** button while powering the BlueSMiRF v2. This will cause the ESP32 to enter bootloader mode. Once the BlueSMiRF v2 is in bootloader mode, the **STATUS** LED will be dimly lit and the **CONNECT** LED will be off. We recommend using a [breadboard](https://www.sparkfun.com/products/12002) or [jumper wires](https://www.sparkfun.com/products/11026) to connect the BlueSMiRF to a [USB-to-Serial](https://www.sparkfun.com/products/15096) connection. At a minimum, you will need to connect the UART pins, power, and ground as stated in the hardware hookup. Remember, the TX and RX connections must be crossed over. @@ -91,7 +89,7 @@ We recommend using a [breadboard](https://www.sparkfun.com/products/12002) or [j !!! note - The connection also includes two additional connection for flow control: RTS and CTS. These two connections are not needed for a basic serial UART connection. However, using all six wires can help make a tighter connection on the 1x6 header. The wire colors also connect TXO-to-RXI and RXI-to-RXO to indicate that it is not a direct connection between the two boards and the 1x6 header. + The connection also includes two additional connection for flow control: RTS and CTS. These two connections are not needed for a basic serial UART connection. However, using all six wires can help make a tighter connection on the 1x6 header. The wire colors also connect TXO-to-RXI and RXI-to-RXO to indicate that it is not a direct connection between the two boards and the 1x6 header.
diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md index a0cf7c6..4496a32 100644 --- a/docs/hardware_overview.md +++ b/docs/hardware_overview.md @@ -115,13 +115,13 @@ The reset PTH labeled as RST will -Both boards include a standard serial UART header seen on many USB-to-serial converters: RTS/RXI/TXO/VCC/CTS/GND . Depending on the version that you receive, one will be PTH while the other is includes right angle male headers. Due to spacing, the PTH version will also have a different silkscreen labels. +Both boards include a standard serial UART header seen on many USB-to-serial converters: RTS/RXI/TXO/VCC/CTS/GND. Depending on the version that you purchase, one will be PTH while the other includes right angle male headers. Due to spacing, the PTH version will also have slightly different silkscreen labels. -* RTS / RT — The Return to Send is an output and is used for hardware flow control in some serial interfaces. Unlike Tx and RX, this pin does not include logic level translation. This output is not critical for simple serial communication. +* RTS / RT — The Ready to Send is an output and is used for hardware flow control in some serial interfaces. This output is not critical for simple serial communication. If flow control is enabled, BlueSMiRF will drive its RTS low if its serial buffer is full (the radio is telling the host system to hold its horses). * **RXI** / **RI** — The serial receive is an input. This input pin receives serial data from another serial device. Logic level circuitry is included on this pin. **It should be connected to the TX of the other device.** * **TXO** / **TO** — The serial transmit is an output. This output pin sends serial data to another device. Logic level circuitry is included on this pin. **It should be connected to the RX of the other device.** * **VCC**/ **V** / **3V3-5V** — This input voltage supply signal is routed through a AP2112K voltage regulator and brought down 3.3V for the ESP32. We will assume that it is attached to another device's standard serial port and it is providing power to the BlueSMiRF v2. As stated earlier, the recommended input voltage is between **3.3V to 5V**. -* CTS / CT — The Clear to Send is an input. CTS is another serial flow control signal. Unlike Tx and RX, this pin does not include logic level translation. Like RTS, it's not required for most, simple serial interfaces. +* CTS / CT — The Clear to Send is an input. CTS is another serial flow control signal. Like RTS, it's not required for most, simple serial interfaces. If flow control is enabled, BlueSMiRF will send data when its CTS pin is driven low (the host system is telling the radio that it's ready for more serial data). * **GND** / **G** — The 0V reference voltage, common to any other device connected to the Bluetooth modem.
@@ -168,18 +168,12 @@ Both boards include a standard serial UART header seen on many USB-to-serial con
- -!!! warning - While the TX and RX pins have logic level circuitry, the CTS and RTS do not. Make sure to be careful when connecting the flow control pins to a 5V system. - - - ### Button The PAIR button is more than meets the eye. This button has more than one function depending on how long it is pushed down. -* **Short Push** — Press and hold the button down between **4 to 8 seconds** will initiate pairing with another Bluetooth device. During that period of time, the **Status** and **Connect** LEDs will slowly blink back and forth. When the BlueSMiRF V2 fails to discover any compatible devices, it will enter _Discoverable_ mode. -* **Long Push** — Press and hold the down for **more than 8 seconds** to set the ESP32 back to its factory default settings. +* **Short Push** — Press and hold the button down between **4 to 8 seconds** will initiate pairing with another Bluetooth device. During that period of time, the **Status** and **Connect** LEDs will slowly blink back and forth. When the BlueSMiRF v2 fails to discover any compatible devices, it will enter _Discoverable_ mode. +* **Long Push** — Press and hold the down for **more than 8 seconds** to set the ESP32 back to its factory default settings.
@@ -190,7 +184,7 @@ The PAIR button is more than meets the eye. This button has more than one functi !!! note - Users can also set the BlueSMiRF v2 in bootloader mode. In this mode, you can update the firmware manually through serial using a command line interface. Users will need to hold down the PAIR button when the BlueSMiRF v2 is not powered. Applying power will set the microcontroller to bootloader mode. + Users can also set the BlueSMiRF v2 in bootloader mode. In this mode, you can update the firmware manually through serial using a command line interface. Users will need to hold down the PAIR button when the BlueSMiRF v2 is not powered. Applying power will put the microcontroller into bootloader mode. For more information about using the button for each mode, check out the section about the [button control](../button/). diff --git a/docs/introduction.md b/docs/introduction.md index dd6e969..d69953b 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,5 +1,5 @@ -The [SparkFun BlueSMiRF v2](https://www.sparkfun.com/products/24113) is a wireless Bluetooth® serial link. This version of the popular BlueSMiRF uses the ESP32. These boards work as a wireless serial UART pipe and are a great wireless replacement for serial cables. Simply pair, connect, and transmit serial data between your TX/RX lines! Any serial stream from 2400 to 115200 baud can be passed seamlessly between two devices. +The [SparkFun BlueSMiRF v2](https://www.sparkfun.com/products/24113) is a wireless Bluetooth® serial link. This version of the popular BlueSMiRF uses the ESP32. These boards work as a wireless serial UART pipe and are a great wireless replacement for serial cables. Simply pair, connect, and transmit serial data between your TX/RX lines! Any serial stream from 2400 to 921600 baud can be passed seamlessly between two devices.
@@ -338,11 +338,10 @@ For those using the PTH version, you will need to connect to the PTHs. You could Depending on your setup or what you are doing, you may need the following as well. -* 2.5GHz WiFi Network for firmware updates +* 2.4GHz WiFi Network for firmware updates * Smartphone with an Internet Service - ### Suggested Reading If you aren’t familiar with the following concepts, we also recommend checking out a few of these tutorials before continuing.