From 235e50b555a515e8a5548cf6e18d850f980aed95 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Sat, 27 Jan 2024 01:40:19 -0300 Subject: [PATCH] Fix spelling --- docs/en/api/gpio.rst | 2 +- docs/en/api/touch.rst | 4 ++-- libraries/BLE/src/BLECharacteristic.h | 4 ++-- libraries/ESP32/examples/AnalogOut/LEDCFade/LEDCFade.ino | 4 ++-- .../examples/AnalogOut/LEDCSoftwareFade/LEDCSoftwareFade.ino | 4 ++-- .../examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino | 2 +- libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino | 2 +- .../OnReceiveError_BREAK_Demo/OnReceiveError_BREAK_Demo.ino | 2 +- libraries/ESP_SR/src/esp32-hal-sr.c | 2 +- libraries/Update/examples/SD_Update/SD_Update.ino | 4 ++-- libraries/WiFi/examples/FTM/FTM_Initiator/README.md | 2 +- libraries/WiFi/examples/FTM/FTM_Responder/README.md | 2 +- libraries/WiFi/src/WiFiSTA.cpp | 2 +- 13 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/en/api/gpio.rst b/docs/en/api/gpio.rst index b60c3798e4f..d02146f46e9 100644 --- a/docs/en/api/gpio.rst +++ b/docs/en/api/gpio.rst @@ -51,7 +51,7 @@ The following modes are supported for the basic `input` and `output`: Internal Pullup and Pulldown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ESP32 SoC families supports the internal pullup and pulldown throught a 45kR resistor, that can be enabled when configuring the GPIO mode as ``INPUT`` mode. +The ESP32 SoC families supports the internal pullup and pulldown through a 45kR resistor, that can be enabled when configuring the GPIO mode as ``INPUT`` mode. If the pullup or pulldown mode is not defined, the pin will stay in the high impedance mode. digitalWrite diff --git a/docs/en/api/touch.rst b/docs/en/api/touch.rst index 98cd9cb077f..e7caee6b6d6 100644 --- a/docs/en/api/touch.rst +++ b/docs/en/api/touch.rst @@ -118,7 +118,7 @@ TOUCH API specific for ESP32S2 and ESP32S3 chip (TOUCH_V2) touchInterruptGetLastStatus ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This function is used get the lastest ISR status for the touch pad. +This function is used get the last ISR status for the touch pad. .. code-block:: arduino @@ -139,4 +139,4 @@ A usage example for the touch interrupts. .. literalinclude:: ../../../libraries/ESP32/examples/Touch/TouchInterrupt/TouchInterrupt.ino :language: arduino -More examples can be found in our repository -> `Touch examples `_. \ No newline at end of file +More examples can be found in our repository -> `Touch examples `_. diff --git a/libraries/BLE/src/BLECharacteristic.h b/libraries/BLE/src/BLECharacteristic.h index 3ff9397475d..9cc3274f9c1 100644 --- a/libraries/BLE/src/BLECharacteristic.h +++ b/libraries/BLE/src/BLECharacteristic.h @@ -157,7 +157,7 @@ class BLECharacteristicCallbacks { */ virtual void onRead(BLECharacteristic* pCharacteristic, esp_ble_gatts_cb_param_t* param); /** - * @brief DEPRECATED! Callback function to support a read request. Called only if onRead(,) not overrided. + * @brief DEPRECATED! Callback function to support a read request. Called only if onRead(,) not overridden. * @param [in] pCharacteristic The characteristic that is the source of the event. */ virtual void onRead(BLECharacteristic* pCharacteristic); @@ -169,7 +169,7 @@ class BLECharacteristicCallbacks { */ virtual void onWrite(BLECharacteristic* pCharacteristic, esp_ble_gatts_cb_param_t* param); /** - * @brief DEPRECATED! Callback function to support a write request. Called only if onWrite(,) not overrided. + * @brief DEPRECATED! Callback function to support a write request. Called only if onWrite(,) not overridden. * @param [in] pCharacteristic The characteristic that is the source of the event. */ virtual void onWrite(BLECharacteristic* pCharacteristic); diff --git a/libraries/ESP32/examples/AnalogOut/LEDCFade/LEDCFade.ino b/libraries/ESP32/examples/AnalogOut/LEDCFade/LEDCFade.ino index 002df746014..e24d7a1bbb8 100644 --- a/libraries/ESP32/examples/AnalogOut/LEDCFade/LEDCFade.ino +++ b/libraries/ESP32/examples/AnalogOut/LEDCFade/LEDCFade.ino @@ -6,7 +6,7 @@ CONDITIONS OF ANY KIND, either express or implied. */ -// use 12 bit precission for LEDC timer +// use 12 bit precision for LEDC timer #define LEDC_TIMER_12_BIT 12 // use 5000 Hz as a LEDC base frequency @@ -66,4 +66,4 @@ void loop() { fade_on = true; } } -} \ No newline at end of file +} diff --git a/libraries/ESP32/examples/AnalogOut/LEDCSoftwareFade/LEDCSoftwareFade.ino b/libraries/ESP32/examples/AnalogOut/LEDCSoftwareFade/LEDCSoftwareFade.ino index 239e37f3615..37fc6051501 100644 --- a/libraries/ESP32/examples/AnalogOut/LEDCSoftwareFade/LEDCSoftwareFade.ino +++ b/libraries/ESP32/examples/AnalogOut/LEDCSoftwareFade/LEDCSoftwareFade.ino @@ -10,7 +10,7 @@ This example code is in the public domain. */ -// use 12 bit precission for LEDC timer +// use 12 bit precision for LEDC timer #define LEDC_TIMER_12_BIT 12 // use 5000 Hz as a LEDC base frequency @@ -50,4 +50,4 @@ void loop() { } // wait for 30 milliseconds to see the dimming effect delay(30); -} \ No newline at end of file +} diff --git a/libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino b/libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino index 8a13b77196d..e533c39990e 100644 --- a/libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino +++ b/libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino @@ -61,7 +61,7 @@ void setup(){ We set our ESP32 to wake up for an external trigger. There are two types for ESP32, ext0 and ext1 . ext0 uses RTC_IO to wakeup thus requires RTC peripherals - to be on while ext1 uses RTC Controller so doesnt need + to be on while ext1 uses RTC Controller so doesn't need peripherals to be powered on. Note that using internal pullups/pulldowns also requires RTC peripherals to be turned on. diff --git a/libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino b/libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino index c04a26565a4..afcb3042f79 100644 --- a/libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino +++ b/libraries/ESP32/examples/RMT/RMTCallback/RMTCallback.ino @@ -14,7 +14,7 @@ /** * @brief This example demonstrate how to use a C++ Class to read several GPIO RMT signals - * calling a data processor when data is available in background, using taks. + * calling a data processor when data is available in background, using tasks. * * The output is the last RMT data read in the GPIO, just to illustrate how it works. * diff --git a/libraries/ESP32/examples/Serial/OnReceiveError_BREAK_Demo/OnReceiveError_BREAK_Demo.ino b/libraries/ESP32/examples/Serial/OnReceiveError_BREAK_Demo/OnReceiveError_BREAK_Demo.ino index 7af42153989..9477c0cc50d 100644 --- a/libraries/ESP32/examples/Serial/OnReceiveError_BREAK_Demo/OnReceiveError_BREAK_Demo.ino +++ b/libraries/ESP32/examples/Serial/OnReceiveError_BREAK_Demo/OnReceiveError_BREAK_Demo.ino @@ -30,7 +30,7 @@ In summary, HardwareSerial::onReceiveError() works like an UART Error Notification callback. Errors have priority in the order of the callbacks, therefore, as soon as an error is detected, - the registered callback is executed firt, and only after that, the OnReceive() registered + the registered callback is executed first, and only after that, the OnReceive() registered callback function will be executed. This will give opportunity for the Application to take action before reading data, if necessary. diff --git a/libraries/ESP_SR/src/esp32-hal-sr.c b/libraries/ESP_SR/src/esp32-hal-sr.c index 3c1aae0090d..85cc0080f80 100644 --- a/libraries/ESP_SR/src/esp32-hal-sr.c +++ b/libraries/ESP_SR/src/esp32-hal-sr.c @@ -272,7 +272,7 @@ static void audio_detect_task(void *arg) int sr_command_id = mn_result->command_id[0]; int sr_phrase_id = mn_result->phrase_id[0]; - log_d("Deteted command : %d, phrase: %d", sr_command_id, sr_phrase_id); + log_d("Detected command : %d, phrase: %d", sr_command_id, sr_phrase_id); sr_result_t result = { .wakenet_mode = WAKENET_NO_DETECT, .state = mn_state, diff --git a/libraries/Update/examples/SD_Update/SD_Update.ino b/libraries/Update/examples/SD_Update/SD_Update.ino index a3503e34796..a22b775b6fa 100644 --- a/libraries/Update/examples/SD_Update/SD_Update.ino +++ b/libraries/Update/examples/SD_Update/SD_Update.ino @@ -70,7 +70,7 @@ void updateFromFS(fs::FS &fs) { updateBin.close(); - // whe finished remove the binary from sd card to indicate end of the process + // when finished remove the binary from sd card to indicate end of the process fs.remove("/update.bin"); } else { @@ -109,4 +109,4 @@ void rebootEspWithReason(String reason){ //will not be reached void loop() { -} \ No newline at end of file +} diff --git a/libraries/WiFi/examples/FTM/FTM_Initiator/README.md b/libraries/WiFi/examples/FTM/FTM_Initiator/README.md index bbcf4144390..3558f75d372 100644 --- a/libraries/WiFi/examples/FTM/FTM_Initiator/README.md +++ b/libraries/WiFi/examples/FTM/FTM_Initiator/README.md @@ -1,6 +1,6 @@ # Wi-Fi FTM Initiator Arduino Example -This example demonstrates how to use the Fine Timing Measurement (FTM) to calculate the distace from the Access Point and the device. This is calculated by the Wi-Fi Round Trip Time (Wi-Fi RTT) introduced on the [IEEE Std 802.11-2016](https://en.wikipedia.org/wiki/IEEE_802.11mc) standard. +This example demonstrates how to use the Fine Timing Measurement (FTM) to calculate the distance from the Access Point and the device. This is calculated by the Wi-Fi Round Trip Time (Wi-Fi RTT) introduced on the [IEEE Std 802.11-2016](https://en.wikipedia.org/wiki/IEEE_802.11mc) standard. This example was based on the [ESP-IDF FTM](https://github.com/espressif/esp-idf/tree/master/examples/wifi/ftm). See the README file for more details about on how to use this feature. diff --git a/libraries/WiFi/examples/FTM/FTM_Responder/README.md b/libraries/WiFi/examples/FTM/FTM_Responder/README.md index 5a945916caa..feede0867f3 100644 --- a/libraries/WiFi/examples/FTM/FTM_Responder/README.md +++ b/libraries/WiFi/examples/FTM/FTM_Responder/README.md @@ -1,6 +1,6 @@ # Wi-Fi FTM Responder Arduino Example -This example demonstrates how to use the Fine Timing Measurement (FTM) to calculate the distace from the Access Point and the device. This is calculated by the Wi-Fi Round Trip Time (Wi-Fi RTT) introduced on the [IEEE Std 802.11-2016](https://en.wikipedia.org/wiki/IEEE_802.11mc) standard. +This example demonstrates how to use the Fine Timing Measurement (FTM) to calculate the distance from the Access Point and the device. This is calculated by the Wi-Fi Round Trip Time (Wi-Fi RTT) introduced on the [IEEE Std 802.11-2016](https://en.wikipedia.org/wiki/IEEE_802.11mc) standard. This example will simulate the Router with FTM capability. diff --git a/libraries/WiFi/src/WiFiSTA.cpp b/libraries/WiFi/src/WiFiSTA.cpp index 738e0a019f1..7bb74c88ee0 100644 --- a/libraries/WiFi/src/WiFiSTA.cpp +++ b/libraries/WiFi/src/WiFiSTA.cpp @@ -163,7 +163,7 @@ wl_status_t WiFiSTAClass::status() * @param password const char * Pointer to the password. * @param ca_pem const char* Pointer to a string with the contents of a .pem file with CA cert * @param client_crt const char* Pointer to a string with the contents of a .crt file with client cert - * @param client_key const char* Pointer to a string with the contants of a .key file with client key + * @param client_key const char* Pointer to a string with the contents of a .key file with client key * @param bssid uint8_t[6] Optional. BSSID / MAC of AP * @param channel Optional. Channel of AP * @param connect Optional. call connect