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

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

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