From 60fe7b4ca8cdca25366af8a7c0a7b70d32c797f8 Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Sun, 23 May 2021 08:53:04 -0700 Subject: [PATCH] Add code-spell spelling checks to CI (#8067) Help find and fix silly spelling errors as they are added to the repo. --- .github/workflows/pull-request.yml | 15 ++++++++++++++ cores/esp8266/CallBackList.h | 3 +-- cores/esp8266/Esp-frag.cpp | 2 +- cores/esp8266/Esp.h | 4 ++-- cores/esp8266/FSnoop.cpp | 2 +- cores/esp8266/HardwareSerial.h | 4 ++-- cores/esp8266/LwipDhcpServer-NonOS.cpp | 2 +- cores/esp8266/LwipDhcpServer.cpp | 6 +++--- cores/esp8266/Print.h | 2 +- cores/esp8266/Stream.cpp | 2 +- cores/esp8266/Stream.h | 12 +++++------ cores/esp8266/StreamString.h | 2 +- cores/esp8266/Updater.cpp | 2 +- cores/esp8266/Updater.h | 4 ++-- cores/esp8266/core_esp8266_i2s.cpp | 2 +- cores/esp8266/core_esp8266_main.cpp | 2 +- cores/esp8266/core_esp8266_noniso.cpp | 2 +- cores/esp8266/core_esp8266_phy.cpp | 2 +- cores/esp8266/core_esp8266_spi_utils.cpp | 4 ++-- cores/esp8266/core_esp8266_version.h | 3 +-- cores/esp8266/core_esp8266_wiring.cpp | 4 ++-- cores/esp8266/esp8266_peri.h | 16 +++++++-------- cores/esp8266/esp8266_undocumented.h | 2 +- cores/esp8266/exc-sethandler.cpp | 2 +- cores/esp8266/gdb_hooks.h | 18 ++++++++--------- cores/esp8266/heap.cpp | 6 +++--- cores/esp8266/hwdt_app_entry.cpp | 8 ++++---- cores/esp8266/interrupts.h | 2 +- cores/esp8266/mmu_iram.cpp | 2 +- cores/esp8266/mmu_iram.h | 2 +- cores/esp8266/reboot_uart_dwnld.cpp | 4 ++-- cores/esp8266/spiffs/TECH_SPEC | 2 +- cores/esp8266/spiffs/spiffs.h | 4 ++-- cores/esp8266/spiffs/spiffs_nucleus.h | 2 +- cores/esp8266/stdlib_noniso.cpp | 2 +- cores/esp8266/stdlib_noniso.h | 2 +- cores/esp8266/umm_malloc/README.md | 8 ++++---- cores/esp8266/umm_malloc/dbglog/dbglog.h | 2 +- cores/esp8266/umm_malloc/umm_heap_select.h | 2 +- cores/esp8266/umm_malloc/umm_info.c | 2 +- cores/esp8266/umm_malloc/umm_local.c | 2 +- cores/esp8266/umm_malloc/umm_malloc.cpp | 8 ++++---- cores/esp8266/umm_malloc/umm_malloc_cfg.h | 4 ++-- cores/esp8266/xtruntime-frames.h | 2 +- doc/PROGMEM.rst | 4 ++-- doc/Troubleshooting/debugging.rst | 4 ++-- doc/Troubleshooting/stack_dump.rst | 2 +- doc/boards.rst | 4 ++-- doc/eclipse/eclipse.rst | 4 ++-- .../bearssl-server-secure-class.rst | 2 +- doc/esp8266wifi/generic-class.rst | 2 +- doc/filesystem.rst | 2 +- doc/libraries.rst | 2 +- doc/ota_updates/readme.rst | 4 ++-- doc/reference.rst | 2 +- libraries/DNSServer/src/DNSServer.h | 2 +- libraries/ESP8266AVRISP/src/ESP8266AVRISP.cpp | 2 +- .../StreamHttpClient/StreamHttpClient.ino | 2 +- .../StreamHttpsClient/StreamHttpsClient.ino | 2 +- .../src/ESP8266HTTPClient.cpp | 6 +++--- .../ESP8266HTTPClient/src/ESP8266HTTPClient.h | 2 +- .../src/ESP8266HTTPUpdateServer-impl.h | 2 +- libraries/ESP8266LLMNR/ESP8266LLMNR.cpp | 2 +- libraries/ESP8266LLMNR/ESP8266LLMNR.h | 2 +- libraries/ESP8266LLMNR/README.md | 4 ++-- .../LLMNR_Web_Server/LLMNR_Web_Server.ino | 2 +- .../examples/FSBrowser/FSBrowser.ino | 6 +++--- .../ESP8266WebServer/examples/Graph/Graph.ino | 2 +- .../BearSSL_MaxFragmentLength.ino | 2 +- .../BearSSL_Server/BearSSL_Server.ino | 2 +- .../BearSSL_Sessions/BearSSL_Sessions.ino | 2 +- .../examples/HTTPSRequest/HTTPSRequest.ino | 2 +- .../WiFiTelnetToSerial/WiFiTelnetToSerial.ino | 2 +- libraries/ESP8266WiFi/src/BearSSLHelpers.h | 4 ++-- .../ESP8266WiFi/src/ESP8266WiFiMulti.cpp | 2 +- libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp | 2 +- .../src/WiFiClientSecureBearSSL.cpp | 4 ++-- libraries/ESP8266WiFi/src/WiFiServer.h | 2 +- libraries/ESP8266WiFi/src/WiFiUdp.h | 4 ++-- .../src/enable_wifi_at_boot_time.cpp | 4 ++-- .../ESP8266WiFi/src/include/UdpContext.h | 4 ++-- libraries/ESP8266WiFiMesh/README.md | 4 ++-- .../examples/HelloEspnow/HelloEspnow.ino | 4 ++-- .../examples/HelloTcpIp/HelloTcpIp.ino | 2 +- .../src/CompatibilityLayer.cpp | 4 ++-- .../ESP8266WiFiMesh/src/ESP8266WiFiMesh.h | 4 ++-- .../ESP8266WiFiMesh/src/EspnowMeshBackend.h | 10 +++++----- .../ESP8266WiFiMesh/src/EspnowTransmitter.cpp | 4 ++-- .../ESP8266WiFiMesh/src/FloodingMesh.cpp | 2 +- libraries/ESP8266WiFiMesh/src/FloodingMesh.h | 2 +- .../ESP8266WiFiMesh/src/TcpIpMeshBackend.h | 4 ++-- .../ESP8266httpUpdate/src/ESP8266httpUpdate.h | 2 +- .../LEAmDNS/mDNS_Clock/mDNS_Clock.ino | 8 ++++---- .../mDNS_ServiceMonitor.ino | 6 +++--- .../OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino | 6 +++--- libraries/ESP8266mDNS/library.properties | 2 +- libraries/ESP8266mDNS/src/ESP8266mDNS.h | 4 ++-- libraries/ESP8266mDNS/src/LEAmDNS.cpp | 6 +++--- libraries/ESP8266mDNS/src/LEAmDNS.h | 10 +++++----- libraries/ESP8266mDNS/src/LEAmDNS_Control.cpp | 12 +++++------ libraries/ESP8266mDNS/src/LEAmDNS_Helpers.cpp | 6 +++--- libraries/ESP8266mDNS/src/LEAmDNS_Priv.h | 4 ++-- libraries/ESP8266mDNS/src/LEAmDNS_Structs.cpp | 20 +++++++++---------- .../ESP8266mDNS/src/LEAmDNS_Transfer.cpp | 16 +++++++-------- libraries/GDBStub/README.md | 4 ++-- libraries/GDBStub/src/internal/gdbstub.c | 2 +- libraries/LittleFS/src/lfs.c | 2 +- libraries/Netdump/library.properties | 2 +- libraries/SD/src/SD.h | 2 +- libraries/Servo/src/Servo.cpp | 4 ++-- libraries/Servo/src/Servo.h | 2 +- .../examples/paint/paint.ino | 2 +- .../examples/tftbmp/tftbmp.ino | 6 +++--- .../examples/tftbmp2/tftbmp2.ino | 8 ++++---- .../TickerParameter/TickerParameter.ino | 2 +- .../examples/CheckFlashCRC/CheckFlashCRC.ino | 2 +- .../examples/HwdtStackDump/HwdtStackDump.ino | 2 +- .../examples/HwdtStackDump/ProcessKey.ino | 2 +- .../examples/IramReserve/ProcessKey.ino | 2 +- .../examples/NTP-TZ-DST/NTP-TZ-DST.ino | 4 ++-- .../examples/StreamString/StreamString.ino | 4 ++-- .../lwIP_enc28j60/src/utility/enc28j60.h | 2 +- libraries/lwIP_w5100/src/utility/w5100.h | 2 +- libraries/lwIP_w5500/src/utility/w5500.h | 4 ++-- platform.txt | 4 ++-- tests/device/test_libc/memcpy-1.c | 2 +- tests/device/test_libc/strcmp-1.c | 2 +- .../device/test_millis_mm/test_millis_mm.ino | 18 ++++++++--------- tests/host/README.txt | 2 +- tests/host/common/catch.hpp | 4 ++-- tests/host/fs/test_fs.inc | 2 +- tools/boards.txt.py | 6 +++--- variants/wifi_slot/analogRead.cpp | 2 +- 133 files changed, 273 insertions(+), 260 deletions(-) diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index 4fa5c200ac..7a8f7beb34 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -269,3 +269,18 @@ jobs: bash ./tests/ci/build_boards.sh bash ./tests/ci/eboot_test.sh bash ./tests/ci/pkgrefs_test.sh + + +# Validate orthography + code-spell: + name: Check spelling + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + submodules: true + - name: Run codespell + uses: codespell-project/actions-codespell@master + with: + skip: ./libraries/ESP8266SdFat,./libraries/LittleFS/lib,./tools/pyserial,./tools/sdk,./tools/esptool,./libraries/SoftwareSerial,./libraries/Ethernet,./github/workflows,./libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino,./libraries/esp8266/examples/RTCUserMemory/RTCUserMemory.ino,./libraries/esp8266/examples/StreamString/StreamString.ino,./libraries/ESP8266WiFi/examples/BearSSL_Validation/BearSSL_Validation.ino,./libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino,./libraries/ESP8266WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino,./libraries/ESP8266WebServer/examples/HttpHashCredAuth/HttpHashCredAuth.ino,./cores/esp8266/spiffs,./tests/device/test_libc/libm_string.c, ./libraries/Netdump/examples/Netdump/Netdump.ino,./libraries/ESP8266WiFi/examples/BearSSL_Server,./cores/esp8266/LwipIntfDev.h + ignore_words_list: ESP8266,esp8266,esp,dout,DOUT,ser,ans diff --git a/cores/esp8266/CallBackList.h b/cores/esp8266/CallBackList.h index 8d419cbb89..1df590e00e 100644 --- a/cores/esp8266/CallBackList.h +++ b/cores/esp8266/CallBackList.h @@ -1,9 +1,8 @@ #ifndef __CALLBACKLIST_H__ #define __CALLBACKLIST_H__ - /* - CallBackList, An implemention for handling callback execution + CallBackList, An implementation for handling callback execution Copyright (c) 2019 Herman Reintke. All rights reserved. This file is part of the esp8266 core for Arduino environment. diff --git a/cores/esp8266/Esp-frag.cpp b/cores/esp8266/Esp-frag.cpp index 30332aca62..4a27ac2e8b 100644 --- a/cores/esp8266/Esp-frag.cpp +++ b/cores/esp8266/Esp-frag.cpp @@ -25,7 +25,7 @@ void EspClass::getHeapStats(uint32_t* hfree, uint16_t* hmax, uint8_t* hfrag) { - // L2 / Euclidian norm of free block sizes. + // L2 / Euclidean norm of free block sizes. // Having getFreeHeap()=sum(hole-size), fragmentation is given by // 100 * (1 - sqrt(sum(hole-size²)) / sum(hole-size)) diff --git a/cores/esp8266/Esp.h b/cores/esp8266/Esp.h index b191704b58..727ca7bb3b 100644 --- a/cores/esp8266/Esp.h +++ b/cores/esp8266/Esp.h @@ -26,7 +26,7 @@ #include "spi_vendors.h" /** - * AVR macros for WDT managment + * AVR macros for WDT management */ typedef enum { WDTO_0MS = 0, //!< WDTO_0MS @@ -264,7 +264,7 @@ class EspClass { static bool flashReplaceBlock(uint32_t address, const uint8_t *value, uint32_t byteCount); /** * @brief Write up to @a size bytes from @a data to flash at @a address - * This function takes case of unaligned memory acces by copying @a data to a temporary buffer, + * This function takes case of unaligned memory access by copying @a data to a temporary buffer, * it also takes care of page boundary crossing see @a flashWritePageBreak as to why it's done. * Less than @a size bytes may be written, due to 4 byte alignment requirement of spi_flash_write * @param address address on flash where write should start diff --git a/cores/esp8266/FSnoop.cpp b/cores/esp8266/FSnoop.cpp index 6cead006f2..b5840ff16e 100644 --- a/cores/esp8266/FSnoop.cpp +++ b/cores/esp8266/FSnoop.cpp @@ -15,7 +15,7 @@ void close_all_fs(void) } // default weak definitions -// they are overriden in their respective real implementation +// they are overridden in their respective real implementation // hint: https://github.com/esp8266/Arduino/pull/6699#issuecomment-549085382 void littlefs_request_end(void) __attribute__((weak)); diff --git a/cores/esp8266/HardwareSerial.h b/cores/esp8266/HardwareSerial.h index 8c27d2777f..bdccae5ea9 100644 --- a/cores/esp8266/HardwareSerial.h +++ b/cores/esp8266/HardwareSerial.h @@ -132,7 +132,7 @@ class HardwareSerial: public Stream int peek(void) override { - // return -1 when data is unvailable (arduino api) + // return -1 when data is unavailable (arduino api) return uart_peek_char(_uart); } @@ -162,7 +162,7 @@ class HardwareSerial: public Stream int read(void) override { - // return -1 when data is unvailable (arduino api) + // return -1 when data is unavailable (arduino api) return uart_read_char(_uart); } // ::read(buffer, size): same as readBytes without timeout diff --git a/cores/esp8266/LwipDhcpServer-NonOS.cpp b/cores/esp8266/LwipDhcpServer-NonOS.cpp index 0a0f0b77b1..0bd04ebcfe 100644 --- a/cores/esp8266/LwipDhcpServer-NonOS.cpp +++ b/cores/esp8266/LwipDhcpServer-NonOS.cpp @@ -51,7 +51,7 @@ extern "C" // trying to change legacy behavor // `fw_has_started_softap_dhcps` will be read in DhcpServer::DhcpServer // which is called when c++ ctors are initialized, specifically - // dhcpSoftAP intialized with AP interface number above. + // dhcpSoftAP initialized with AP interface number above. fw_has_started_softap_dhcps = 1; #endif } diff --git a/cores/esp8266/LwipDhcpServer.cpp b/cores/esp8266/LwipDhcpServer.cpp index a6b50c7d10..86f8849a91 100644 --- a/cores/esp8266/LwipDhcpServer.cpp +++ b/cores/esp8266/LwipDhcpServer.cpp @@ -195,7 +195,7 @@ DhcpServer::DhcpServer(netif* netif): _netif(netif) { 0 } // gateway 0.0.0.0 }; begin(&ip); - fw_has_started_softap_dhcps = 2; // not 1, ending intial boot sequence + fw_has_started_softap_dhcps = 2; // not 1, ending initial boot sequence } }; @@ -454,10 +454,10 @@ uint8_t* DhcpServer::add_offer_options(uint8_t *optptr) *optptr++ = 1; *optptr++ = 0x00; -#if 0 // vendor specific unititialized (??) +#if 0 // vendor specific uninitialized (??) *optptr++ = 43; // vendor specific *optptr++ = 6; - // unitialized ? + // uninitialized ? #endif #if 0 // already set (DHCP_OPTION_SUBNET_MASK==1) (??) diff --git a/cores/esp8266/Print.h b/cores/esp8266/Print.h index 746ebc1e20..e5d8d1b1ef 100644 --- a/cores/esp8266/Print.h +++ b/cores/esp8266/Print.h @@ -76,7 +76,7 @@ class Print { inline size_t write(int8_t c) { return write((uint8_t) c); } // default to zero, meaning "a single write may block" - // should be overriden by subclasses with buffering + // should be overridden by subclasses with buffering virtual int availableForWrite() { return 0; } size_t printf(const char * format, ...) __attribute__ ((format (printf, 2, 3))); diff --git a/cores/esp8266/Stream.cpp b/cores/esp8266/Stream.cpp index 0bb2113fae..5e7e8636c1 100644 --- a/cores/esp8266/Stream.cpp +++ b/cores/esp8266/Stream.cpp @@ -148,7 +148,7 @@ long Stream::parseInt(char skipChar) { do { if(c == skipChar) - ; // ignore this charactor + ; // ignore this character else if(c == '-') isNegative = true; else if(c >= '0' && c <= '9') // is c a digit? diff --git a/cores/esp8266/Stream.h b/cores/esp8266/Stream.h index 340d4f9c78..6408befe02 100644 --- a/cores/esp8266/Stream.h +++ b/cores/esp8266/Stream.h @@ -162,27 +162,27 @@ class Stream: public Print { // ::send*() methods: // - always stop before timeout when "no-more-input-possible-data" // or "no-more-output-possible-data" condition is met - // - always return number of transfered bytes + // - always return number of transferred bytes // When result is 0 or less than requested maxLen, Print::getLastSend() // contains an error reason. // transfers already buffered / immediately available data (no timeout) - // returns number of transfered bytes + // returns number of transferred bytes size_t sendAvailable (Print* to) { return sendGeneric(to, -1, -1, oneShotMs::alwaysExpired); } size_t sendAvailable (Print& to) { return sendAvailable(&to); } // transfers data until timeout - // returns number of transfered bytes + // returns number of transferred bytes size_t sendAll (Print* to, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendGeneric(to, -1, -1, timeoutMs); } size_t sendAll (Print& to, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendAll(&to, timeoutMs); } - // transfers data until a char is encountered (the char is swallowed but not transfered) with timeout - // returns number of transfered bytes + // transfers data until a char is encountered (the char is swallowed but not transferred) with timeout + // returns number of transferred bytes size_t sendUntil (Print* to, const int readUntilChar, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendGeneric(to, -1, readUntilChar, timeoutMs); } size_t sendUntil (Print& to, const int readUntilChar, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendUntil(&to, readUntilChar, timeoutMs); } // transfers data until requested size or timeout - // returns number of transfered bytes + // returns number of transferred bytes size_t sendSize (Print* to, const ssize_t maxLen, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendGeneric(to, maxLen, -1, timeoutMs); } size_t sendSize (Print& to, const ssize_t maxLen, const oneShotMs::timeType timeoutMs = oneShotMs::neverExpires) { return sendSize(&to, maxLen, timeoutMs); } diff --git a/cores/esp8266/StreamString.h b/cores/esp8266/StreamString.h index 1d0cc958d1..264604f7a4 100644 --- a/cores/esp8266/StreamString.h +++ b/cores/esp8266/StreamString.h @@ -230,7 +230,7 @@ class StreamString: public String, public S2Stream StreamString(StreamString&& bro): String(bro), S2Stream(this) { } StreamString(const StreamString& bro): String(bro), S2Stream(this) { } - // duplicate String contructors and operator=: + // duplicate String constructors and operator=: StreamString(const char* text = nullptr): String(text), S2Stream(this) { } StreamString(const String& string): String(string), S2Stream(this) { } diff --git a/cores/esp8266/Updater.cpp b/cores/esp8266/Updater.cpp index 3528a324a8..19a9dad528 100644 --- a/cores/esp8266/Updater.cpp +++ b/cores/esp8266/Updater.cpp @@ -410,7 +410,7 @@ size_t UpdaterClass::write(uint8_t *data, size_t len) { left -= toBuff; if(!_async) yield(); } - //lets see whats left + //lets see what's left memcpy(_buffer + _bufferLen, data + (len - left), left); _bufferLen += left; if(_bufferLen == remaining()){ diff --git a/cores/esp8266/Updater.h b/cores/esp8266/Updater.h index 0dcb866665..911ddf7784 100644 --- a/cores/esp8266/Updater.h +++ b/cores/esp8266/Updater.h @@ -108,12 +108,12 @@ class UpdaterClass { bool setMD5(const char * expected_md5); /* - returns the MD5 String of the sucessfully ended firmware + returns the MD5 String of the successfully ended firmware */ String md5String(void){ return _md5.toString(); } /* - populated the result with the md5 bytes of the sucessfully ended firmware + populated the result with the md5 bytes of the successfully ended firmware */ void md5(uint8_t * result){ return _md5.getBytes(result); } diff --git a/cores/esp8266/core_esp8266_i2s.cpp b/cores/esp8266/core_esp8266_i2s.cpp index eb13ee0b7f..05a70f18d6 100644 --- a/cores/esp8266/core_esp8266_i2s.cpp +++ b/cores/esp8266/core_esp8266_i2s.cpp @@ -483,7 +483,7 @@ void i2s_set_dividers(uint8_t div1, uint8_t div2) { i2sc_temp |= (I2STXR); // Hold transmitter in reset I2SC = i2sc_temp; - // trans master(active low), recv master(active_low), !bits mod(==16 bits/chanel), clear clock dividers + // trans master(active low), recv master(active_low), !bits mod(==16 bits/channel), clear clock dividers i2sc_temp &= ~(I2STSM | I2SRSM | (I2SBMM << I2SBM) | (I2SBDM << I2SBD) | (I2SCDM << I2SCD)); // I2SRF = Send/recv right channel first (? may be swapped form I2S spec of WS=0 => left) diff --git a/cores/esp8266/core_esp8266_main.cpp b/cores/esp8266/core_esp8266_main.cpp index f25cd296e9..b052718d51 100644 --- a/cores/esp8266/core_esp8266_main.cpp +++ b/cores/esp8266/core_esp8266_main.cpp @@ -290,7 +290,7 @@ void init_done() { know if other features are using this, or if this memory is going to be used in future SDK releases. - WPS beeing flawed by its poor security, or not beeing used by lots of + WPS being flawed by its poor security, or not being used by lots of users, it has been decided that we are still going to use that memory for user's stack and disable the use of WPS. diff --git a/cores/esp8266/core_esp8266_noniso.cpp b/cores/esp8266/core_esp8266_noniso.cpp index b341599b0f..f15fdc0860 100644 --- a/cores/esp8266/core_esp8266_noniso.cpp +++ b/cores/esp8266/core_esp8266_noniso.cpp @@ -1,5 +1,5 @@ /* - core_esp8266_noniso.c - nonstandard (but usefull) conversion functions + core_esp8266_noniso.c - nonstandard (but useful) conversion functions Copyright (c) 2014 Ivan Grokhotkov. All rights reserved. This file is part of the esp8266 core for Arduino environment. diff --git a/cores/esp8266/core_esp8266_phy.cpp b/cores/esp8266/core_esp8266_phy.cpp index 9291d35fca..f06a698bf7 100644 --- a/cores/esp8266/core_esp8266_phy.cpp +++ b/cores/esp8266/core_esp8266_phy.cpp @@ -289,7 +289,7 @@ static const uint8_t ICACHE_FLASH_ATTR phy_init_data[128] = }; -// These functions will be overriden from C++ code. +// These functions will be overridden from C++ code. // Unfortunately, we can't use extern "C" because Arduino preprocessor // doesn't generate forward declarations for extern "C" functions correctly, // so we use mangled names here. diff --git a/cores/esp8266/core_esp8266_spi_utils.cpp b/cores/esp8266/core_esp8266_spi_utils.cpp index ccf800e7d9..5f2ea25f92 100644 --- a/cores/esp8266/core_esp8266_spi_utils.cpp +++ b/cores/esp8266/core_esp8266_spi_utils.cpp @@ -56,7 +56,7 @@ _SPICommand(volatile uint32_t spiIfNum, if (spiIfNum>1) return SPI_RESULT_ERR; - // force SPI register access via base+offest. + // force SPI register access via base+offset. // Prevents loading individual address constants from flash. uint32_t *spibase = (uint32_t*)(spiIfNum ? &(SPI1CMD) : &(SPI0CMD)); #define SPIREG(reg) (*((volatile uint32_t *)(spibase+(&(reg) - &(SPI0CMD))))) @@ -141,7 +141,7 @@ _SPICommand(volatile uint32_t spiIfNum, * data has been sent. * * Note: This code has only been tested with SPI bus 0, but should work - * equally well with other busses. The ESP8266 has bus 0 and 1, + * equally well with other buses. The ESP8266 has bus 0 and 1, * newer chips may have more one day. */ SpiOpResult SPI0Command(uint8_t cmd, uint32_t *data, uint32_t mosi_bits, uint32_t miso_bits) { diff --git a/cores/esp8266/core_esp8266_version.h b/cores/esp8266/core_esp8266_version.h index 856d9f8f43..b294d589bc 100644 --- a/cores/esp8266/core_esp8266_version.h +++ b/cores/esp8266/core_esp8266_version.h @@ -1,4 +1,3 @@ - /* core_esp8266_version.h - parse "git describe" at compile time Copyright (c) 2018 david gauchard. All rights reserved. @@ -159,7 +158,7 @@ int coreVersionSubRevision () } /* - * unique revision indentifier (never decreases) + * unique revision identifier (never decreases) */ constexpr int coreVersionNumeric () diff --git a/cores/esp8266/core_esp8266_wiring.cpp b/cores/esp8266/core_esp8266_wiring.cpp index 5fcfd92fc8..b956cebe43 100644 --- a/cores/esp8266/core_esp8266_wiring.cpp +++ b/cores/esp8266/core_esp8266_wiring.cpp @@ -69,8 +69,8 @@ void micros_overflow_tick(void* arg) { //--------------------------------------------------------------------------- // millis() 'magic multiplier' approximation // -// This function corrects the cumlative (296us / usec overflow) drift -// seen in the orignal 'millis()' function. +// This function corrects the cumulative (296us / usec overflow) drift +// seen in the original 'millis()' function. // // Input: // 'm' - 32-bit usec counter, 0 <= m <= 0xFFFFFFFF diff --git a/cores/esp8266/esp8266_peri.h b/cores/esp8266/esp8266_peri.h index 6ed20dfffd..33b1e5822f 100644 --- a/cores/esp8266/esp8266_peri.h +++ b/cores/esp8266/esp8266_peri.h @@ -163,7 +163,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16]; #define TCIS 8 //Interrupt Status #define TCTE 7 //Timer Enable #define TCAR 6 //AutoReload (restart timer when condition is reached) -#define TCPD 2 //Prescale Devider (2bit) 0:1(12.5ns/tick), 1:16(0.2us/tick), 2/3:256(3.2us/tick) +#define TCPD 2 //Prescale Divider (2bit) 0:1(12.5ns/tick), 1:16(0.2us/tick), 2/3:256(3.2us/tick) #define TCIT 0 //Interrupt Type 0:edge, 1:level //RTC Registers @@ -271,7 +271,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16]; #define UCRXI 19 //Invert RX #define UCTXRST 18 //Reset TX FIFO #define UCRXRST 17 //Reset RX FIFO -#define UCTXHFE 15 //TX Harware Flow Enable +#define UCTXHFE 15 //TX Hardware Flow Enable #define UCLBE 14 //LoopBack Enable #define UCBRK 8 //Send Break on the TX line #define UCSWDTR 7 //Set this bit to assert DTR @@ -283,11 +283,11 @@ extern volatile uint32_t* const esp8266_gpioToFn[16]; //UART CONF1 Registers Bits #define UCTOE 31 //RX TimeOut Enable -#define UCTOT 24 //RX TimeOut Treshold (7bit) -#define UCRXHFE 23 //RX Harware Flow Enable -#define UCRXHFT 16 //RX Harware Flow Treshold (7bit) -#define UCFET 8 //TX FIFO Empty Treshold (7bit) -#define UCFFT 0 //RX FIFO Full Treshold (7bit) +#define UCTOT 24 //RX TimeOut Threshold (7bit) +#define UCRXHFE 23 //RX Hardware Flow Enable +#define UCRXHFT 16 //RX Hardware Flow Threshold (7bit) +#define UCFET 8 //TX FIFO Empty Threshold (7bit) +#define UCFFT 0 //RX FIFO Full Threshold (7bit) //WDT Feed (the dog) Register #define WDTFEED ESP8266_REG(0x914) @@ -372,7 +372,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16]; #define SPI1E3 ESP8266_REG(0x1FC) #define SPI1W(p) ESP8266_REG(0x140 + ((p & 0xF) * 4)) -//SPI0, SPI1 & I2S Interupt Register +//SPI0, SPI1 & I2S Interrupt Register #define SPIIR ESP8266_DREG(0x20) #define SPII0 4 //SPI0 Interrupt #define SPII1 7 //SPI1 Interrupt diff --git a/cores/esp8266/esp8266_undocumented.h b/cores/esp8266/esp8266_undocumented.h index 9a21868b34..277d467698 100644 --- a/cores/esp8266/esp8266_undocumented.h +++ b/cores/esp8266/esp8266_undocumented.h @@ -185,7 +185,7 @@ typedef void (*fn_c_exception_handler_t)(struct __exception_frame *ef, int cause _xtos_c_handler_table[]. It is present when an exception handler has not been registered. It simply consist of a single instruction, `ret`. It is also internally used by `_xtos_set_exception_handler(cause, NULL)` to - reset a "C" exception handler back to the unhandled state. The coresponding + reset a "C" exception handler back to the unhandled state. The corresponding `_xtos_exc_handler_table` entry will be set to `_xtos_unhandled_exception`. Note, if nesting handlers is desired this must be implemented in the new "C" exception handler(s) being registered. diff --git a/cores/esp8266/exc-sethandler.cpp b/cores/esp8266/exc-sethandler.cpp index 1551d2446c..b8f9d69a35 100644 --- a/cores/esp8266/exc-sethandler.cpp +++ b/cores/esp8266/exc-sethandler.cpp @@ -47,7 +47,7 @@ * https://github.com/qca/open-ath9k-htc-firmware/blob/master/sboot/magpie_1_1/sboot/athos/src/xtos/exc-sethandler.c * * It has been revised to use Arduino ESP8266 core includes, types, and - * formating. + * formatting. */ /* exc-sethandler.c - register an exception handler in XTOS */ diff --git a/cores/esp8266/gdb_hooks.h b/cores/esp8266/gdb_hooks.h index 4953216a1a..81a117cc82 100644 --- a/cores/esp8266/gdb_hooks.h +++ b/cores/esp8266/gdb_hooks.h @@ -27,7 +27,7 @@ extern "C" { * @brief Initialize GDB stub, if present * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and does necessary initialization of that library. + * this function is overridden and does necessary initialization of that library. * Called early at startup. */ void gdb_init(void); @@ -36,7 +36,7 @@ void gdb_init(void); * @brief Break into GDB, if present * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and triggers entry into the debugger, which + * this function is overridden and triggers entry into the debugger, which * looks like a breakpoint hit. */ void gdb_do_break(void); @@ -45,7 +45,7 @@ void gdb_do_break(void); * @brief Check if GDB stub is present. * * By default, this function returns false. When GDBStub library is linked, - * this function is overriden and returns true. Can be used to check whether + * this function is overridden and returns true. Can be used to check whether * GDB is used. * * @return true if GDB stub is present @@ -58,7 +58,7 @@ bool gdb_present(void); * @brief Check if GDB is installing a putc1 callback. * * By default, this function returns false. When GDBStub library is linked, - * this function is overriden and returns true. + * this function is overridden and returns true. * * @return true if GDB is installing a putc1 callback */ @@ -69,7 +69,7 @@ bool gdbstub_has_putc1_control(void); * @param func function GDB will proxy putc1 data to * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and sets GDB stub's secondary putc1 callback to + * this function is overridden and sets GDB stub's secondary putc1 callback to * func. When GDB stub is linked, but a GDB session is not current attached, * then GDB stub will pass putc1 chars directly to this function. */ @@ -79,7 +79,7 @@ void gdbstub_set_putc1_callback(void (*func)(char)); * @brief Check if GDB is installing a uart0 isr callback. * * By default, this function returns false. When GDBStub library is linked, - * this function is overriden and returns true. + * this function is overridden and returns true. * * @return true if GDB is installing a uart0 isr callback */ @@ -90,7 +90,7 @@ bool gdbstub_has_uart_isr_control(void); * @param func function GDB will proxy uart0 isr data to * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and sets GDB stub's secondary uart0 isr callback + * this function is overridden and sets GDB stub's secondary uart0 isr callback * to func. When GDB stub is linked, but a GDB session is not current attached, * then GDB stub will pass uart0 isr data back to this function. */ @@ -101,7 +101,7 @@ void gdbstub_set_uart_isr_callback(void (*func)(void*, uint8_t), void* arg); * @param c character to write * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and writes a char to either the GDB session on + * this function is overridden and writes a char to either the GDB session on * uart0 or directly to uart0 if not GDB session is attached. */ void gdbstub_write_char(char c); @@ -112,7 +112,7 @@ void gdbstub_write_char(char c); * @param size length of buffer * * By default, this function is a no-op. When GDBStub library is linked, - * this function is overriden and writes a buffer to either the GDB session on + * this function is overridden and writes a buffer to either the GDB session on * uart0 or directly to uart0 if not GDB session is attached. */ void gdbstub_write(const char* buf, size_t size); diff --git a/cores/esp8266/heap.cpp b/cores/esp8266/heap.cpp index aa293b9537..896002d2b9 100644 --- a/cores/esp8266/heap.cpp +++ b/cores/esp8266/heap.cpp @@ -42,7 +42,7 @@ extern "C" { #define UMM_REALLOC_FL(p,s,f,l) realloc(p,s) #define UMM_FREE_FL(p,f,l) free(p) -// STATIC_ALWAYS_INLINE only applys to the non-debug build path, +// STATIC_ALWAYS_INLINE only applies to the non-debug build path, // it must not be enabled on the debug build path. #define STATIC_ALWAYS_INLINE static ALWAYS_INLINE #endif @@ -226,10 +226,10 @@ void IRAM_ATTR print_oom_size(size_t size) b. Before, when the *alloc function creates a new, not modified, allocation. In a free() or realloc() call, the focus is on their allocation. It is - checked 1st and reported on 1ST if an error exists. Full Posion Check is + checked 1st and reported on 1ST if an error exists. Full Poison Check is done after. - For malloc(), calloc(), and zalloc() Full Posion Check is done 1st since + For malloc(), calloc(), and zalloc() Full Poison Check is done 1st since these functions do not modify an existing allocation. */ void* IRAM_ATTR malloc(size_t size) diff --git a/cores/esp8266/hwdt_app_entry.cpp b/cores/esp8266/hwdt_app_entry.cpp index 4da323f932..4d00fdae95 100644 --- a/cores/esp8266/hwdt_app_entry.cpp +++ b/cores/esp8266/hwdt_app_entry.cpp @@ -376,7 +376,7 @@ extern hwdt_info_t hwdt_info; #undef hwdt_info_ #undef hwdt_info #undef HWDT_VERIFY_HWDT_INFO -static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and include verison of hwdt_info_t do not match."); +static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and include version of hwdt_info_t do not match."); #endif @@ -411,7 +411,7 @@ static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and inclu #define CONT_STACK_A16_SZ (MK_ALIGN16_SZ(sizeof(cont_t))) /* * For WPS support, cont stack comes out of the user's heap address space. - * The the NONOS-SDK stack address is initialized before tbe reserved ROM stack + * The NONOS-SDK stack address is initialized before the reserved ROM stack * space. In this configuration there is no extra 4K in the heap. * Memory map: 0x3FFE8000, ..., (CONT_STACK), ..., (SYS), (ROM_STACK), 0x4000000 * @@ -764,8 +764,8 @@ void adjust_uart_speed(uint32_t uart_divisor) { * stablilize, and let the remote receiver come to an idle state before * continuing. * - * Load a Rubout character for the final charcter shifting out to stop - * the last charcter from getting crunched during the speed change. + * Load a Rubout character for the final character shifting out to stop + * the last character from getting crunched during the speed change. * * The thinking is if the speed changes while shifting out, as long as the * start bit gets out before the change. The change will not be noticed diff --git a/cores/esp8266/interrupts.h b/cores/esp8266/interrupts.h index 0afcb161b7..300154bc2a 100644 --- a/cores/esp8266/interrupts.h +++ b/cores/esp8266/interrupts.h @@ -3,7 +3,7 @@ #include -// these auto classes wrap up xt_rsil so your code can be simplier, but can only be +// these auto classes wrap up xt_rsil so your code can be simpler, but can only be // used in an ino or cpp files. // InterruptLock is used when you want to completely disable interrupts diff --git a/cores/esp8266/mmu_iram.cpp b/cores/esp8266/mmu_iram.cpp index 488e596ccd..7a3548e4a3 100644 --- a/cores/esp8266/mmu_iram.cpp +++ b/cores/esp8266/mmu_iram.cpp @@ -80,7 +80,7 @@ extern "C" { * * "Cache_Read_Enable" is underdocumented. Main sources of information were from * rboot, zboot, https://richard.burtons.org/2015/06/12/esp8266-cache_read_enable/, - * and other places. And some additional expermentation. + * and other places. And some additional experimentation. * * Searching through the NONOS SDK shows nothing on this API; however, some * clues on what the NONOS SDK might be doing with ICACHE related calls can be diff --git a/cores/esp8266/mmu_iram.h b/cores/esp8266/mmu_iram.h index e372fa1047..7ba06be9bb 100644 --- a/cores/esp8266/mmu_iram.h +++ b/cores/esp8266/mmu_iram.h @@ -122,7 +122,7 @@ bool mmu_is_icache(const void *addr) { /* * Some inlines to allow faster random access to non32bit access of iRAM or * iCACHE data elements. These remove the extra time and stack space that would - * have occured by relying on exception processing. + * have occurred by relying on exception processing. */ static inline __attribute__((always_inline)) uint8_t mmu_get_uint8(const void *p8) { diff --git a/cores/esp8266/reboot_uart_dwnld.cpp b/cores/esp8266/reboot_uart_dwnld.cpp index ce9f52d14d..7b58fb2224 100644 --- a/cores/esp8266/reboot_uart_dwnld.cpp +++ b/cores/esp8266/reboot_uart_dwnld.cpp @@ -19,10 +19,10 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA This implementation is based on the original implementation of the ROM. - It was shortend to reduce the memory usage. The complete version and the + It was shortened to reduce the memory usage. The complete version and the development history can be found in: https://github.com/twischer/Arduino/tree/reboot_uart_download_full - This might be usefull in case of issues. + This might be useful in case of issues. */ #include "reboot_uart_dwnld.h" #include diff --git a/cores/esp8266/spiffs/TECH_SPEC b/cores/esp8266/spiffs/TECH_SPEC index b4755a6dbc..300edb4912 100644 --- a/cores/esp8266/spiffs/TECH_SPEC +++ b/cores/esp8266/spiffs/TECH_SPEC @@ -113,7 +113,7 @@ Choosing the page size for the system involves many factors: - How fast must spiffs be - Other things impossible to find out -So, chosing the Optimal Page Size (tm) seems tricky, to say the least. Don't +So, choosing the Optimal Page Size (tm) seems tricky, to say the least. Don't fret - there is no optimal page size. This varies from how the target will use spiffs. Use the golden rule: diff --git a/cores/esp8266/spiffs/spiffs.h b/cores/esp8266/spiffs/spiffs.h index e659bf2f37..f9249b1eb4 100644 --- a/cores/esp8266/spiffs/spiffs.h +++ b/cores/esp8266/spiffs/spiffs.h @@ -695,7 +695,7 @@ s32_t SPIFFS_tell(spiffs *fs, spiffs_file fh); * in this callback will mess things up for sure - do not do this. * This can be used to track where files are and move around during garbage * collection, which in turn can be used to build location tables in ram. - * Used in conjuction with SPIFFS_open_by_page this may improve performance + * Used in conjunction with SPIFFS_open_by_page this may improve performance * when opening a lot of files. * Must be invoked after mount. * @@ -710,7 +710,7 @@ s32_t SPIFFS_set_file_callback_func(spiffs *fs, spiffs_file_callback cb_func); * Maps the first level index lookup to a given memory map. * This will make reading big files faster, as the memory map will be used for * looking up data pages instead of searching for the indices on the physical - * medium. When mapping, all affected indicies are found and the information is + * medium. When mapping, all affected indices are found and the information is * copied to the array. * Whole file or only parts of it may be mapped. The index map will cover file * contents from argument offset until and including arguments (offset+len). diff --git a/cores/esp8266/spiffs/spiffs_nucleus.h b/cores/esp8266/spiffs/spiffs_nucleus.h index a8b4af062e..14ef32b926 100644 --- a/cores/esp8266/spiffs/spiffs_nucleus.h +++ b/cores/esp8266/spiffs/spiffs_nucleus.h @@ -353,7 +353,7 @@ extern "C" { if ((ph).span_ix != (spix)) return SPIFFS_ERR_DATA_SPAN_MISMATCH; -// check id, only visit matching objec ids +// check id, only visit matching object ids #define SPIFFS_VIS_CHECK_ID (1<<0) // report argument object id to visitor - else object lookup id is reported #define SPIFFS_VIS_CHECK_PH (1<<1) diff --git a/cores/esp8266/stdlib_noniso.cpp b/cores/esp8266/stdlib_noniso.cpp index 2b24681d3d..693dfda850 100644 --- a/cores/esp8266/stdlib_noniso.cpp +++ b/cores/esp8266/stdlib_noniso.cpp @@ -1,5 +1,5 @@ /* - stdlib_noniso.h - nonstandard (but usefull) conversion functions + stdlib_noniso.h - nonstandard (but useful) conversion functions Copyright (c) 2021 David Gauchard. All rights reserved. This file is part of the esp8266 core for Arduino environment. diff --git a/cores/esp8266/stdlib_noniso.h b/cores/esp8266/stdlib_noniso.h index 2bacc2cb2c..f86f78befc 100644 --- a/cores/esp8266/stdlib_noniso.h +++ b/cores/esp8266/stdlib_noniso.h @@ -1,5 +1,5 @@ /* - stdlib_noniso.h - nonstandard (but usefull) conversion functions + stdlib_noniso.h - nonstandard (but useful) conversion functions Copyright (c) 2014 Ivan Grokhotkov. All rights reserved. This file is part of the esp8266 core for Arduino environment. diff --git a/cores/esp8266/umm_malloc/README.md b/cores/esp8266/umm_malloc/README.md index f81aa09ccc..5bc5bbd348 100644 --- a/cores/esp8266/umm_malloc/README.md +++ b/cores/esp8266/umm_malloc/README.md @@ -126,7 +126,7 @@ later. The result is that a block of memory on the free list uses just 8 bytes instead of 16. -In fact, we go even one step futher when we realize that the free block +In fact, we go even one step further when we realize that the free block index values are available to store data when the block is allocated. The overhead of an allocated block is therefore just 4 bytes. @@ -205,7 +205,7 @@ described. allocated for use by the upper block. While we're talking about "upper" and "lower" blocks, we should make -a comment about adresses. In the diagrams, a block higher up in the +a comment about addresses. In the diagrams, a block higher up in the picture is at a lower address. And the blocks grow downwards their block index increases as does their physical address. @@ -347,7 +347,7 @@ nf |*?? | ?? | ?? | cf | nf | ?? | ?? | ?? | pf | ``` This one is prety easy too, except we don't need to mess with the -free list indexes at all becasue we'll allocate the new block at the +free list indexes at all because we'll allocate the new block at the end of the current free block. We do, however have to adjust the indexes in cf, c, and n. @@ -539,5 +539,5 @@ BEFORE AFTER +----+----+----+----+ +----+----+----+----+ ``` -Then we call free() with the adress of the data portion of the new +Then we call free() with the address of the data portion of the new block (s) which adds it to the free list. diff --git a/cores/esp8266/umm_malloc/dbglog/dbglog.h b/cores/esp8266/umm_malloc/dbglog/dbglog.h index 575a7c6b13..2554d23ff6 100644 --- a/cores/esp8266/umm_malloc/dbglog/dbglog.h +++ b/cores/esp8266/umm_malloc/dbglog/dbglog.h @@ -13,7 +13,7 @@ * to set the trace level #define DBGLOG_LEVEL x * * To update which of the DBGLOG macros are compiled in, you must redefine the - * DBGLOG_LEVEL macro and the inlcude the dbglog.h file again, like this: + * DBGLOG_LEVEL macro and the include the dbglog.h file again, like this: * * #undef DBGLOG_LEVEL * #define DBGLOG_LEVEL 6 diff --git a/cores/esp8266/umm_malloc/umm_heap_select.h b/cores/esp8266/umm_malloc/umm_heap_select.h index 1a3728d7aa..a329bf103c 100644 --- a/cores/esp8266/umm_malloc/umm_heap_select.h +++ b/cores/esp8266/umm_malloc/umm_heap_select.h @@ -7,7 +7,7 @@ #define ALWAYS_INLINE inline __attribute__ ((always_inline)) #endif -// Use FORCE_ALWAYS_INLINE to ensure HeapSelect... construtor/deconstructor +// Use FORCE_ALWAYS_INLINE to ensure HeapSelect... constructor/deconstructor // are placed in IRAM #ifdef FORCE_ALWAYS_INLINE_HEAP_SELECT #define MAYBE_ALWAYS_INLINE ALWAYS_INLINE diff --git a/cores/esp8266/umm_malloc/umm_info.c b/cores/esp8266/umm_malloc/umm_info.c index 0860fe79ea..b88e013b67 100644 --- a/cores/esp8266/umm_malloc/umm_info.c +++ b/cores/esp8266/umm_malloc/umm_info.c @@ -197,7 +197,7 @@ size_t umm_max_block_size( void ) { /* Without build option UMM_INLINE_METRICS, calls to umm_usage_metric() or - umm_fragmentation_metric() must to be preceeded by a call to umm_info(NULL, false) + umm_fragmentation_metric() must to be preceded by a call to umm_info(NULL, false) for updated results. */ int umm_usage_metric_core( umm_heap_context_t *_context ) { diff --git a/cores/esp8266/umm_malloc/umm_local.c b/cores/esp8266/umm_malloc/umm_local.c index 641cfa50f4..c1169a8a8f 100644 --- a/cores/esp8266/umm_malloc/umm_local.c +++ b/cores/esp8266/umm_malloc/umm_local.c @@ -6,7 +6,7 @@ #if defined(UMM_CRITICAL_METRICS) /* - * umm_malloc performance measurments for critical sections + * umm_malloc performance measurements for critical sections */ UMM_TIME_STATS time_stats = { {0xFFFFFFFF, 0U, 0U, 0U}, diff --git a/cores/esp8266/umm_malloc/umm_malloc.cpp b/cores/esp8266/umm_malloc/umm_malloc.cpp index 11b67d0fb9..a8b93505d6 100644 --- a/cores/esp8266/umm_malloc/umm_malloc.cpp +++ b/cores/esp8266/umm_malloc/umm_malloc.cpp @@ -585,7 +585,7 @@ void umm_free( void *ptr ) { return; } - /* Free the memory withing a protected critical section */ + /* Free the memory within a protected critical section */ UMM_CRITICAL_ENTRY(id_free); @@ -671,7 +671,7 @@ static void *umm_malloc_core( umm_heap_context_t *_context, size_t size ) { */ if( blockSize == blocks ) { - /* It's an exact fit and we don't neet to split off a block. */ + /* It's an exact fit and we don't need to split off a block. */ DBGLOG_DEBUG( "Allocating %6d blocks starting at %6d - exact\n", blocks, cf ); /* Disconnect this block from the FREE list */ @@ -755,7 +755,7 @@ void *umm_malloc( size_t size ) { * For allocating APIs `umm_heap_cur` is used to index and select a value for * `_context`. If an allocation is made from an ISR, this value is ignored and * the heap context for DRAM is loaded. For APIs that require operating on an - * existing allcation such as realloc and free, the heap context selected is + * existing allocation such as realloc and free, the heap context selected is * done by matching the allocation's address with that of one of the heap * address ranges. * @@ -798,7 +798,7 @@ void *umm_malloc( size_t size ) { return( ptr ); } - /* Allocate the memory withing a protected critical section */ + /* Allocate the memory within a protected critical section */ UMM_CRITICAL_ENTRY(id_malloc); diff --git a/cores/esp8266/umm_malloc/umm_malloc_cfg.h b/cores/esp8266/umm_malloc/umm_malloc_cfg.h index 796a47504f..9b1d0ba568 100644 --- a/cores/esp8266/umm_malloc/umm_malloc_cfg.h +++ b/cores/esp8266/umm_malloc/umm_malloc_cfg.h @@ -564,7 +564,7 @@ static inline void _critical_exit(UMM_TIME_STAT *p, uint32_t *saved_ps) { * direction of the beginning of the heap when possible. * * Status: TODO: These are new options introduced to optionally restore the - * previous defrag propery of realloc. The issue has been raised in the upstream + * previous defrag property of realloc. The issue has been raised in the upstream * repo. No response at this time. Based on response, may propose for upstream. */ /* @@ -796,7 +796,7 @@ extern "C" { // Arduino.h recall us to redefine them #include // Reuse pvPort* calls, since they already support passing location information. -// Specificly the debug version (heap_...) that does not force DRAM heap. +// Specifically the debug version (heap_...) that does not force DRAM heap. void* IRAM_ATTR heap_pvPortMalloc(size_t size, const char* file, int line); void* IRAM_ATTR heap_pvPortCalloc(size_t count, size_t size, const char* file, int line); void* IRAM_ATTR heap_pvPortRealloc(void *ptr, size_t size, const char* file, int line); diff --git a/cores/esp8266/xtruntime-frames.h b/cores/esp8266/xtruntime-frames.h index 8b5a7463ab..42ac0e2eb9 100644 --- a/cores/esp8266/xtruntime-frames.h +++ b/cores/esp8266/xtruntime-frames.h @@ -54,7 +54,7 @@ * stack frame is limited to 128 bytes (currently at 64). */ STRUCT_BEGIN -STRUCT_FIELD (long,4,KEXC_,pc) /* "parm" */ +STRUCT_FIELD (long,4,KEXC_,pc) /* "param" */ STRUCT_FIELD (long,4,KEXC_,ps) STRUCT_AFIELD(long,4,KEXC_,areg, 4) /* a12 .. a15 */ STRUCT_FIELD (long,4,KEXC_,sar) /* "save" */ diff --git a/doc/PROGMEM.rst b/doc/PROGMEM.rst index e455df639d..8cf86ce25b 100644 --- a/doc/PROGMEM.rst +++ b/doc/PROGMEM.rst @@ -5,7 +5,7 @@ Intro ----- PROGMEM is a Arduino AVR feature that has been ported to ESP8266 to -ensure compatability with existing Arduino libraries, as well as, saving +ensure compatibility with existing Arduino libraries, as well as, saving RAM. On the esp8266 declaring a string such as ``const char * xyz = "this is a string"`` will place this string in RAM, not flash. It is possible to place a String into flash, and then load it into RAM when @@ -283,7 +283,7 @@ generate as they are basically ``const char *``. On the other hand conversions from, very useful when overloading functions, and doing implicit type conversions. It is worth adding that if you wish to store an ``int``, ``float`` or pointer these can be stored and read back -directly as they are 4 bytes in size and therefor will be always +directly as they are 4 bytes in size and therefore will be always aligned! Hope this helps. diff --git a/doc/Troubleshooting/debugging.rst b/doc/Troubleshooting/debugging.rst index 0a96def3a5..1d80f3fe8d 100644 --- a/doc/Troubleshooting/debugging.rst +++ b/doc/Troubleshooting/debugging.rst @@ -44,8 +44,8 @@ Usage 5. Check the Serial Output -Informations ------------- +Information +----------- It work with every sketch that enables the Serial interface that is selected as debug port. diff --git a/doc/Troubleshooting/stack_dump.rst b/doc/Troubleshooting/stack_dump.rst index 4ac4907e1b..c977fce56d 100644 --- a/doc/Troubleshooting/stack_dump.rst +++ b/doc/Troubleshooting/stack_dump.rst @@ -51,7 +51,7 @@ Example: <<`__ +full list of all causes can be found `here <../exception_causes.rst>`__ the hex after are the stack dump. Decode diff --git a/doc/boards.rst b/doc/boards.rst index 0082d9cffb..b3b195893c 100644 --- a/doc/boards.rst +++ b/doc/boards.rst @@ -6,13 +6,13 @@ Generic ESP8266 Module These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info: `ESP8266 Module Family `__. -Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features. +Usually these modules have no bootstrapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features. In order to use these modules, make sure to observe the following: - **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator alongwith filtering capacitors is preferred. -- **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below. +- **Connect bootstrapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below. - **Put ESP8266 into bootloader mode** before uploading code. diff --git a/doc/eclipse/eclipse.rst b/doc/eclipse/eclipse.rst index 4a6fe32812..9ddd55baf2 100644 --- a/doc/eclipse/eclipse.rst +++ b/doc/eclipse/eclipse.rst @@ -31,8 +31,8 @@ example private hardware path Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware Linux: /home/[username]/.arduino15/packages/esp8266/hardware -Eclipse wont build -~~~~~~~~~~~~~~~~~~ +Eclipse won't build +~~~~~~~~~~~~~~~~~~~ if eclipse dont find the path to the Compiler add to the platform.txt after: diff --git a/doc/esp8266wifi/bearssl-server-secure-class.rst b/doc/esp8266wifi/bearssl-server-secure-class.rst index f25ce384e1..5f9df7504d 100644 --- a/doc/esp8266wifi/bearssl-server-secure-class.rst +++ b/doc/esp8266wifi/bearssl-server-secure-class.rst @@ -36,7 +36,7 @@ Sets an elliptic curve certificate and key for the server. Needs to be called b Client sessions (Resuming connections fast) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The TLS handshake process takes a long time because of all the back and forth between the client and the server. You can shorten it by caching the clients' sessions which will skip a few steps in the TLS handshake. In order for this to work, your client also needs to cache the session. `BearSSL::WiFiClientSecure `__ can do that as well as modern web browers. +The TLS handshake process takes a long time because of all the back and forth between the client and the server. You can shorten it by caching the clients' sessions which will skip a few steps in the TLS handshake. In order for this to work, your client also needs to cache the session. `BearSSL::WiFiClientSecure `__ can do that as well as modern web browsers. Here are the kind of performance improvements that you'll be able to see for TLS handshakes with an ESP8266 with it's clock set at 160MHz on a network with fairly low latency: diff --git a/doc/esp8266wifi/generic-class.rst b/doc/esp8266wifi/generic-class.rst index 36a0180c2b..f1ed42ea06 100644 --- a/doc/esp8266wifi/generic-class.rst +++ b/doc/esp8266wifi/generic-class.rst @@ -47,7 +47,7 @@ and WiFi does not start automatically at boot** (see PR `#7902 `__ was selected because it is designed for small systems, but that comes at the cost of some diff --git a/doc/libraries.rst b/doc/libraries.rst index 2c283814d1..625935554b 100644 --- a/doc/libraries.rst +++ b/doc/libraries.rst @@ -172,7 +172,7 @@ Libraries that don't rely on low-level access to AVR registers should work well. - `RTC `__ - Arduino Library for Ds1307 & Ds3231 compatible with ESP8266. - `Souliss, Smart Home `__ - Framework for Smart Home based on Arduino, Android and openHAB. - `ST7735 `__ - Adafruit's ST7735 library modified to be compatible with ESP8266. Just make sure to modify the pins in the examples as they are still AVR specific. -- `Task `__ - Arduino Nonpreemptive multitasking library. While similiar to the included Ticker library in the functionality provided, this library was meant for cross Arduino compatibility. +- `Task `__ - Arduino Nonpreemptive multitasking library. While similar to the included Ticker library in the functionality provided, this library was meant for cross Arduino compatibility. - `TickerScheduler `__ - Library provides simple scheduler for ``Ticker`` to avoid WDT reset - `Teleinfo `__ - Generic French Power Meter library to read Teleinfo energy monitoring data such as consuption, contract, power, period, ... This library is cross platform, ESP8266, Arduino, Particle, and simple C++. French dedicated `post `__ on author's blog and all related information about `Teleinfo `__ also available. - `UTFT-ESP8266 `__ - UTFT display library with support for ESP8266. Only serial interface (SPI) displays are supported for now (no 8-bit parallel mode, etc). Also includes support for the hardware SPI controller of the ESP8266. diff --git a/doc/ota_updates/readme.rst b/doc/ota_updates/readme.rst index 3ab136cf3d..e210a867d8 100755 --- a/doc/ota_updates/readme.rst +++ b/doc/ota_updates/readme.rst @@ -50,7 +50,7 @@ Signed updates are updates whose compiled binaries are signed with a private key Cryptographic signing only protects against tampering with binaries delivered via OTA. If someone has physical access, they will always be able to flash the device over the serial port. Signing also does not encrypt anything but the hash (so that it can't be modified), so this does not protect code inside the device: if a user has physical access they can read out your program. -**Securing your private key is paramount. The same private/public keypair that was used with the original upload must also be used to sign later binaries. Loss of the private key associated with a binary means that you will not be able to OTA-update any of your devices in the field. Alternatively, if someone else copies the private key, then they will be able to use it to sign binaries which will be accepted by the ESP.** +**Securing your private key is paramount. The same private/public key pair that was used with the original upload must also be used to sign later binaries. Loss of the private key associated with a binary means that you will not be able to OTA-update any of your devices in the field. Alternatively, if someone else copies the private key, then they will be able to use it to sign binaries which will be accepted by the ESP.** Signed Binary Format ^^^^^^^^^^^^^^^^^^^^ @@ -68,7 +68,7 @@ Signed Binary Prerequisites OpenSSL is required to run the standard signing steps, and should be available on any UNIX-like or Windows system. As usual, the latest stable version of OpenSSL is recommended. -Signing requires the generation of an RSA-2048 key (other bit lengths are supported as well, but 2048 is a good selection today) using any appropriate tool. The following shell commands will generate a new public/private keypair. Run them in the sketch directory: +Signing requires the generation of an RSA-2048 key (other bit lengths are supported as well, but 2048 is a good selection today) using any appropriate tool. The following shell commands will generate a new public/private key pair. Run them in the sketch directory: .. code:: bash diff --git a/doc/reference.rst b/doc/reference.rst index 63d2bb7d2a..792e867a47 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -362,7 +362,7 @@ Arduino API } } - One will notice that in the network to serial direction, data are transfered + One will notice that in the network to serial direction, data are transferred byte by byte while data are available. In the other direction, a temporary buffer is created on stack, filled with available serial data, then transferred to network. diff --git a/libraries/DNSServer/src/DNSServer.h b/libraries/DNSServer/src/DNSServer.h index 0f3ebd7a34..ad50516c81 100644 --- a/libraries/DNSServer/src/DNSServer.h +++ b/libraries/DNSServer/src/DNSServer.h @@ -33,7 +33,7 @@ struct DNSHeader uint16_t ID; // identification number unsigned char RD : 1; // recursion desired unsigned char TC : 1; // truncated message - unsigned char AA : 1; // authoritive answer + unsigned char AA : 1; // authoritative answer unsigned char OPCode : 4; // message_type unsigned char QR : 1; // query/response flag unsigned char RCode : 4; // response code diff --git a/libraries/ESP8266AVRISP/src/ESP8266AVRISP.cpp b/libraries/ESP8266AVRISP/src/ESP8266AVRISP.cpp index e03ab072e2..cc2fb84e3c 100644 --- a/libraries/ESP8266AVRISP/src/ESP8266AVRISP.cpp +++ b/libraries/ESP8266AVRISP/src/ESP8266AVRISP.cpp @@ -189,7 +189,7 @@ void ESP8266AVRISP::get_parameter(uint8_t c) { } void ESP8266AVRISP::set_parameters() { - // call this after reading paramter packet into buff[] + // call this after reading parameter packet into buff[] param.devicecode = buff[0]; param.revision = buff[1]; param.progtype = buff[2]; diff --git a/libraries/ESP8266HTTPClient/examples/StreamHttpClient/StreamHttpClient.ino b/libraries/ESP8266HTTPClient/examples/StreamHttpClient/StreamHttpClient.ino index 7ed0cd5294..7e1593f52b 100644 --- a/libraries/ESP8266HTTPClient/examples/StreamHttpClient/StreamHttpClient.ino +++ b/libraries/ESP8266HTTPClient/examples/StreamHttpClient/StreamHttpClient.ino @@ -57,7 +57,7 @@ void loop() { // file found at server if (httpCode == HTTP_CODE_OK) { - // get lenght of document (is -1 when Server sends no Content-Length header) + // get length of document (is -1 when Server sends no Content-Length header) int len = http.getSize(); // create buffer for read diff --git a/libraries/ESP8266HTTPClient/examples/StreamHttpsClient/StreamHttpsClient.ino b/libraries/ESP8266HTTPClient/examples/StreamHttpsClient/StreamHttpsClient.ino index a69b9e35c6..8098986650 100644 --- a/libraries/ESP8266HTTPClient/examples/StreamHttpsClient/StreamHttpsClient.ino +++ b/libraries/ESP8266HTTPClient/examples/StreamHttpsClient/StreamHttpsClient.ino @@ -68,7 +68,7 @@ void loop() { // file found at server if (httpCode == HTTP_CODE_OK) { - // get lenght of document (is -1 when Server sends no Content-Length header) + // get length of document (is -1 when Server sends no Content-Length header) int len = https.getSize(); // create buffer for read diff --git a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp index 592a14d0cc..f16167127d 100644 --- a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp +++ b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.cpp @@ -321,7 +321,7 @@ bool HTTPClient::setURL(const String& url) } /** - * set redirect follow mode. See `followRedirects_t` enum for avaliable modes. + * set redirect follow mode. See `followRedirects_t` enum for available modes. * @param follow */ void HTTPClient::setFollowRedirects(followRedirects_t follow) @@ -481,7 +481,7 @@ int HTTPClient::sendRequest(const char * type, const uint8_t * payload, size_t s // no redirection break; } - // redirect using the same request method and payload, diffrent URL + // redirect using the same request method and payload, different URL redirect = true; } break; @@ -703,7 +703,7 @@ const String& HTTPClient::getString(void) _payload.reset(new StreamString()); if(_size > 0) { - // try to reserve needed memmory + // try to reserve needed memory if(!_payload->reserve((_size + 1))) { DEBUG_HTTPCLIENT("[HTTP-Client][getString] not enough memory to reserve a string! need: %d\n", (_size + 1)); return *_payload; diff --git a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h index 4469948812..3605a807f3 100644 --- a/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h +++ b/libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h @@ -161,7 +161,7 @@ class HTTPClient bool begin(WiFiClient &client, const String& url); bool begin(WiFiClient &client, const String& host, uint16_t port, const String& uri = "/", bool https = false); - // old API is now explicitely forbidden + // old API is now explicitly forbidden bool begin(String url) __attribute__ ((error("obsolete API, use ::begin(WiFiClient, url)"))); bool begin(String host, uint16_t port, String uri = "/") __attribute__ ((error("obsolete API, use ::begin(WiFiClient, host, port, uri)"))); bool begin(String url, const uint8_t httpsFingerprint[20]) __attribute__ ((error("obsolete API, use ::begin(WiFiClientSecure, ...)"))); diff --git a/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h b/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h index 966a73eefc..3357f2ac63 100644 --- a/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h +++ b/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h @@ -72,7 +72,7 @@ void ESP8266HTTPUpdateServerTemplate::setup(ESP8266WebServerTemplate ESP.restart(); } },[&](){ - // handler for the file upload, get's the sketch bytes, and writes + // handler for the file upload, gets the sketch bytes, and writes // them through the Update object HTTPUpload& upload = _server->upload(); diff --git a/libraries/ESP8266LLMNR/ESP8266LLMNR.cpp b/libraries/ESP8266LLMNR/ESP8266LLMNR.cpp index ac8582c579..d5d61ca89c 100644 --- a/libraries/ESP8266LLMNR/ESP8266LLMNR.cpp +++ b/libraries/ESP8266LLMNR/ESP8266LLMNR.cpp @@ -7,7 +7,7 @@ * Version 1.1 * Copyright (c) 2013 Tony DiCola (tony@tonydicola.com) * ESP8266 port (c) 2015 Ivan Grokhotkov (ivan@esp8266.com) - * MDNS-SD Suport 2015 Hristo Gochkov + * MDNS-SD Support 2015 Hristo Gochkov * Extended MDNS-SD support 2016 Lars Englund (lars.englund@gmail.com) * * License (MIT license): diff --git a/libraries/ESP8266LLMNR/ESP8266LLMNR.h b/libraries/ESP8266LLMNR/ESP8266LLMNR.h index 4ad1d4a74d..76c96ab87b 100644 --- a/libraries/ESP8266LLMNR/ESP8266LLMNR.h +++ b/libraries/ESP8266LLMNR/ESP8266LLMNR.h @@ -7,7 +7,7 @@ * Version 1.1 * Copyright (c) 2013 Tony DiCola (tony@tonydicola.com) * ESP8266 port (c) 2015 Ivan Grokhotkov (ivan@esp8266.com) - * MDNS-SD Suport 2015 Hristo Gochkov + * MDNS-SD Support 2015 Hristo Gochkov * Extended MDNS-SD support 2016 Lars Englund (lars.englund@gmail.com) * * License (MIT license): diff --git a/libraries/ESP8266LLMNR/README.md b/libraries/ESP8266LLMNR/README.md index 2ecdf973ef..e24d287462 100644 --- a/libraries/ESP8266LLMNR/README.md +++ b/libraries/ESP8266LLMNR/README.md @@ -25,7 +25,7 @@ Usage file. 2. Include the ESP8266LLMNR library in the sketch. 3. Call the LLMNR.begin() method in the sketch's setup() function, and provide - the hostname to advertize. This should not include any ".local" prefix. + the hostname to advertise. This should not include any ".local" prefix. 4. If ESP8266 AP mode is enabled, disabled, or the WiFi or AP configuration is changed, call LLMNR.notify_ap_change() after the change is made. @@ -70,7 +70,7 @@ ESP8266 Multicast DNS (port of CC3000 Multicast DNS library) Version 1.1 Copyright (c) 2013 Tony DiCola (tony@tonydicola.com) ESP8266 port (c) 2015 Ivan Grokhotkov (ivan@esp8266.com) -MDNS-SD Suport 2015 Hristo Gochkov +MDNS-SD Support 2015 Hristo Gochkov Extended MDNS-SD support 2016 Lars Englund (lars.englund@gmail.com) Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/libraries/ESP8266LLMNR/examples/LLMNR_Web_Server/LLMNR_Web_Server.ino b/libraries/ESP8266LLMNR/examples/LLMNR_Web_Server/LLMNR_Web_Server.ino index b1f4dca186..6b29bb5141 100644 --- a/libraries/ESP8266LLMNR/examples/LLMNR_Web_Server/LLMNR_Web_Server.ino +++ b/libraries/ESP8266LLMNR/examples/LLMNR_Web_Server/LLMNR_Web_Server.ino @@ -7,7 +7,7 @@ Version 1.1 Copyright (c) 2013 Tony DiCola (tony@tonydicola.com) ESP8266 port (c) 2015 Ivan Grokhotkov (ivan@esp8266.com) - MDNS-SD Suport 2015 Hristo Gochkov + MDNS-SD Support 2015 Hristo Gochkov Extended MDNS-SD support 2016 Lars Englund (lars.englund@gmail.com) License (MIT license): diff --git a/libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino b/libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino index f6aff52c7d..39f69fe3ff 100644 --- a/libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino +++ b/libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino @@ -171,7 +171,7 @@ void handleStatus() { /* Return the list of files in the directory specified by the "dir" query string parameter. - Also demonstrates the use of chuncked responses. + Also demonstrates the use of chunked responses. */ void handleFileList() { if (!fsOK) { @@ -479,7 +479,7 @@ void handleFileUpload() { /* - The "Not Found" handler catches all URI not explicitely declared in code + The "Not Found" handler catches all URI not explicitly declared in code First try to find and return the requested file from the filesystem, and if it fails, return a 404 page with debug information */ @@ -555,7 +555,7 @@ void setup(void) { DBG_OUTPUT_PORT.println(fsOK ? F("Filesystem initialized.") : F("Filesystem init failed!")); #ifdef USE_SPIFFS - // Debug: dump on console contents of filessytem with no filter and check filenames validity + // Debug: dump on console contents of filesystem with no filter and check filenames validity Dir dir = fileSystem->openDir(""); DBG_OUTPUT_PORT.println(F("List of files at root of filesystem:")); while (dir.next()) { diff --git a/libraries/ESP8266WebServer/examples/Graph/Graph.ino b/libraries/ESP8266WebServer/examples/Graph/Graph.ino index 4f73455676..b0eb5f847b 100644 --- a/libraries/ESP8266WebServer/examples/Graph/Graph.ino +++ b/libraries/ESP8266WebServer/examples/Graph/Graph.ino @@ -134,7 +134,7 @@ bool handleFileRead(String path) { /* - The "Not Found" handler catches all URI not explicitely declared in code + The "Not Found" handler catches all URI not explicitly declared in code First try to find and return the requested file from the filesystem, and if it fails, return a 404 page with debug information */ diff --git a/libraries/ESP8266WiFi/examples/BearSSL_MaxFragmentLength/BearSSL_MaxFragmentLength.ino b/libraries/ESP8266WiFi/examples/BearSSL_MaxFragmentLength/BearSSL_MaxFragmentLength.ino index 62b5f03343..708d906eb1 100644 --- a/libraries/ESP8266WiFi/examples/BearSSL_MaxFragmentLength/BearSSL_MaxFragmentLength.ino +++ b/libraries/ESP8266WiFi/examples/BearSSL_MaxFragmentLength/BearSSL_MaxFragmentLength.ino @@ -73,7 +73,7 @@ int fetchMaxFragmentLength() { // returns true then you can use the ::setBufferSizes(rx, tx) to shrink // the needed BearSSL memory while staying within protocol limits. // - // If MFLN is not supported, you may still be able to mimimize the buffer + // If MFLN is not supported, you may still be able to minimize the buffer // sizes assuming you can ensure the server never transmits fragments larger // than the size (i.e. by using HTTP GET RANGE methods, etc.). diff --git a/libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino b/libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino index 972f0ebabd..30bc07034e 100644 --- a/libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino +++ b/libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino @@ -142,7 +142,7 @@ GBEnkz4KpKv7TkHoW+j7F5EMcLcSrUIpyw== #define USE_CACHE // Enable SSL session caching. // Caching SSL sessions shortens the length of the SSL handshake. // You can see the performance improvement by looking at the - // Network tab of the developper tools of your browser. + // Network tab of the developer tools of your browser. //#define DYNAMIC_CACHE // Whether to dynamically allocate the cache. #if defined(USE_CACHE) && defined(DYNAMIC_CACHE) diff --git a/libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino b/libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino index d615497073..da36647d31 100644 --- a/libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino +++ b/libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino @@ -135,7 +135,7 @@ vEsXCS+0yx5DaMkHJ8HSXPfqIbloEpw8nL+e/IBcm2PN7EeqJSdnoDfzAIJ9VNep BearSSL::Session session; client.setSession(&session); - Serial.printf("Connecting with an unitialized session..."); + Serial.printf("Connecting with an uninitialized session..."); start = millis(); client.setTrustAnchors(&cert); fetchURL(&client, host, port, path); diff --git a/libraries/ESP8266WiFi/examples/HTTPSRequest/HTTPSRequest.ino b/libraries/ESP8266WiFi/examples/HTTPSRequest/HTTPSRequest.ino index 4daed82529..3767d1dbb1 100644 --- a/libraries/ESP8266WiFi/examples/HTTPSRequest/HTTPSRequest.ino +++ b/libraries/ESP8266WiFi/examples/HTTPSRequest/HTTPSRequest.ino @@ -123,7 +123,7 @@ void setup() { } String line = client.readStringUntil('\n'); if (line.startsWith("{\"state\":\"success\"")) { - Serial.println("esp8266/Arduino CI successfull!"); + Serial.println("esp8266/Arduino CI successful!"); } else { Serial.println("esp8266/Arduino CI has failed"); } diff --git a/libraries/ESP8266WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino b/libraries/ESP8266WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino index 46a4f277dd..9d085bb2ff 100644 --- a/libraries/ESP8266WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino +++ b/libraries/ESP8266WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino @@ -149,7 +149,7 @@ void loop() { //check TCP clients for data #if 1 - // Incredibly, this code is faster than the bufferred one below - #4620 is needed + // Incredibly, this code is faster than the buffered one below - #4620 is needed // loopback/3000000baud average 348KB/s for (int i = 0; i < MAX_SRV_CLIENTS; i++) while (serverClients[i].available() && Serial.availableForWrite() > 0) { diff --git a/libraries/ESP8266WiFi/src/BearSSLHelpers.h b/libraries/ESP8266WiFi/src/BearSSLHelpers.h index d91c8211d5..397a557522 100644 --- a/libraries/ESP8266WiFi/src/BearSSLHelpers.h +++ b/libraries/ESP8266WiFi/src/BearSSLHelpers.h @@ -161,7 +161,7 @@ class ServerSessions { ServerSessions(ServerSession *sessions, uint32_t size) : ServerSessions(sessions, size, false) {} // Dynamically allocates a cache for the given number of sessions and initializes it. - // If the allocation of the buffer wasn't successfull, the value + // If the allocation of the buffer wasn't successful, the value // returned by size() will be 0. ServerSessions(uint32_t size) : ServerSessions(size > 0 ? new ServerSession[size] : nullptr, size, true) {} @@ -178,7 +178,7 @@ class ServerSessions { // Size of the store in sessions. uint32_t _size; - // Store where the informations for the sessions are stored. + // Store where the information for the sessions are stored. ServerSession *_store; // Whether the store is dynamically allocated. // If this is true, the store needs to be freed in the destructor. diff --git a/libraries/ESP8266WiFi/src/ESP8266WiFiMulti.cpp b/libraries/ESP8266WiFi/src/ESP8266WiFiMulti.cpp index f41699d01d..8d74f687cb 100644 --- a/libraries/ESP8266WiFi/src/ESP8266WiFiMulti.cpp +++ b/libraries/ESP8266WiFi/src/ESP8266WiFiMulti.cpp @@ -273,7 +273,7 @@ int8_t ESP8266WiFiMulti::startScan() * @param connectTimeoutMs * WiFi connect timeout in ms * @return - * WiFi conneciton status + * WiFi connection status */ wl_status_t ESP8266WiFiMulti::connectWiFiMulti(uint32_t connectTimeoutMs) { diff --git a/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp b/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp index 6255c4be86..dd910295dd 100644 --- a/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp +++ b/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp @@ -506,7 +506,7 @@ IPAddress ESP8266WiFiSTAClass::dnsIP(uint8_t dns_no) { /** * Get the broadcast ip address. - * @return IPAddress Bradcast IP + * @return IPAddress Broadcast IP */ IPAddress ESP8266WiFiSTAClass::broadcastIP() { diff --git a/libraries/ESP8266WiFi/src/WiFiClientSecureBearSSL.cpp b/libraries/ESP8266WiFi/src/WiFiClientSecureBearSSL.cpp index b888530a66..d0e7c00fa0 100644 --- a/libraries/ESP8266WiFi/src/WiFiClientSecureBearSSL.cpp +++ b/libraries/ESP8266WiFi/src/WiFiClientSecureBearSSL.cpp @@ -947,7 +947,7 @@ extern "C" { uint16_t suites[cipher_cnt]; memcpy_P(suites, cipher_list, cipher_cnt * sizeof(cipher_list[0])); br_ssl_client_zero(cc); - br_ssl_engine_add_flags(&cc->eng, BR_OPT_NO_RENEGOTIATION); // forbid SSL renegociation, as we free the Private Key after handshake + br_ssl_engine_add_flags(&cc->eng, BR_OPT_NO_RENEGOTIATION); // forbid SSL renegotiation, as we free the Private Key after handshake br_ssl_engine_set_versions(&cc->eng, BR_TLS10, BR_TLS12); br_ssl_engine_set_suites(&cc->eng, suites, (sizeof suites) / (sizeof suites[0])); br_ssl_client_set_default_rsapub(cc); @@ -973,7 +973,7 @@ extern "C" { uint16_t suites[cipher_cnt]; memcpy_P(suites, cipher_list, cipher_cnt * sizeof(cipher_list[0])); br_ssl_server_zero(cc); - br_ssl_engine_add_flags(&cc->eng, BR_OPT_NO_RENEGOTIATION); // forbid SSL renegociation, as we free the Private Key after handshake + br_ssl_engine_add_flags(&cc->eng, BR_OPT_NO_RENEGOTIATION); // forbid SSL renegotiation, as we free the Private Key after handshake br_ssl_engine_set_versions(&cc->eng, BR_TLS10, BR_TLS12); br_ssl_engine_set_suites(&cc->eng, suites, (sizeof suites) / (sizeof suites[0])); #ifndef BEARSSL_SSL_BASIC diff --git a/libraries/ESP8266WiFi/src/WiFiServer.h b/libraries/ESP8266WiFi/src/WiFiServer.h index 59aea48faf..f061938385 100644 --- a/libraries/ESP8266WiFi/src/WiFiServer.h +++ b/libraries/ESP8266WiFi/src/WiFiServer.h @@ -34,7 +34,7 @@ extern "C" { // lwIP-v2 backlog facility allows to keep memory safe by limiting the // maximum number of incoming *pending clients*. Default number of possibly // simultaneously pending clients is defined in WiFiServer.cpp -// (MAX_PENDING_CLIENTS_PER_PORT=5). User can overide it at runtime from +// (MAX_PENDING_CLIENTS_PER_PORT=5). User can override it at runtime from // sketch: // WiFiServer::begin(port, max-simultaneous-pending-clients); // diff --git a/libraries/ESP8266WiFi/src/WiFiUdp.h b/libraries/ESP8266WiFi/src/WiFiUdp.h index a1cf42be10..9e72eb66ca 100644 --- a/libraries/ESP8266WiFi/src/WiFiUdp.h +++ b/libraries/ESP8266WiFi/src/WiFiUdp.h @@ -44,7 +44,7 @@ class WiFiUDP : public UDP, public SList { // initialize, start listening on specified port. // Returns 1 if successful, 0 if there are no sockets available to use uint8_t begin(uint16_t port) override; - // Finish with the UDP connetion + // Finish with the UDP connection void stop() override; // join a multicast group and listen on the given port uint8_t beginMulticast(IPAddress interfaceAddr, IPAddress multicast, uint16_t port); @@ -58,7 +58,7 @@ class WiFiUDP : public UDP, public SList { // Returns 1 if successful, 0 if there was a problem resolving the hostname or port int beginPacket(const char *host, uint16_t port) override; // Start building up a packet to send to the multicast address - // multicastAddress - muticast address to send to + // multicastAddress - multicast address to send to // interfaceAddress - the local IP address of the interface that should be used // use WiFi.localIP() or WiFi.softAPIP() depending on the interface you need // ttl - multicast packet TTL (default is 1) diff --git a/libraries/ESP8266WiFi/src/enable_wifi_at_boot_time.cpp b/libraries/ESP8266WiFi/src/enable_wifi_at_boot_time.cpp index 575d0317ed..5eb62eec15 100644 --- a/libraries/ESP8266WiFi/src/enable_wifi_at_boot_time.cpp +++ b/libraries/ESP8266WiFi/src/enable_wifi_at_boot_time.cpp @@ -1,5 +1,5 @@ /* - * empty wrappers to play with linker and reenable wifi at boot time + * empty wrappers to play with linker and re-enable wifi at boot time */ #include "coredecls.h" @@ -21,7 +21,7 @@ extern "C" void __disableWiFiAtBootTime() // Does (almost) nothing: WiFi is enabled by default in nonos-sdk // ... but restores legacy WiFi credentials persistence to true at boot time - // (can be still overriden by user before setting up WiFi, like before) + // (can be still overrisden by user before setting up WiFi, like before) // (note: c++ ctors not called yet at this point) ESP8266WiFiClass::persistent(true); diff --git a/libraries/ESP8266WiFi/src/include/UdpContext.h b/libraries/ESP8266WiFi/src/include/UdpContext.h index 0c43cd2adb..1d3c6e418c 100644 --- a/libraries/ESP8266WiFi/src/include/UdpContext.h +++ b/libraries/ESP8266WiFi/src/include/UdpContext.h @@ -186,7 +186,7 @@ class UdpContext // this helper is ready to be used when debugging UDP void printChain (const pbuf* pb, const char* msg, size_t n) const { - // printf the pb pbuf chain, bufferred and all at once + // printf the pb pbuf chain, buffered and all at once char buf[128]; int l = snprintf(buf, sizeof(buf), "UDP: %s %u: ", msg, n); while (pb) @@ -266,7 +266,7 @@ class UdpContext return true; } - // We have interleaved informations on addresses within received pbuf chain: + // We have interleaved information on addresses within received pbuf chain: // (before ipv6 code we had: (data-pbuf) -> (data-pbuf) -> (data-pbuf) -> ... in the receiving order) // Now: (address-info-pbuf -> chained-data-pbuf [-> chained-data-pbuf...]) -> // (chained-address-info-pbuf -> chained-data-pbuf [-> chained...]) -> ... diff --git a/libraries/ESP8266WiFiMesh/README.md b/libraries/ESP8266WiFiMesh/README.md index 4bfd019928..d9c7a4344a 100644 --- a/libraries/ESP8266WiFiMesh/README.md +++ b/libraries/ESP8266WiFiMesh/README.md @@ -286,7 +286,7 @@ It is important to realize that there is no global message ID counter, only the ### My ESP8266 crashes on start-up when I use the library! -This could be caused by incorrect arguments to the constructors of the library. Usually you would get a Serial Monitor print of the error in question, but if the constructor is called before you call `Serial.begin(115200)` then there will be nothing to print to. The solution is first to check so that all constructor arguments are valid, e.g. that the mesh password has the correct length and does not contain any forbidden characters. If everything checks out you can try to move all the library contructors you use into the `setup()` function of your sketch, after the position where `Serial.begin(115200)` is called. That should give you a proper error message in the Serial Monitor, so you can locate the problem. +This could be caused by incorrect arguments to the constructors of the library. Usually you would get a Serial Monitor print of the error in question, but if the constructor is called before you call `Serial.begin(115200)` then there will be nothing to print to. The solution is first to check so that all constructor arguments are valid, e.g. that the mesh password has the correct length and does not contain any forbidden characters. If everything checks out you can try to move all the library constructors you use into the `setup()` function of your sketch, after the position where `Serial.begin(115200)` is called. That should give you a proper error message in the Serial Monitor, so you can locate the problem. ### The node does not remember the SSID I assign to it! @@ -395,4 +395,4 @@ There has been some reports about this happening when the ESP8266 is in AP+STA m A possible workaround is to use only AP mode or STA mode (see "[I want to control the WiFi mode myself](#FAQModeControl)"), perhaps with an extra ESP8266 in one of these modes as a buffer between your ESP8266 mesh network and your router. Remember that the ESP8266 must have the AP active in order to receive ESP-NOW broadcast messages. -Another possible workaround is to try with a different router or router firmware. \ No newline at end of file +Another possible workaround is to try with a different router or router firmware. diff --git a/libraries/ESP8266WiFiMesh/examples/HelloEspnow/HelloEspnow.ino b/libraries/ESP8266WiFiMesh/examples/HelloEspnow/HelloEspnow.ino index 3b90a6ef11..443d52e2bb 100644 --- a/libraries/ESP8266WiFiMesh/examples/HelloEspnow/HelloEspnow.ino +++ b/libraries/ESP8266WiFiMesh/examples/HelloEspnow/HelloEspnow.ino @@ -53,7 +53,7 @@ EspnowMeshBackend espnowNode = EspnowMeshBackend(manageRequest, manageResponse, @param request The request string received from another node in the mesh @param meshInstance The MeshBackendBase instance that called the function. - @return The string to send back to the other node. For ESP-NOW, return an empy string ("") if no response should be sent. + @return The string to send back to the other node. For ESP-NOW, return an empty string ("") if no response should be sent. */ String manageRequest(const String &request, MeshBackendBase &meshInstance) { // To get the actual class of the polymorphic meshInstance, do as follows (meshBackendCast replaces dynamic_cast since RTTI is disabled) @@ -346,7 +346,7 @@ void loop() { espnowDelay(100); // Wait for responses (broadcasts can receive an unlimited number of responses, other transmissions can only receive one response). // If you have a data array containing null values it is possible to transmit the raw data by making the array into a multiString as shown below. - // You can use String::c_str() or String::begin() to retreive the data array later. + // You can use String::c_str() or String::begin() to retrieve the data array later. // Note that certain String methods such as String::substring use null values to determine String length, which means they will not work as normal with multiStrings. uint8_t dataArray[] = {0, '\'', 0, '\'', ' ', '(', 'n', 'u', 'l', 'l', ')', ' ', 'v', 'a', 'l', 'u', 'e'}; String espnowMessage = TypeCast::uint8ArrayToMultiString(dataArray, sizeof dataArray) + F(" from ") + espnowNode.getMeshName() + espnowNode.getNodeID() + String('.'); diff --git a/libraries/ESP8266WiFiMesh/examples/HelloTcpIp/HelloTcpIp.ino b/libraries/ESP8266WiFiMesh/examples/HelloTcpIp/HelloTcpIp.ino index 661f2249cd..f68b81f181 100644 --- a/libraries/ESP8266WiFiMesh/examples/HelloTcpIp/HelloTcpIp.ino +++ b/libraries/ESP8266WiFiMesh/examples/HelloTcpIp/HelloTcpIp.ino @@ -37,7 +37,7 @@ TcpIpMeshBackend tcpIpNode = TcpIpMeshBackend(manageRequest, manageResponse, net @param request The request string received from another node in the mesh @param meshInstance The MeshBackendBase instance that called the function. - @return The string to send back to the other node. For ESP-NOW, return an empy string ("") if no response should be sent. + @return The string to send back to the other node. For ESP-NOW, return an empty string ("") if no response should be sent. */ String manageRequest(const String &request, MeshBackendBase &meshInstance) { // To get the actual class of the polymorphic meshInstance, do as follows (meshBackendCast replaces dynamic_cast since RTTI is disabled) diff --git a/libraries/ESP8266WiFiMesh/src/CompatibilityLayer.cpp b/libraries/ESP8266WiFiMesh/src/CompatibilityLayer.cpp index 0bb480acd0..537b58d061 100644 --- a/libraries/ESP8266WiFiMesh/src/CompatibilityLayer.cpp +++ b/libraries/ESP8266WiFiMesh/src/CompatibilityLayer.cpp @@ -84,7 +84,7 @@ bool ESP8266WiFiMesh::waitForClient(WiFiClient &currClient, int maxWait) * and pass that to the user-supplied handler. * * @message The string to send to the node. - * @returns: True if the exchange was a succes, false otherwise. + * @returns: True if the exchange was a success, false otherwise. * */ // DEPRECATED! @@ -178,4 +178,4 @@ template void ESP8266WiFiMesh::attemptScan(char (&message)[Size]) { attemptScanKernel(message); -} \ No newline at end of file +} diff --git a/libraries/ESP8266WiFiMesh/src/ESP8266WiFiMesh.h b/libraries/ESP8266WiFiMesh/src/ESP8266WiFiMesh.h index 8647502bb3..e070b07b88 100644 --- a/libraries/ESP8266WiFiMesh/src/ESP8266WiFiMesh.h +++ b/libraries/ESP8266WiFiMesh/src/ESP8266WiFiMesh.h @@ -182,7 +182,7 @@ class ESP8266WiFiMesh { * A vector that contains the NetworkInfo for each WiFi network to connect to. * The connectionQueue vector is cleared before each new scan and filled via the networkFilter callback function once the scan completes. * WiFi connections will start with connectionQueue[0] and then incrementally proceed to higher vector positions. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. */ static std::vector connectionQueue; @@ -190,7 +190,7 @@ class ESP8266WiFiMesh { * A vector with the TransmissionResult for each AP to which a transmission was attempted during the latest attemptTransmission call. * The latestTransmissionOutcomes vector is cleared before each new transmission attempt. * Connection attempts are indexed in the same order they were attempted. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. */ static std::vector latestTransmissionOutcomes; diff --git a/libraries/ESP8266WiFiMesh/src/EspnowMeshBackend.h b/libraries/ESP8266WiFiMesh/src/EspnowMeshBackend.h index 4519372f3d..08a99673bc 100644 --- a/libraries/ESP8266WiFiMesh/src/EspnowMeshBackend.h +++ b/libraries/ESP8266WiFiMesh/src/EspnowMeshBackend.h @@ -172,7 +172,7 @@ class EspnowMeshBackend : public MeshBackendBase { * This vector is unique for each mesh backend, but NetworkInfo elements can be directly transferred between the vectors as long as both SSID and BSSID are present. * The connectionQueue vector is cleared before each new scan and filled via the networkFilter callback function once the scan completes. * WiFi connections will start with connectionQueue[0] and then incrementally proceed to higher vector positions. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. * * Since the connectionQueue() is iterated over during transmissions, always use constConnectionQueue() from callbacks other than NetworkFilter. */ @@ -188,7 +188,7 @@ class EspnowMeshBackend : public MeshBackendBase { * This vector is unique for each mesh backend. * The latestTransmissionOutcomes vector is cleared before each new transmission attempt. * Connection attempts are indexed in the same order they were attempted. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. */ static std::vector & latestTransmissionOutcomes(); @@ -260,7 +260,7 @@ class EspnowMeshBackend : public MeshBackendBase { /* * Will ensure that an encrypted connection exists to each target node before sending the message, - * establishing a temporary encrypted connection with duration getAutoEncryptionDuration() first if neccessary. + * establishing a temporary encrypted connection with duration getAutoEncryptionDuration() first if necessary. * If an encrypted connection cannot be established to a target node, no message will be sent to that node. * Note that if an encrypted connection to a target node is not present before this method is called, the response from said node will likely not be received * since it will be encrypted and the auto encrypted connection to the node is immediately removed after transmission (unless the requestPermanentConnections argument is set to true). @@ -808,7 +808,7 @@ class EspnowMeshBackend : public MeshBackendBase { * @param peerMac The MAC of the other node to which the request should be sent. * @param durationMs The desired duration of the connection. * - * @return EncryptedConnectionStatus::CONNECTION_ESTABLISHED if the request was succesful. EncryptedConnectionStatus::SOFT_LIMIT_CONNECTION_ESTABLISHED if only a temporary soft limit connection could be established (see the setEncryptedConnectionsSoftLimit method documentation for details). Otherwise another status code based on the outcome. + * @return EncryptedConnectionStatus::CONNECTION_ESTABLISHED if the request was successful. EncryptedConnectionStatus::SOFT_LIMIT_CONNECTION_ESTABLISHED if only a temporary soft limit connection could be established (see the setEncryptedConnectionsSoftLimit method documentation for details). Otherwise another status code based on the outcome. */ EncryptedConnectionStatus requestTemporaryEncryptedConnection(const uint8_t *peerMac, const uint32_t durationMs); @@ -825,7 +825,7 @@ class EspnowMeshBackend : public MeshBackendBase { * @param peerMac The MAC of the other node to which the request should be sent. * @param minDurationMs The desired minimum duration of the connection. * - * @return EncryptedConnectionStatus::CONNECTION_ESTABLISHED if the request was succesful. EncryptedConnectionStatus::SOFT_LIMIT_CONNECTION_ESTABLISHED if only a temporary soft limit connection could be established (see the setEncryptedConnectionsSoftLimit method documentation for details). Otherwise another status code based on the outcome. + * @return EncryptedConnectionStatus::CONNECTION_ESTABLISHED if the request was successful. EncryptedConnectionStatus::SOFT_LIMIT_CONNECTION_ESTABLISHED if only a temporary soft limit connection could be established (see the setEncryptedConnectionsSoftLimit method documentation for details). Otherwise another status code based on the outcome. */ EncryptedConnectionStatus requestFlexibleTemporaryEncryptedConnection(const uint8_t *peerMac, const uint32_t minDurationMs); diff --git a/libraries/ESP8266WiFiMesh/src/EspnowTransmitter.cpp b/libraries/ESP8266WiFiMesh/src/EspnowTransmitter.cpp index 3670844c86..7909a7be06 100644 --- a/libraries/ESP8266WiFiMesh/src/EspnowTransmitter.cpp +++ b/libraries/ESP8266WiFiMesh/src/EspnowTransmitter.cpp @@ -317,7 +317,7 @@ TransmissionStatusType EspnowTransmitter::espnowSendToNodeUnsynchronized(const S transmission[transmissionsRemainingIndex] = (char)transmissionsRemaining; } - // Fills indicies in range [transmissionMacIndex, transmissionMacIndex + 5] (6 bytes) with the MAC address of the WiFi AP interface. + // Fills indices in range [transmissionMacIndex, transmissionMacIndex + 5] (6 bytes) with the MAC address of the WiFi AP interface. // We always transmit from the station interface (due to using ESP_NOW_ROLE_CONTROLLER), so this makes it possible to always know both interface MAC addresses of a node that sends a transmission. WiFi.softAPmacAddress(transmission + transmissionMacIndex); @@ -391,7 +391,7 @@ TransmissionStatusType EspnowTransmitter::espnowSendToNodeUnsynchronized(const S return TransmissionStatusType::TRANSMISSION_FAILED; } - --transmissionsRemaining; // This is used when transfering multi-transmission messages. + --transmissionsRemaining; // This is used when transferring multi-transmission messages. } while(transmissionsRemaining >= 0); diff --git a/libraries/ESP8266WiFiMesh/src/FloodingMesh.cpp b/libraries/ESP8266WiFiMesh/src/FloodingMesh.cpp index 434df2fca7..1d6f064ae3 100644 --- a/libraries/ESP8266WiFiMesh/src/FloodingMesh.cpp +++ b/libraries/ESP8266WiFiMesh/src/FloodingMesh.cpp @@ -386,7 +386,7 @@ void FloodingMesh::restoreDefaultResponseTransmittedHook() * * @param request The request string received from another node in the mesh * @param meshInstance The MeshBackendBase instance that called the function. - * @return The string to send back to the other node. For ESP-NOW, return an empy string ("") if no response should be sent. + * @return The string to send back to the other node. For ESP-NOW, return an empty string ("") if no response should be sent. */ String FloodingMesh::_defaultRequestHandler(const String &request, MeshBackendBase &meshInstance) { diff --git a/libraries/ESP8266WiFiMesh/src/FloodingMesh.h b/libraries/ESP8266WiFiMesh/src/FloodingMesh.h index eccbb8e96d..43131ca3fd 100644 --- a/libraries/ESP8266WiFiMesh/src/FloodingMesh.h +++ b/libraries/ESP8266WiFiMesh/src/FloodingMesh.h @@ -182,7 +182,7 @@ class FloodingMesh { * * ########## WARNING! This an experimental feature. API may change at any time. Only use if you like it when things break. ########## * Will be very slow compared to unencrypted broadcasts. Probably works OK in a small mesh with a maximum of 2-3 new messages transmitted in the mesh every second. - * Because of the throughput difference, mixing encypted and unencrypted broadcasts is not recommended if there are frequent mesh broadcasts (multiple per second), + * Because of the throughput difference, mixing encrypted and unencrypted broadcasts is not recommended if there are frequent mesh broadcasts (multiple per second), * since a lot of unencrypted broadcasts can build up while a single encrypted broadcast is sent. * * It is recommended that verboseMode is turned off if using this, to avoid slowdowns due to excessive Serial printing. diff --git a/libraries/ESP8266WiFiMesh/src/TcpIpMeshBackend.h b/libraries/ESP8266WiFiMesh/src/TcpIpMeshBackend.h index 9b3de94eb4..8aca27db0c 100644 --- a/libraries/ESP8266WiFiMesh/src/TcpIpMeshBackend.h +++ b/libraries/ESP8266WiFiMesh/src/TcpIpMeshBackend.h @@ -70,7 +70,7 @@ class TcpIpMeshBackend : public MeshBackendBase { * This vector is unique for each mesh backend, but NetworkInfo elements can be directly transferred between the vectors as long as both SSID and BSSID are present. * The connectionQueue vector is cleared before each new scan and filled via the networkFilter callback function once the scan completes. * WiFi connections will start with connectionQueue[0] and then incrementally proceed to higher vector positions. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. * * Since the connectionQueue() is iterated over during transmissions, always use constConnectionQueue() from callbacks other than NetworkFilter. */ @@ -86,7 +86,7 @@ class TcpIpMeshBackend : public MeshBackendBase { * This vector is unique for each mesh backend. * The latestTransmissionOutcomes vector is cleared before each new transmission attempt. * Connection attempts are indexed in the same order they were attempted. - * Note that old network indicies often are invalidated whenever a new WiFi network scan occurs. + * Note that old network indices often are invalidated whenever a new WiFi network scan occurs. */ static std::vector & latestTransmissionOutcomes(); diff --git a/libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.h b/libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.h index 88216070d7..a19b7c81ec 100755 --- a/libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.h +++ b/libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.h @@ -93,7 +93,7 @@ class ESP8266HTTPUpdate _followRedirects = follow ? HTTPC_STRICT_FOLLOW_REDIRECTS : HTTPC_DISABLE_FOLLOW_REDIRECTS; } /** - * set redirect follow mode. See `followRedirects_t` enum for avaliable modes. + * set redirect follow mode. See `followRedirects_t` enum for available modes. * @param follow */ void setFollowRedirects(followRedirects_t follow) diff --git a/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_Clock/mDNS_Clock.ino b/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_Clock/mDNS_Clock.ino index ec0320fdb2..f0a9de1225 100644 --- a/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_Clock/mDNS_Clock.ino +++ b/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_Clock/mDNS_Clock.ino @@ -3,7 +3,7 @@ This example demonstrates two features of the LEA MDNSResponder: 1. The host and service domain negotiation process that ensures - the uniqueness of the finally choosen host and service domain name. + the uniqueness of the finally chosen host and service domain name. 2. The dynamic MDNS service TXT feature A 'clock' service in announced via the MDNS responder and the current @@ -11,7 +11,7 @@ The time value is updated every second! The ESP is initially announced to clients as 'esp8266.local', if this host domain - is already used in the local network, another host domain is negociated. Keep an + is already used in the local network, another host domain is negotiated. Keep an eye to the serial output to learn the final host domain for the clock service. The service itself is is announced as 'host domain'._espclk._tcp.local. As the service uses port 80, a very simple HTTP server is installed also to deliver @@ -57,7 +57,7 @@ const char* ssid = STASSID; const char* password = STAPSK; -char* pcHostDomain = 0; // Negociated host domain +char* pcHostDomain = 0; // Negotiated host domain bool bHostDomainConfirmed = false; // Flags the confirmation of the host domain MDNSResponder::hMDNSService hMDNSService = 0; // The handle of the clock service in the MDNS responder @@ -90,7 +90,7 @@ void setClock(void) { configTime((TIMEZONE_OFFSET * 3600), (DST_OFFSET * 3600), "pool.ntp.org", "time.nist.gov", "time.windows.com"); Serial.print("Waiting for NTP time sync: "); - time_t now = time(nullptr); // Secs since 01.01.1970 (when uninitalized starts with (8 * 3600 = 28800) + time_t now = time(nullptr); // Secs since 01.01.1970 (when uninitialized starts with (8 * 3600 = 28800) while (now < 8 * 3600 * 2) { // Wait for realistic value delay(500); Serial.print("."); diff --git a/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_ServiceMonitor/mDNS_ServiceMonitor.ino b/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_ServiceMonitor/mDNS_ServiceMonitor.ino index 167a968c71..17b29ec57c 100644 --- a/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_ServiceMonitor/mDNS_ServiceMonitor.ino +++ b/libraries/ESP8266mDNS/examples/LEAmDNS/mDNS_ServiceMonitor/mDNS_ServiceMonitor.ino @@ -3,7 +3,7 @@ This example demonstrates two features of the LEA MDNSResponder: 1. The host and service domain negotiation process that ensures - the uniqueness of the finally choosen host and service domain name. + the uniqueness of the finally chosen host and service domain name. 2. The dynamic MDNS service lookup/query feature. A list of 'HTTP' services in the local network is created and kept up to date. @@ -11,7 +11,7 @@ and announced as a service. The ESP itself is initially announced to clients as 'esp8266.local', if this host domain - is already used in the local network, another host domain is negociated. Keep an + is already used in the local network, another host domain is negotiated. Keep an eye to the serial output to learn the final host domain for the HTTP service. The service itself is is announced as 'host domain'._http._tcp.local. The HTTP server delivers a short greeting and the current list of other 'HTTP' services (not updated). @@ -49,7 +49,7 @@ const char* ssid = STASSID; const char* password = STAPSK; -char* pcHostDomain = 0; // Negociated host domain +char* pcHostDomain = 0; // Negotiated host domain bool bHostDomainConfirmed = false; // Flags the confirmation of the host domain MDNSResponder::hMDNSService hMDNSService = 0; // The handle of the http service in the MDNS responder MDNSResponder::hMDNSServiceQuery hMDNSServiceQuery = 0; // The handle of the 'http.tcp' service query in the MDNS responder diff --git a/libraries/ESP8266mDNS/examples/OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino b/libraries/ESP8266mDNS/examples/OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino index 5e4a5a0810..87d03900f3 100644 --- a/libraries/ESP8266mDNS/examples/OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino +++ b/libraries/ESP8266mDNS/examples/OTA-mDNS-LittleFS/OTA-mDNS-LittleFS.ino @@ -55,9 +55,9 @@ const char* ap_default_psk = APPSK; ///< Default PSK. @param pass String pointer for storing PSK. @return True or False. - The config file have to containt the WiFi SSID in the first line + The config file has to contain the WiFi SSID in the first line and the WiFi PSK in the second line. - Line seperator can be \r\n (CR LF) \r or \n. + Line separator can be \r\n (CR LF) \r or \n. */ bool loadConfig(String *ssid, String *pass) { // open file for reading. @@ -74,7 +74,7 @@ bool loadConfig(String *ssid, String *pass) { content.trim(); - // Check if ther is a second line available. + // Check if there is a second line available. int8_t pos = content.indexOf("\r\n"); uint8_t le = 2; // check for linux and mac line ending. diff --git a/libraries/ESP8266mDNS/library.properties b/libraries/ESP8266mDNS/library.properties index 70b0f2ae68..6eed8345be 100644 --- a/libraries/ESP8266mDNS/library.properties +++ b/libraries/ESP8266mDNS/library.properties @@ -3,7 +3,7 @@ version=1.2 author=multiple, see files maintainer=LaborEtArs sentence=Creates a mDNS responder. -paragraph=Creates a mDNS responder to ensure host domain uniqueness in local networks and to allow for mDNS service discovery and announcment. +paragraph=Creates a mDNS responder to ensure host domain uniqueness in local networks and to allow for mDNS service discovery and announcement. category=Communication url=https://github.com/LaborEtArs/ESP8266mDNS architectures=esp8266 diff --git a/libraries/ESP8266mDNS/src/ESP8266mDNS.h b/libraries/ESP8266mDNS/src/ESP8266mDNS.h index 7c1a1bd5d7..777a4cb4c3 100644 --- a/libraries/ESP8266mDNS/src/ESP8266mDNS.h +++ b/libraries/ESP8266mDNS/src/ESP8266mDNS.h @@ -3,7 +3,7 @@ This file is part of the esp8266 core for Arduino environment. Legacy_ESP8266mDNS: - The well known, thouroughly tested (yet no flawless) default mDNS library for the ESP8266 family + The well known, thoroughly tested (yet no flawless) default mDNS library for the ESP8266 family LEA_ESP8266mDNS: An (currently) experimental mDNS implementation, that supports a lot more of mDNS features than Legacy_ESP8266mDNS, like: @@ -19,7 +19,7 @@ - Dynamic queries for DNS-SD services with cached and updated answers and user notifications - Support for multi-homed client host domains - See 'LEA_ESP8266mDNS/EPS8266mDNS.h' for more implementation details and usage informations. + See 'LEA_ESP8266mDNS/EPS8266mDNS.h' for more implementation details and usage information. See 'examples/mDNS_Clock' and 'examples/mDNS_ServiceMonitor' for implementation examples of the advanced features. LEA_ESP8266mDNS is (mostly) client source code compatible to 'Legacy_ESP8266mDNS', so it could be diff --git a/libraries/ESP8266mDNS/src/LEAmDNS.cpp b/libraries/ESP8266mDNS/src/LEAmDNS.cpp index 39756da6e7..4908a67e06 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS.cpp +++ b/libraries/ESP8266mDNS/src/LEAmDNS.cpp @@ -1132,7 +1132,7 @@ bool MDNSResponder::hasAnswerTxts(const MDNSResponder::hMDNSServiceQuery p_hServ MDNSResponder::answerTxts Returns all TXT items for the given service as a ';'-separated string. - If not already existing; the string is alloced, filled and attached to the answer. + If not already existing; the string is allocated, filled and attached to the answer. */ const char* MDNSResponder::answerTxts(const MDNSResponder::hMDNSServiceQuery p_hServiceQuery, @@ -1165,7 +1165,7 @@ const char* MDNSResponder::answerTxts(const MDNSResponder::hMDNSServiceQuery p_h Set a global callback for probe results. The callback is called, when probing for the host domain (or a service domain, without specific probe result callback) - failes or succeedes. + fails or succeeds. In the case of failure, the domain name should be changed via 'setHostname' or 'setServiceName'. When succeeded, the host or service domain will be announced by the MDNS responder. @@ -1191,7 +1191,7 @@ bool MDNSResponder::setHostProbeResultCallback(MDNSHostProbeFn1 pfn) MDNSResponder::setServiceProbeResultCallback Set a service specific callback for probe results. The callback is called, when probing - for the service domain failes or succeedes. + for the service domain fails or succeeds. In the case of failure, the service name should be changed via 'setServiceName'. When succeeded, the service domain will be announced by the MDNS responder. diff --git a/libraries/ESP8266mDNS/src/LEAmDNS.h b/libraries/ESP8266mDNS/src/LEAmDNS.h index bf2f1e9832..1c099c68ab 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS.h +++ b/libraries/ESP8266mDNS/src/LEAmDNS.h @@ -8,7 +8,7 @@ Essentially, this is an rewrite of the original EPS8266 Multicast DNS code (ESP8266mDNS). The target of this rewrite was to keep the existing interface as stable as possible while adding and extending the supported set of mDNS features. - A lot of the additions were basicly taken from Erik Ekman's lwIP mdns app code. + A lot of the additions were basically taken from Erik Ekman's lwIP mdns app code. Supported mDNS features (in some cases somewhat limited): - Presenting a DNS-SD service to interested observers, eg. a http server by presenting _http._tcp service @@ -52,7 +52,7 @@ Static: Call 'uint32_t u32AnswerCount = MDNS.queryService("http", "tcp");' Iterate answers by: 'for (uint32_t u=0; ugetInputNetif()->ip_addr); if (((stcMDNS_RRAnswerA*)pKnownRRAnswer)->m_IPAddress == localIPAddress) { - // SAME IP address -> We've received an old message from ourselfs (same IP) + // SAME IP address -> We've received an old message from ourselves (same IP) DEBUG_EX_RX(DEBUG_OUTPUT.printf_P(PSTR("[MDNSResponder] _parseQuery: Tiebreak (IP4) WON (was an old message)!\n"));); m_HostProbeInformation.m_bTiebreakNeeded = false; } @@ -410,7 +410,7 @@ bool MDNSResponder::_parseQuery(const MDNSResponder::stcMDNS_MsgHeader& p_MsgHea } else // WON tiebreak { - //TiebreakState = TiebreakState_Won; // We received an 'old' message from ourselfs -> Just ignore + //TiebreakState = TiebreakState_Won; // We received an 'old' message from ourselves -> Just ignore DEBUG_EX_RX(DEBUG_OUTPUT.printf_P(PSTR("[MDNSResponder] _parseQuery: Tiebreak (IP4) WON (higher IP)!\n"));); m_HostProbeInformation.m_bTiebreakNeeded = false; } @@ -501,7 +501,7 @@ bool MDNSResponder::_parseQuery(const MDNSResponder::stcMDNS_MsgHeader& p_MsgHea (hostDomain == ((stcMDNS_RRAnswerSRV*)pKnownRRAnswer)->m_SRVDomain)) // Host domain match { - // We've received an old message from ourselfs (same SRV) + // We've received an old message from ourselves (same SRV) DEBUG_EX_RX(DEBUG_OUTPUT.printf_P(PSTR("[MDNSResponder] _parseQuery: Tiebreak (SRV) won (was an old message)!\n"));); pService->m_ProbeInformation.m_bTiebreakNeeded = false; } @@ -516,7 +516,7 @@ bool MDNSResponder::_parseQuery(const MDNSResponder::stcMDNS_MsgHeader& p_MsgHea } else // WON tiebreak { - //TiebreakState = TiebreakState_Won; // We received an 'old' message from ourselfs -> Just ignore + //TiebreakState = TiebreakState_Won; // We received an 'old' message from ourselves -> Just ignore DEBUG_EX_RX(DEBUG_OUTPUT.printf_P(PSTR("[MDNSResponder] _parseQuery: Tiebreak (SRV) won (higher)!\n"));); pService->m_ProbeInformation.m_bTiebreakNeeded = false; } @@ -1560,7 +1560,7 @@ bool MDNSResponder::_announce(bool p_bAnnounce, bResult = true; - sendParameter.m_bResponse = true; // Announces are 'Unsolicited authorative responses' + sendParameter.m_bResponse = true; // Announces are 'Unsolicited authoritative responses' sendParameter.m_bAuthorative = true; sendParameter.m_bUnannounce = !p_bAnnounce; // When unannouncing, the TTL is set to '0' while creating the answers @@ -1612,7 +1612,7 @@ bool MDNSResponder::_announceService(stcMDNSService& p_rService, if (ProbingStatus_Done == p_rService.m_ProbeInformation.m_ProbingStatus) { - sendParameter.m_bResponse = true; // Announces are 'Unsolicited authorative responses' + sendParameter.m_bResponse = true; // Announces are 'Unsolicited authoritative responses' sendParameter.m_bAuthorative = true; sendParameter.m_bUnannounce = !p_bAnnounce; // When unannouncing, the TTL is set to '0' while creating the answers diff --git a/libraries/ESP8266mDNS/src/LEAmDNS_Helpers.cpp b/libraries/ESP8266mDNS/src/LEAmDNS_Helpers.cpp index 48f4e4c5ee..60087c16d8 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS_Helpers.cpp +++ b/libraries/ESP8266mDNS/src/LEAmDNS_Helpers.cpp @@ -245,7 +245,7 @@ bool MDNSResponder::_removeServiceQuery(MDNSResponder::stcMDNSServiceQuery* p_pS delete p_pServiceQuery; bResult = true; } - else // No predecesor + else // No predecessor { if (m_pServiceQueries == p_pServiceQuery) { @@ -275,7 +275,7 @@ bool MDNSResponder::_removeLegacyServiceQuery(void) /* MDNSResponder::_findServiceQuery - 'Convert' hMDNSServiceQuery to stcMDNSServiceQuery* (ensure existance) + 'Convert' hMDNSServiceQuery to stcMDNSServiceQuery* (ensure existence) */ MDNSResponder::stcMDNSServiceQuery* MDNSResponder::_findServiceQuery(MDNSResponder::hMDNSServiceQuery p_hServiceQuery) @@ -458,7 +458,7 @@ bool MDNSResponder::_releaseService(MDNSResponder::stcMDNSService* p_pService) delete p_pService; bResult = true; } - else // No predecesor + else // No predecessor { if (m_pServices == p_pService) { diff --git a/libraries/ESP8266mDNS/src/LEAmDNS_Priv.h b/libraries/ESP8266mDNS/src/LEAmDNS_Priv.h index a7d8a8f998..49fc5bb608 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS_Priv.h +++ b/libraries/ESP8266mDNS/src/LEAmDNS_Priv.h @@ -122,7 +122,7 @@ namespace MDNSImplementation #define MDNS_SERVICE_TTL 4500 /* - Compressed labels are flaged by the two topmost bits of the length byte being set + Compressed labels are flagged by the two topmost bits of the length byte being set */ #define MDNS_DOMAIN_COMPRESS_MARK 0xC0 /* @@ -156,7 +156,7 @@ namespace MDNSImplementation /* Enable/disable the usage of the F() macro in debug trace printf calls. - There needs to be an PGM comptible printf function to use this. + There needs to be an PGM compatible printf function to use this. USE_PGM_PRINTF and F */ diff --git a/libraries/ESP8266mDNS/src/LEAmDNS_Structs.cpp b/libraries/ESP8266mDNS/src/LEAmDNS_Structs.cpp index 0e128aea8a..85845d8faa 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS_Structs.cpp +++ b/libraries/ESP8266mDNS/src/LEAmDNS_Structs.cpp @@ -283,12 +283,12 @@ size_t MDNSResponder::stcMDNSServiceTxt::length(void) const A TXT item can be looke up by its 'key' member. Export as ';'-separated byte array is supported. Export as 'length byte coded' byte array is supported. - Comparision ((all A TXT items in B and equal) AND (all B TXT items in A and equal)) is supported. + Comparison ((all A TXT items in B and equal) AND (all B TXT items in A and equal)) is supported. */ /* - MDNSResponder::stcMDNSServiceTxts::stcMDNSServiceTxts contructor + MDNSResponder::stcMDNSServiceTxts::stcMDNSServiceTxts constructor */ MDNSResponder::stcMDNSServiceTxts::stcMDNSServiceTxts(void) : m_pTxts(0) @@ -387,7 +387,7 @@ bool MDNSResponder::stcMDNSServiceTxts::remove(stcMDNSServiceTxt* p_pTxt) delete p_pTxt; bResult = true; } - else if (m_pTxts == p_pTxt) // No predecesor, but first item + else if (m_pTxts == p_pTxt) // No predecessor, but first item { m_pTxts = p_pTxt->m_pNext; delete p_pTxt; @@ -646,7 +646,7 @@ bool MDNSResponder::stcMDNSServiceTxts::operator!=(const stcMDNSServiceTxts& p_O /** MDNSResponder::stcMDNS_MsgHeader - A MDNS message haeder. + A MDNS message header. */ @@ -1328,7 +1328,7 @@ bool MDNSResponder::stcProbeInformation::clear(bool p_bClearUserdata /*= false*/ and the flag m_bAutoName is set. If the hostname changes, all 'auto- named' services are renamed also. m_u8Replymask is used while preparing a response to a MDNS query. It is - resetted in '_sendMDNSMessage' afterwards. + reset in '_sendMDNSMessage' afterwards. */ /* @@ -1504,7 +1504,7 @@ bool MDNSResponder::stcMDNSService::releaseProtocol(void) - an IP4 address (- an IP6 address) - a MDNS TXTs - The existance of a component is flaged in 'm_u32ContentFlags'. + The existence of a component is flagged in 'm_u32ContentFlags'. For every answer component a TTL value is maintained. Answer objects can be connected to a linked list. @@ -1899,7 +1899,7 @@ bool MDNSResponder::stcMDNSServiceQuery::stcAnswer::removeIP4Address(MDNSRespond delete p_pIP4Address; bResult = true; } - else if (m_pIP4Addresses == p_pIP4Address) // No predecesor, but first item + else if (m_pIP4Addresses == p_pIP4Address) // No predecessor, but first item { m_pIP4Addresses = p_pIP4Address->m_pNext; delete p_pIP4Address; @@ -2036,7 +2036,7 @@ bool MDNSResponder::stcMDNSServiceQuery::stcAnswer::removeIP6Address(MDNSRespond delete p_pIP6Address; bResult = true; } - else if (m_pIP6Addresses == p_pIP6Address) // No predecesor, but first item + else if (m_pIP6Addresses == p_pIP6Address) // No predecessor, but first item { m_pIP6Addresses = p_pIP6Address->m_pNext; delete p_pIP6Address; @@ -2123,7 +2123,7 @@ MDNSResponder::stcMDNSServiceQuery::stcAnswer::stcIP6Address* MDNSResponder::stc MDNSResponder::stcMDNSServiceQuery A service query object. - A static query is flaged via 'm_bLegacyQuery'; while the function 'queryService' + A static query is flagged via 'm_bLegacyQuery'; while the function 'queryService' is waiting for answers, the internal flag 'm_bAwaitingAnswers' is set. When the timeout is reached, the flag is removed. These two flags are only used for static service queries. @@ -2282,7 +2282,7 @@ bool MDNSResponder::stcMDNSServiceQuery::removeAnswer(MDNSResponder::stcMDNSServ delete p_pAnswer; bResult = true; } - else if (m_pAnswers == p_pAnswer) // No predecesor, but first item + else if (m_pAnswers == p_pAnswer) // No predecessor, but first item { m_pAnswers = p_pAnswer->m_pNext; delete p_pAnswer; diff --git a/libraries/ESP8266mDNS/src/LEAmDNS_Transfer.cpp b/libraries/ESP8266mDNS/src/LEAmDNS_Transfer.cpp index 1b8e337895..0398d9a6ee 100644 --- a/libraries/ESP8266mDNS/src/LEAmDNS_Transfer.cpp +++ b/libraries/ESP8266mDNS/src/LEAmDNS_Transfer.cpp @@ -154,7 +154,7 @@ bool MDNSResponder::_sendMDNSMessage_Multicast(MDNSResponder::stcMDNSSendParamet MDNSResponder::_prepareMDNSMessage The MDNS message is composed in a two-step process. - In the first loop 'only' the header informations (mainly number of answers) are collected, + In the first loop 'only' the header information (mainly number of answers) are collected, while in the seconds loop, the header and all queries and answers are written to the UDP output buffer. @@ -214,7 +214,7 @@ bool MDNSResponder::_prepareMDNSMessage(MDNSResponder::stcMDNSSendParameter& p_r DEBUG_EX_ERR(if (!bResult) DEBUG_OUTPUT.printf_P(PSTR("[MDNSResponder] _prepareMDNSMessage: _writeMDNSQuestion FAILED!\n"));); } - // Answers and authorative answers + // Answers and authoritative answers #ifdef MDNS_IP4_SUPPORT if ((bResult) && (p_rSendParameter.m_u8HostReplyMask & ContentFlag_A)) @@ -397,7 +397,7 @@ bool MDNSResponder::_sendMDNSQuery(const MDNSResponder::stcMDNS_RRDomain& p_Quer // It seems, that some mDNS implementations don't support 'unicast response' questions... sendParameter.m_pQuestions->m_Header.m_Attributes.m_u16Class = (/*0x8000 |*/ DNS_RRCLASS_IN); // /*Unicast &*/ INternet - // TODO: Add knwon answer to the query + // TODO: Add known answer to the query (void)p_pKnownAnswers; bResult = _sendMDNSMessage(sendParameter); @@ -655,13 +655,13 @@ bool MDNSResponder::_readRRAnswerTXT(MDNSResponder::stcMDNS_RRAnswerTXT& p_rRRAn } if ((bResult) && - (pTxt)) // Everythings fine so far + (pTxt)) // Everything is fine so far { // Link TXT item to answer TXTs pTxt->m_pNext = p_rRRAnswerTXT.m_Txts.m_pTxts; p_rRRAnswerTXT.m_Txts.m_pTxts = pTxt; } - else // At least no TXT (migth be OK, if length was 0) OR an error + else // At least no TXT (might be OK, if length was 0) OR an error { if (!bResult) { @@ -1226,9 +1226,9 @@ bool MDNSResponder::_readMDNSMsgHeader(MDNSResponder::stcMDNS_MsgHeader& p_rMsgH (_udpRead16(p_rMsgHeader.m_u16ARCount))) { - p_rMsgHeader.m_1bQR = (u8B1 & 0x80); // Query/Responde flag + p_rMsgHeader.m_1bQR = (u8B1 & 0x80); // Query/Respond flag p_rMsgHeader.m_4bOpcode = (u8B1 & 0x78); // Operation code (0: Standard query, others ignored) - p_rMsgHeader.m_1bAA = (u8B1 & 0x04); // Authorative answer + p_rMsgHeader.m_1bAA = (u8B1 & 0x04); // Authoritative answer p_rMsgHeader.m_1bTC = (u8B1 & 0x02); // Truncation flag p_rMsgHeader.m_1bRD = (u8B1 & 0x01); // Recursion desired @@ -1430,7 +1430,7 @@ bool MDNSResponder::_writeMDNSServiceDomain(const MDNSResponder::stcMDNSService& // Found cached domain -> mark as compressed domain ? ((MDNS_DOMAIN_COMPRESS_MARK > ((u16CachedDomainOffset >> 8) & ~MDNS_DOMAIN_COMPRESS_MARK)) && // Valid offset ((!p_bPrependRDLength) || - (_write16(2, p_rSendParameter))) && // Lenght of 'Cxxx' + (_write16(2, p_rSendParameter))) && // Length of 'Cxxx' (_write8(((u16CachedDomainOffset >> 8) | MDNS_DOMAIN_COMPRESS_MARK), p_rSendParameter)) && // Compression mark (and offset) (_write8((uint8_t)(u16CachedDomainOffset & 0xFF), p_rSendParameter))) // No cached domain -> add this domain to cache and write full domain name diff --git a/libraries/GDBStub/README.md b/libraries/GDBStub/README.md index 0883a2c1b5..1968ed2f22 100644 --- a/libraries/GDBStub/README.md +++ b/libraries/GDBStub/README.md @@ -30,9 +30,9 @@ in Git. * Modify your Makefile. You'll need to include the gdbstub sources: if your Makefile is structured like the ones in the Espressif examples, you can add `gdbstub` to the `SUBDIRS` define and `gdbstub/libgdbstub.a` to the `COMPONENTS_eagle.app.v6` define. Also, you probably want to add `-ggdb` to your compiler flags (`TARGET_LDFLAGS`) -and, if you are debugging, change any optimation flags (-Os, -O2 etc) into `-Og`. Finally, make sure your Makefile +and, if you are debugging, change any optimization flags (-Os, -O2 etc) into `-Og`. Finally, make sure your Makefile also compiles .S files. - * Configure gdbstub by editting `gdbstub-cfg.h`. There are a bunch of options you can tweak: FreeRTOS or bare SDK, + * Configure gdbstub by editing `gdbstub-cfg.h`. There are a bunch of options you can tweak: FreeRTOS or bare SDK, private exception/breakpoint stack, console redirection to GDB, wait till debugger attachment etc. You can also configure the options by including the proper -Dwhatever gcc flags in your Makefiles. * In your user_main.c, add an `#include <../gdbstub/gdbstub.h>` and call `gdbstub_init();` somewhere in user_main. diff --git a/libraries/GDBStub/src/internal/gdbstub.c b/libraries/GDBStub/src/internal/gdbstub.c index e5895a3a0b..537de3c3f7 100644 --- a/libraries/GDBStub/src/internal/gdbstub.c +++ b/libraries/GDBStub/src/internal/gdbstub.c @@ -458,7 +458,7 @@ static inline int gdbHandleCommand() { return ST_CONT; } else if (cmd[0] == 's') { //single-step instruction //Single-stepping can go wrong if an interrupt is pending, especially when it is e.g. a task switch: - //the ICOUNT register will overflow in the task switch code. That is why we disable interupts when + //the ICOUNT register will overflow in the task switch code. That is why we disable interrupts when //doing single-instruction stepping. singleStepPs=gdbstub_savedRegs.ps; gdbstub_savedRegs.ps=(gdbstub_savedRegs.ps & ~0xf) | (XCHAL_DEBUGLEVEL - 1); diff --git a/libraries/LittleFS/src/lfs.c b/libraries/LittleFS/src/lfs.c index 62022fc375..9e770084e6 100644 --- a/libraries/LittleFS/src/lfs.c +++ b/libraries/LittleFS/src/lfs.c @@ -1,4 +1,4 @@ -// Can't place library in ths src/ directory, Arduino will attempt to build the tests/etc. +// Can't place library in this src/ directory, Arduino will attempt to build the tests/etc. // Just have a stub here that redirects to the actual source file #pragma GCC diagnostic ignored "-Wmissing-field-initializers" diff --git a/libraries/Netdump/library.properties b/libraries/Netdump/library.properties index bc23b9ceed..8fdee5a741 100644 --- a/libraries/Netdump/library.properties +++ b/libraries/Netdump/library.properties @@ -3,7 +3,7 @@ version=2 author=Herman Reintke maintainer=Herman Reintke sentence=tcpdump-like logger for esp8266/Arduino -paragraph=Dumps input / output packets on "Print"able type, or provide a TCP server for the real tcpdump. Check examples. Some other unrelated and independant tools are included. +paragraph=Dumps input / output packets on "Print"able type, or provide a TCP server for the real tcpdump. Check examples. Some other unrelated and independent tools are included. category=Communication url=https:// architectures=esp8266 diff --git a/libraries/SD/src/SD.h b/libraries/SD/src/SD.h index fee20da548..eb9372b2a8 100644 --- a/libraries/SD/src/SD.h +++ b/libraries/SD/src/SD.h @@ -183,7 +183,7 @@ class SDClass { }; -// Expose FatStructs.h helpers for MSDOS date/time for use with dateTimeCallback +// Expose FatStructs.h helpers for MS-DOS date/time for use with dateTimeCallback static inline uint16_t FAT_DATE(uint16_t year, uint8_t month, uint8_t day) { return (year - 1980) << 9 | month << 5 | day; } diff --git a/libraries/Servo/src/Servo.cpp b/libraries/Servo/src/Servo.cpp index 2c21524822..69ed476d84 100644 --- a/libraries/Servo/src/Servo.cpp +++ b/libraries/Servo/src/Servo.cpp @@ -26,14 +26,14 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA uint32_t Servo::_servoMap = 0; -// similiar to map but will have increased accuracy that provides a more +// similar to map but will have increased accuracy that provides a more // symmetrical api (call it and use result to reverse will provide the original value) int improved_map(int value, int minIn, int maxIn, int minOut, int maxOut) { const int rangeIn = maxIn - minIn; const int rangeOut = maxOut - minOut; const int deltaIn = value - minIn; - // fixed point math constants to improve accurancy of divide and rounding + // fixed point math constants to improve accuracy of divide and rounding constexpr int fixedHalfDecimal = 1; constexpr int fixedDecimal = fixedHalfDecimal * 2; diff --git a/libraries/Servo/src/Servo.h b/libraries/Servo/src/Servo.h index 38d78709a4..9efb7b2c0d 100644 --- a/libraries/Servo/src/Servo.h +++ b/libraries/Servo/src/Servo.h @@ -47,7 +47,7 @@ // The following values are in us (microseconds). // Since the defaults can be overwritten in the new attach() member function, // they were modified from the Arduino AVR defaults to be in the safe range -// of publically available specifications. While this implies that many 180° +// of publicly available specifications. While this implies that many 180° // servos do not operate the full 0° to 180° sweep using these, it also prevents // unsuspecting damage. For Arduino AVR, the same change is being discussed. #define DEFAULT_MIN_PULSE_WIDTH 1000 // uncalibrated default, the shortest duty cycle sent to a servo diff --git a/libraries/TFT_Touch_Shield_V2/examples/paint/paint.ino b/libraries/TFT_Touch_Shield_V2/examples/paint/paint.ino index b6a1310c4a..dc13088b9f 100644 --- a/libraries/TFT_Touch_Shield_V2/examples/paint/paint.ino +++ b/libraries/TFT_Touch_Shield_V2/examples/paint/paint.ino @@ -27,7 +27,7 @@ void loop() { // a point object holds x y and z coordinates. Point p = ts.getPoint(); - //map the ADC value read to into pixel co-ordinates + //map the ADC value read to into pixel coordinates p.x = map(p.x, TS_MINX, TS_MAXX, 0, 240); p.y = map(p.y, TS_MINY, TS_MAXY, 0, 320); diff --git a/libraries/TFT_Touch_Shield_V2/examples/tftbmp/tftbmp.ino b/libraries/TFT_Touch_Shield_V2/examples/tftbmp/tftbmp.ino index 4176de59dc..49d39fee3b 100644 --- a/libraries/TFT_Touch_Shield_V2/examples/tftbmp/tftbmp.ino +++ b/libraries/TFT_Touch_Shield_V2/examples/tftbmp/tftbmp.ino @@ -22,7 +22,7 @@ const int PIN_SD_CS = 4; // pin of sd card -const int __Gnbmp_height = 320; // bmp hight +const int __Gnbmp_height = 320; // bmp height const int __Gnbmp_width = 240; // bmp width unsigned char __Gnbmp_image_offset = 0; // offset @@ -66,7 +66,7 @@ void loop() { for (unsigned char i = 0; i < __Gnfile_num; i++) { bmpFile = SD.open(__Gsbmp_files[i]); if (! bmpFile) { - Serial.println("didnt find image"); + Serial.println("didn't find image"); while (1); } @@ -86,7 +86,7 @@ void loop() { /*********************************************/ // This procedure reads a bitmap and draws it to the screen // its sped up by reading many pixels worth of data at a time -// instead of just one pixel at a time. increading the buffer takes +// instead of just one pixel at a time. increasing the buffer takes // more RAM but makes the drawing a little faster. 20 pixels' worth // is probably a good place diff --git a/libraries/TFT_Touch_Shield_V2/examples/tftbmp2/tftbmp2.ino b/libraries/TFT_Touch_Shield_V2/examples/tftbmp2/tftbmp2.ino index bc8fb45c42..03423a4ef5 100644 --- a/libraries/TFT_Touch_Shield_V2/examples/tftbmp2/tftbmp2.ino +++ b/libraries/TFT_Touch_Shield_V2/examples/tftbmp2/tftbmp2.ino @@ -23,7 +23,7 @@ const int PIN_SD_CS = 4; // pin of sd card -const long __Gnbmp_height = 320; // bmp hight +const long __Gnbmp_height = 320; // bmp height const long __Gnbmp_width = 240; // bmp width long __Gnbmp_image_offset = 0;; @@ -132,7 +132,7 @@ void loop() { bmpFile = SD.open(__Gsbmp_files[i]); if (! bmpFile) { - Serial.println("didnt find image"); + Serial.println("didn'`t find image"); while (1); } @@ -154,7 +154,7 @@ void loop() { bmpFile = SD.open("pfvm_1.bmp"); if (! bmpFile) { - Serial.println("didnt find image"); + Serial.println("didn't find image"); while (1); } @@ -172,7 +172,7 @@ void loop() { /*********************************************/ // This procedure reads a bitmap and draws it to the screen // its sped up by reading many pixels worth of data at a time -// instead of just one pixel at a time. increading the buffer takes +// instead of just one pixel at a time. increasing the buffer takes // more RAM but makes the drawing a little faster. 20 pixels' worth // is probably a good place diff --git a/libraries/Ticker/examples/TickerParameter/TickerParameter.ino b/libraries/Ticker/examples/TickerParameter/TickerParameter.ino index 066905d098..8263c0bb56 100644 --- a/libraries/Ticker/examples/TickerParameter/TickerParameter.ino +++ b/libraries/Ticker/examples/TickerParameter/TickerParameter.ino @@ -1,5 +1,5 @@ /* - Passing paramters to Ticker callbacks + Passing parameters to Ticker callbacks Apart from void(void) functions, the Ticker library supports functions taking one argument. This argument's size has to be less or diff --git a/libraries/esp8266/examples/CheckFlashCRC/CheckFlashCRC.ino b/libraries/esp8266/examples/CheckFlashCRC/CheckFlashCRC.ino index b00194a46b..fa520722f6 100644 --- a/libraries/esp8266/examples/CheckFlashCRC/CheckFlashCRC.ino +++ b/libraries/esp8266/examples/CheckFlashCRC/CheckFlashCRC.ino @@ -8,7 +8,7 @@ extern "C" { #include "spi_flash.h" } -// Artificially create a space in PROGMEM that fills multipe sectors so +// Artificially create a space in PROGMEM that fills multiple sectors so // we can corrupt one without crashing the system const int corruptme[SPI_FLASH_SEC_SIZE * 4] PROGMEM = { 0 }; diff --git a/libraries/esp8266/examples/HwdtStackDump/HwdtStackDump.ino b/libraries/esp8266/examples/HwdtStackDump/HwdtStackDump.ino index ec74760803..fa01d2ec00 100644 --- a/libraries/esp8266/examples/HwdtStackDump/HwdtStackDump.ino +++ b/libraries/esp8266/examples/HwdtStackDump/HwdtStackDump.ino @@ -43,7 +43,7 @@ void setup(void) { // more of the SYS stack. WiFi.mode(WIFI_STA); WiFi.begin(ssid, password); - Serial.println(F("A WiFi connection attmpt has been started.")); + Serial.println(F("A WiFi connection attempt has been started.")); Serial.println(); // #define DEMO_NOEXTRA4K diff --git a/libraries/esp8266/examples/HwdtStackDump/ProcessKey.ino b/libraries/esp8266/examples/HwdtStackDump/ProcessKey.ino index 9c12ac7c1c..7d182bf377 100644 --- a/libraries/esp8266/examples/HwdtStackDump/ProcessKey.ino +++ b/libraries/esp8266/examples/HwdtStackDump/ProcessKey.ino @@ -70,7 +70,7 @@ void processKey(Print& out, int hotKey) { out.println(F("This line will not be printable w/o running GDB")); break; case '0': - out.println(F("Crashing at an embeded 'break 1, 15' instruction that was generated")); + out.println(F("Crashing at an embedded 'break 1, 15' instruction that was generated")); out.println(F("by the compiler after detecting a divide by zero.")); out.printf_P(PSTR("This should not print %d\n"), divideA_B_bp(1, 0)); break; diff --git a/libraries/esp8266/examples/IramReserve/ProcessKey.ino b/libraries/esp8266/examples/IramReserve/ProcessKey.ino index 9c12ac7c1c..7d182bf377 100644 --- a/libraries/esp8266/examples/IramReserve/ProcessKey.ino +++ b/libraries/esp8266/examples/IramReserve/ProcessKey.ino @@ -70,7 +70,7 @@ void processKey(Print& out, int hotKey) { out.println(F("This line will not be printable w/o running GDB")); break; case '0': - out.println(F("Crashing at an embeded 'break 1, 15' instruction that was generated")); + out.println(F("Crashing at an embedded 'break 1, 15' instruction that was generated")); out.println(F("by the compiler after detecting a divide by zero.")); out.printf_P(PSTR("This should not print %d\n"), divideA_B_bp(1, 0)); break; diff --git a/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino b/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino index 376086fb61..f6c2df08fc 100644 --- a/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino +++ b/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino @@ -241,7 +241,7 @@ void setup() { // install callback - called when settimeofday is called (by SNTP or user) // once enabled (by DHCP), SNTP is updated every hour by default - // ** optional boolean in callback function is true when triggerred by SNTP ** + // ** optional boolean in callback function is true when triggered by SNTP ** settimeofday_cb(time_is_set); // setup RTC time @@ -251,7 +251,7 @@ void setup() { timeval tv = { rtc, 0 }; settimeofday(&tv, nullptr); - // NTP servers may be overriden by your DHCP server for a more local one + // NTP servers may be overridden by your DHCP server for a more local one // (see below) // ----> Here is the ONLY ONE LINE needed in your sketch diff --git a/libraries/esp8266/examples/StreamString/StreamString.ino b/libraries/esp8266/examples/StreamString/StreamString.ino index c04f55f35a..c9c6b46025 100644 --- a/libraries/esp8266/examples/StreamString/StreamString.ino +++ b/libraries/esp8266/examples/StreamString/StreamString.ino @@ -38,7 +38,7 @@ void testStreamString() { // By default, reading a S2Stream(String) or a StreamString will consume the String. // It can be disabled by calling ::resetPointer(), (not default) - // and reenabled by calling ::setConsume(). (default) + // and re-enabled by calling ::setConsume(). (default) // // In default consume mode, reading a byte or a block will remove it from // the String. Operations are O(n²). @@ -110,7 +110,7 @@ void testStreamString() { result.clear(); S2Stream input(inputString); // reading stream will consume the string - input.setConsume(); // can be ommitted, this is the default + input.setConsume(); // can be omitted, this is the default input.sendSize(result, 1); input.sendSize(result, 2); diff --git a/libraries/lwIP_enc28j60/src/utility/enc28j60.h b/libraries/lwIP_enc28j60/src/utility/enc28j60.h index 0545039026..07ec39e929 100644 --- a/libraries/lwIP_enc28j60/src/utility/enc28j60.h +++ b/libraries/lwIP_enc28j60/src/utility/enc28j60.h @@ -107,7 +107,7 @@ class ENC28J60 @param buffer a pointer to a buffer to write the frame to @param framesize readFrameSize()'s result @return the length of the received frame - or 0 if a problem occured + or 0 if a problem occurred */ uint16_t readFrameData(uint8_t *frame, uint16_t framesize); diff --git a/libraries/lwIP_w5100/src/utility/w5100.h b/libraries/lwIP_w5100/src/utility/w5100.h index 300cb334a4..43b9f0b9f3 100644 --- a/libraries/lwIP_w5100/src/utility/w5100.h +++ b/libraries/lwIP_w5100/src/utility/w5100.h @@ -108,7 +108,7 @@ class Wiznet5100 @param buffer a pointer to a buffer to write the frame to @param framesize readFrameSize()'s result @return the length of the received frame - or 0 if a problem occured + or 0 if a problem occurred */ uint16_t readFrameData(uint8_t *frame, uint16_t framesize); diff --git a/libraries/lwIP_w5500/src/utility/w5500.h b/libraries/lwIP_w5500/src/utility/w5500.h index 428689b8e5..85b253a4bf 100644 --- a/libraries/lwIP_w5500/src/utility/w5500.h +++ b/libraries/lwIP_w5500/src/utility/w5500.h @@ -110,7 +110,7 @@ class Wiznet5500 @param buffer a pointer to a buffer to write the frame to @param framesize readFrameSize()'s result @return the length of the received frame - or 0 if a problem occured + or 0 if a problem occurred */ uint16_t readFrameData(uint8_t *frame, uint16_t framesize); @@ -356,7 +356,7 @@ class Wiznet5500 MR_WOL = 0x20, ///< Wake on LAN MR_PB = 0x10, ///< Ping block MR_PPPOE = 0x08, ///< Enable PPPoE - MR_FARP = 0x02, ///< Enable UDP_FORCE_ARP CHECHK + MR_FARP = 0x02, ///< Enable UDP_FORCE_ARP CHECK }; /* Interrupt Register values */ diff --git a/platform.txt b/platform.txt index 30448f594e..7541466196 100644 --- a/platform.txt +++ b/platform.txt @@ -82,7 +82,7 @@ compiler.elf2hex.flags= compiler.size.cmd=xtensa-lx106-elf-size -# This can be overriden in boards.txt +# This can be overridden in boards.txt build.extra_flags=-DESP8266 # These can be overridden in platform.local.txt @@ -157,7 +157,7 @@ tools.esptool.upload.params.quiet= # First, potentially perform an erase or nothing # Next, do the binary upload -# Combined in one rule because Arduino doesn't suport upload.1.pattern/upload.3.pattern +# Combined in one rule because Arduino doesn't support upload.1.pattern/upload.3.pattern tools.esptool.upload.pattern="{cmd}" "{runtime.platform.path}/tools/upload.py" --chip esp8266 --port "{serial.port}" --baud "{upload.speed}" "{upload.verbose}" {upload.erase_cmd} {upload.resetmethod} write_flash 0x0 "{build.path}/{build.project_name}.bin" tools.esptool.upload.network_pattern="{network_cmd}" "{runtime.platform.path}/tools/espota.py" -i "{serial.port}" -p "{network.port}" "--auth={network.password}" -f "{build.path}/{build.project_name}.bin" diff --git a/tests/device/test_libc/memcpy-1.c b/tests/device/test_libc/memcpy-1.c index e6b6384521..2485af0923 100644 --- a/tests/device/test_libc/memcpy-1.c +++ b/tests/device/test_libc/memcpy-1.c @@ -96,7 +96,7 @@ void memcpy_main(void) /* Allocate buffers to read and write from. */ char src[BUFF_SIZE], dest[BUFF_SIZE], backup_src[BUFF_SIZE]; - /* Fill the source buffer with non-null values, reproducable random data. */ + /* Fill the source buffer with non-null values, reproducible random data. */ srand (rand_seed); int i, j; unsigned sa; diff --git a/tests/device/test_libc/strcmp-1.c b/tests/device/test_libc/strcmp-1.c index 7eaede5e98..7c1883a085 100644 --- a/tests/device/test_libc/strcmp-1.c +++ b/tests/device/test_libc/strcmp-1.c @@ -140,7 +140,7 @@ void strcmp_main(void) /* Allocate buffers to read and write from. */ char src[BUFF_SIZE], dest[BUFF_SIZE]; - /* Fill the source buffer with non-null values, reproducable random data. */ + /* Fill the source buffer with non-null values, reproducible random data. */ srand (rand_seed); int i, j, zeros; unsigned sa; diff --git a/tests/device/test_millis_mm/test_millis_mm.ino b/tests/device/test_millis_mm/test_millis_mm.ino index 6138000578..a159509e54 100644 --- a/tests/device/test_millis_mm/test_millis_mm.ino +++ b/tests/device/test_millis_mm/test_millis_mm.ino @@ -30,7 +30,7 @@ static bool fixed_systime = false; // Testing vars static bool debugf = false; static uint32_t us_systime = 0; static float nsf = 0; // Normalization factor -static uint32_t cntref = 0; // Ref. comparision count +static uint32_t cntref = 0; // Ref. comparison count //--------------------------------------------------------------------------- // Interrupt code lifted directly from "cores/core_esp8266_wiring.c", @@ -95,7 +95,7 @@ void viewhex( uint16_t *p, uint8_t n ) //--------------------------------------------------------------------------- // Support routine for 'millis_test_DEBUG()' -// Print accumulator value along interm summed into it +// Print accumulator value along interim summed into it void view_accsum ( const char *desc, uint16_t *acc, uint16_t *itrm ) { Serial.print( "acc: " ); @@ -149,8 +149,8 @@ unsigned long IRAM_ATTR millis_corr ( void ) // FOR DEBUG // millis() 'magic multiplier' approximation // -// This function corrects the cumlative (296us / usec overflow) drift -// seen in the orignal 'millis()' function. +// This function corrects the cumulative (296us / usec overflow) drift +// seen in the original 'millis()' function. // // Input: // 'm' - 32-bit usec counter, 0 <= m <= 0xFFFFFFFF @@ -254,7 +254,7 @@ unsigned long IRAM_ATTR millis_test_DEBUG ( void ) } acc; acc.a[1] = 0; // Zero high-acc - uint64_t prd; // Interm product + uint64_t prd; // Interim product // Get usec system time, usec overflow counter uint32_t m = system_get_timeA(); @@ -269,28 +269,28 @@ unsigned long IRAM_ATTR millis_test_DEBUG ( void ) acc.q = ( (prd = (uint64_t)( m * (uint64_t)MAGIC_1E3_wLO )) >> 32 ); - // DEBUG: Show both accumulator and interm product + // DEBUG: Show both accumulator and interim product if( debugf ) view_accsum( "m kl", (uint16_t *)&acc.q, (uint16_t *)&prd ); // (b) Offset sum, low-acc acc.q += ( prd = ( m * (uint64_t)MAGIC_1E3_wHI ) ); - // DEBUG: Show both accumulator and interm product + // DEBUG: Show both accumulator and interim product if( debugf ) view_accsum( "m kh", (uint16_t *)&acc.q, (uint16_t *)&prd ); // (c) Offset sum, low-acc acc.q += ( prd = ( c * (uint64_t)MAGIC_1E3_wLO ) ); - // DEBUG: Show both accumulator and interm product + // DEBUG: Show both accumulator and interim product if( debugf ) view_accsum( "c kl", (uint16_t *)&acc.q, (uint16_t *)&prd ); // (d) Truncated sum, high-acc acc.a[1] += (uint32_t)( prd = ( c * (uint64_t)MAGIC_1E3_wHI ) ); - // DEBUG: Show both accumulator and interm product + // DEBUG: Show both accumulator and interim product if( debugf ) view_accsum( "c kh", (uint16_t *)&acc.q, (uint16_t *)&prd ); diff --git a/tests/host/README.txt b/tests/host/README.txt index 07c0b276bd..feb6611d52 100644 --- a/tests/host/README.txt +++ b/tests/host/README.txt @@ -19,7 +19,7 @@ WiFiClient+WiFiServer/ClientContext and WifiUdp/UdpContext using socket posix API. Further work will optionally propose native lwIP library instead. -Serial UART0 and UART1 are emulated via stdin/stdout/stderr. Therefor +Serial UART0 and UART1 are emulated via stdin/stdout/stderr. Therefore stdin is connected to UART0(RX) and stdout is connected to UART0(TX). UART1(TX) writes to stderr. Reading from stdin happens in non-blocking raw mode, that means each character is directly injected into the UART diff --git a/tests/host/common/catch.hpp b/tests/host/common/catch.hpp index 391c7ab4af..bc67674562 100644 --- a/tests/host/common/catch.hpp +++ b/tests/host/common/catch.hpp @@ -4225,7 +4225,7 @@ namespace Catch { ss << seed; ss >> config.rngSeed; if( ss.fail() ) - throw std::runtime_error( "Argment to --rng-seed should be the word 'time' or a number" ); + throw std::runtime_error( "Argument to --rng-seed should be the word 'time' or a number" ); } } inline void setVerbosity( ConfigData& config, int level ) { @@ -6649,7 +6649,7 @@ namespace Catch { Colour colourGuard( Colour::Red ); Catch::cerr() << "Tag name [" << tag << "] not allowed.\n" - << "Tag names starting with non alpha-numeric characters are reserved\n"; + << "Tag names starting with non alphanumeric characters are reserved\n"; } { Colour colourGuard( Colour::FileName ); diff --git a/tests/host/fs/test_fs.inc b/tests/host/fs/test_fs.inc index b7e7692a46..2f7f96beaf 100644 --- a/tests/host/fs/test_fs.inc +++ b/tests/host/fs/test_fs.inc @@ -188,7 +188,7 @@ TEST_CASE(TESTPRE "peek() returns -1 on EOF", TESTPAT) f.close(); } -TEST_CASE(TESTPRE "seek() pase EOF returns error (#7323)", TESTPAT) +TEST_CASE(TESTPRE "seek() past EOF returns error (#7323)", TESTPAT) { FS_MOCK_DECLARE(64, 8, 512, ""); REQUIRE(FSTYPE.begin()); diff --git a/tools/boards.txt.py b/tools/boards.txt.py index 31f0e1bc44..434a8c2723 100755 --- a/tools/boards.txt.py +++ b/tools/boards.txt.py @@ -79,13 +79,13 @@ ], 'desc': [ 'These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info: `ESP8266 Module Family `__.', '', - 'Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.', + 'Usually these modules have no bootstrapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.', '', 'In order to use these modules, make sure to observe the following:', '', '- **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator alongwith filtering capacitors is preferred.', '', - '- **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.', + '- **Connect bootstrapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.', '', '- **Put ESP8266 into bootloader mode** before uploading code.', '', @@ -1724,7 +1724,7 @@ def package (): newfilestr = re.sub(r'"boards":[^\]]*\],', substitution, filestr, re.MULTILINE) - # To get consistent indent/formatting read the JSON and write it out programattically + # To get consistent indent/formatting read the JSON and write it out programmatically if packagegen: with open(pkgfname, 'w') as package_file: filejson = json.loads(newfilestr, object_pairs_hook=collections.OrderedDict) diff --git a/variants/wifi_slot/analogRead.cpp b/variants/wifi_slot/analogRead.cpp index f2c1f3c7a2..3550709f82 100644 --- a/variants/wifi_slot/analogRead.cpp +++ b/variants/wifi_slot/analogRead.cpp @@ -39,7 +39,7 @@ extern "C" int analogRead(uint8_t pin) { void initVariant() { // we need to reset analog mux. When ANALOG_INPUT_SELECTOR_PIN is high // on ~0.4 ms, mux channel is becoming 0. - // Mux channel is swithing on back \_ front. But there is no switching + // Mux channel is switching on back \_ front. But there is no switching // - rc reset is still high when ANALOG_INPUT_SELECTOR_PIN became low uint16_t resetDelay = 777; pinMode(ANALOG_INPUT_SELECTOR_PIN, OUTPUT);