Skip to content

Commit be66f01

Browse files
committed
Spelling fixes in README
1 parent 672395f commit be66f01

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

libraries/BluetoothSerial/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ There are 3 basic use cases: phone, other ESP32 or any MCU with BT serial module
2525

2626
#### ESP32
2727

28-
You can flash one of the ESP32 with example [`SerialToSerialBTM`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBTM/SerialToSerialBTM.ino) (the Master) and another ESP32 with [`SerialToSerialBT`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino) (the Slave).
29-
Those examples are pre-set to work out-of-the box but they should be scalable to connect multiple Slaves to the Master.
28+
You can flash one of the ESP32 with the example [`SerialToSerialBTM`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBTM/SerialToSerialBTM.ino) (the Master) and another ESP32 with [`SerialToSerialBT`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino) (the Slave).
29+
Those examples are preset to work out-of-the-box but they should be scalable to connect multiple Slaves to the Master.
3030

3131
#### 3rd party Serial BT module
3232

33-
Using 3rd party Serial BT module will require to study the documentation of the particular module in order to make it work, however one side can utilize the mentioned [`SerialToSerialBTM`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBTM/SerialToSerialBTM.ino) (the Master) or [`SerialToSerialBT`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino) (the Slave).
33+
Using 3rd party Serial BT module will require to study the documentation of the particular module in order to make it work, however, one side can utilize the mentioned [`SerialToSerialBTM`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBTM/SerialToSerialBTM.ino) (the Master) or [`SerialToSerialBT`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino) (the Slave).
3434

3535
### Pairing options
3636

@@ -46,12 +46,12 @@ This method will authenticate automatically any attempt to pair and should not b
4646

4747
### With SSP
4848

49-
Usage of SSP provides secure connection. This option is demonstrated in example [`SerialToSerialBT_SSP`](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT_SSP/SerialToSerialBT_SSP.ino)
49+
The usage of SSP provides a secure connection. This option is demonstrated in the example `SerialToSerialBT_SSP``](https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/SerialToSerialBT_SSP/SerialToSerialBT_SSP.ino)
5050

51-
The Secure Simple Pairing is enable by calling method `enableSSP` which has two variants - one is backward compatible without parameter `enableSSP()` and second with parameters `enableSSP(bool inputCapability, bool outputCapability)`.
52-
Alternatively the SSP can be disabled by `disableSSP()`
51+
The Secure Simple Pairing is enabled by calling method `enableSSP` which has two variants - one is backward compatible without parameter `enableSSP()` and second with parameters `enableSSP(bool inputCapability, bool outputCapability)`.
52+
Alternatively, the SSP can be disabled by `disableSSP()`
5353

54-
Both options must be called before `begin()` or if it is called after `begin()` the driver needs to be restart (call `end()` followed by `begin()`) in order to take in effect enabling or disabling the SSP.
54+
Both options must be called before `begin()` or if it is called after `begin()` the driver needs to be restarted (call `end()` followed by `begin()`) in order to take in effect enabling or disabling the SSP.
5555

5656
#### The parameters define the method of authentication:
5757

@@ -61,7 +61,7 @@ Both options must be called before `begin()` or if it is called after `begin()`
6161

6262
* **inputCapability=true and outputCapability=true**
6363
* Both devices display randomly generated code and if they match the user will authenticate pairing on both devices.
64-
* This must be implemented registering callback via `onConfirmRequest()` and in this callback the user will input the response and call `confirmReply(true)` if the authenticated, otherwise call `confirmReply(false)` to reject the pairing.
64+
* This must be implemented by registering a callback via `onConfirmRequest()` and in this callback the user will input the response and call `confirmReply(true)` if the authenticated, otherwise call `confirmReply(false)` to reject the pairing.
6565
* **inputCapability=false and outputCapability=false**
6666
* Only the other device authenticates pairing without any pin.
6767
* **inputCapability=false and outputCapability=true**
@@ -74,5 +74,6 @@ Both options must be called before `begin()` or if it is called after `begin()`
7474

7575
To use Legacy pairing you will have to use [Arduino as an IDF component](https://espressif-docs.readthedocs-hosted.com/projects/arduino-esp32/en/latest/esp-idf_component.html) and disable option `CONFIG_BT_SSP_ENABLED`.
7676
Please refer to the documentation on how to setup Arduino as an IDF component and when you are done, run `idf.py menuconfig` navigate to `Component Config -> Bluetooth -> Bluedroid -> [ ] Secure Simple Pairing` and disable it.
77-
While in the menuconfig you will also need to change partition scheme `Partition Table -> Partition Table -> (X) Single Factory app (large), no OTA`.
78-
After these changes save & quit menuconfig a you are ready to go: `idf.py monitor flash`.
77+
While in the menuconfig you will also need to change the partition scheme `Partition Table -> Partition Table -> (X) Single Factory app (large), no OTA`.
78+
After these changes save & quit menuconfig and you are ready to go: `idf.py monitor flash`.
79+
Please note that to use the PIN in smartphones and computers you need to use characters `SerialBT.setPin("1234", 4);` not a number `SerialBT.setPin(1234, 4);` . Numbers CAN be used if the other side uses them too, but phones and computers use characters.

0 commit comments

Comments
 (0)