Add code-spell spelling checks to CI (#8067)

Help find and fix silly spelling errors as they are added to the repo.

libraries/ESP8266WiFiMesh/README.md

@@ -286,7 +286,7 @@ It is important to realize that there is no global message ID counter, only the
 
 ### <a name="FAQStartupCrash"></a>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.
 
 ### <a name="FAQSSIDAmnesia"></a>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.
+Another possible workaround is to try with a different router or router firmware.

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('.');

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)

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<size_t Size>
 void ESP8266WiFiMesh::attemptScan(char (&message)[Size])
 {
   attemptScanKernel(message);
-}
+}

libraries/ESP8266WiFiMesh/src/ESP8266WiFiMesh.h

@@ -182,7 +182,7 @@ public:
   * 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<NetworkInfo> connectionQueue;
 
@@ -190,7 +190,7 @@ public:
   * 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<TransmissionResult> latestTransmissionOutcomes;
 

libraries/ESP8266WiFiMesh/src/EspnowMeshBackend.h

@@ -172,7 +172,7 @@ public:
   * 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 @@ public:
   * 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<TransmissionOutcome> & latestTransmissionOutcomes();
 
@@ -260,7 +260,7 @@ public:
   
   /* 
    * 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 @@ public:
    * @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 @@ public:
    * @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);
  

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);
 

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)
 {

libraries/ESP8266WiFiMesh/src/FloodingMesh.h

@@ -182,7 +182,7 @@ public:
    * 
    * ########## 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.

libraries/ESP8266WiFiMesh/src/TcpIpMeshBackend.h

@@ -70,7 +70,7 @@ public:
   * 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 @@ public:
   * 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<TransmissionOutcome> & latestTransmissionOutcomes();