Merge branch 'feature/add_codespell_check' into 'master'

lhespress · lhespress · commit df0b77fbaefb · 2026-02-04T19:31:18.000+08:00
feat: add codespell check

See merge request ae_group/esp-now!148
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,4 @@
+[codespell]
+skip = build,*.drawio,*.svg,*.pdf
+ignore-words-list = laf,OT,inout
+write-changes = true
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -1,4 +1,5 @@
 stages:
+  - check
   - build
   - deploy
 
@@ -166,3 +167,6 @@ push_master_to_github:
     # NB: In gitlab 9.x, CI_BUILD_REF was deprecated. New name is CI_COMMIT_REF. If below command suddenly
     # generates bash syntax errors, this is probably why.
     - eval $(git for-each-ref --shell bash --format 'if [ $CI_COMMIT_SHA == %(objectname) ]; then git checkout -B %(refname:strip=3); git push --follow-tags github %(refname:strip=3); fi;' $GITHUB_PUSH_REFS)
+
+include:
+  - '.gitlab/ci/pre_commit.yml'
diff --git a/.gitlab/ci/pre_commit.yml b/.gitlab/ci/pre_commit.yml
@@ -0,0 +1,26 @@
+.check_pre_commit_template:
+  stage: check
+  image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.3:1-1
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  script:
+    - pip install pre-commit
+    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME --depth=1
+    - git fetch origin $CI_COMMIT_REF_NAME --depth=1
+    - |
+      echo "Target branch: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME"
+      echo "Source branch: $CI_COMMIT_REF_NAME"
+
+      MODIFIED_FILES=$(git diff --name-only origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME..origin/$CI_COMMIT_REF_NAME)
+      echo "Modified files to check:"
+      echo "$MODIFIED_FILES"
+
+      if [ -n "$MODIFIED_FILES" ]; then
+          CI=true pre-commit run --files $MODIFIED_FILES
+      else
+          echo "No modified files to check."
+      fi
+
+check_pre_commit:
+  extends:
+    - .check_pre_commit_template
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: [--config=.codespellrc]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@ Features:
 - Add bind error event for timeout, rssi and bindlist size.
 - Reduce the number of NVS operations. [#123](https://github.com/espressif/esp-now/pull/123)
 - Use separate cache to store security keys, one for encrypt, the other for decrypt.
-- Announce securiy handshake info of initiator to responder.
+- Announce security handshake info of initiator to responder.
 
 # v2.5.1
 
@@ -33,7 +33,7 @@ Fixed:
 
 Features:
 - Control attribute is mostly meaningless. [#82](https://github.com/espressif/esp-now/issues/82)
-- Control functionality improvments. [#84](https://github.com/espressif/esp-now/issues/84)
+- Control functionality improvements. [#84](https://github.com/espressif/esp-now/issues/84)
 - Update document for match the components. [#85](https://github.com/espressif/esp-now/issues/85)
 - Support USB Serial JTAG and USB CDC console. [#86](https://github.com/espressif/esp-now/issues/86)
 - Add Kconfig options for esp-now OTA. [#94](https://github.com/espressif/esp-now/issues/94)
@@ -46,7 +46,7 @@ Fixed:
 - Fix provisioning doesn't work when enable CONFIG_ESPNOW_APP_SECURITY.[#103](https://github.com/espressif/esp-now/issues/103)
 - Fix an issue of init error after deinit.[#104](https://github.com/espressif/esp-now/issues/104)
 - Fix Wrong channel logged on send error. [#106](https://github.com/espressif/esp-now/issues/106)
-- Fix Some API is deprecated which cause compile waring. [#111](https://github.com/espressif/esp-now/issues/111)
+- Fix Some API is deprecated which cause compile warning. [#111](https://github.com/espressif/esp-now/issues/111)
 
 # v2.4.0
 
@@ -80,7 +80,7 @@ Features:
 
 Fixed:
 - Fix the bug with bindlist cleanup when unbinding.
-- Fix compile issue when enbale Anti-rollback option.
+- Fix compile issue when enable Anti-rollback option.
 - Fix the bug that prevents sending clear data when security is enabled. [#63](https://github.com/espressif/esp-now/issues/63)
 - Fix the bug where ESPNOW_INIT_CONFIG_DEFAULT does not match its declaration in C++. [#65](https://github.com/espressif/esp-now/issues/65)
 
diff --git a/Kconfig b/Kconfig
@@ -236,7 +236,7 @@ menu "ESP-NOW Configuration"
             default y
             help
                 Linenoise line editing library provides functions to save and load
-                command history. If this option is enabled, initalizes a FAT filesystem
+                command history. If this option is enabled, initializes a FAT filesystem
                 and uses it to store command history.
     endmenu
 
@@ -248,7 +248,7 @@ menu "ESP-NOW Configuration"
                 Store log info partition label.
             
         config ESPNOW_DEBUG_LOG_PARTITION_LABEL_NVS
-            string "The partition lable used to store log status"
+            string "The partition label used to store log status"
             default "log_status"
             help
                 Store log status partition label.
diff --git a/README.md b/README.md
@@ -45,4 +45,4 @@ Executing action: create-project-from-example
 CMakeLists.txt not found in project directory /home/username
 ```
 
-A1. This is because an older version packege manager was used, please run `pip install -U idf-component-manager` in ESP-IDF environment to update.
+A1. This is because an older version package manager was used, please run `pip install -U idf-component-manager` in ESP-IDF environment to update.
diff --git a/User_Guide.md b/User_Guide.md
@@ -27,7 +27,7 @@ There are two roles defined in ESP-NOW according to the data flow, initiator and
 
 ### IDF Version
 
-The following table shows the ESP-IDF versions supported by ESP-NOW at the current time. The lable ![alt text](docs/_static/yes-checkm.png "supported") means supported, and the lable ![alt text](docs/_static/no-icon.png) means not supported.
+The following table shows the ESP-IDF versions supported by ESP-NOW at the current time. The label ![alt text](docs/_static/yes-checkm.png "supported") means supported, and the label ![alt text](docs/_static/no-icon.png) means not supported.
 
 The ESP-IDF master branch is marked as not supported because the major feature changes it has introduced may cause conflicts with ESP-NOW. Yet, the ESP-NOW examples not affected by those feature changes can still run correctly on the IDF master branch.
 
@@ -116,7 +116,7 @@ ESP-NOW can be used to receive the running log for debugging. It can be used in
 
 ESP-NOW can protect the data security with ECDH and AES128-CCM.
 
-1. **Quick Configuration**: 16 devices can be configurated in 5 seconds.
+1. **Quick Configuration**: 16 devices can be configured in 5 seconds.
 2. **Multiple Devices Handshake**: ESP-NOW initiator can support multiple devices handshake at same time.
 3. **Safety**:
     - ECDH and Proof of Possession (PoP) string used to authorize session and derive shared key
diff --git a/examples/coin_cell_demo/switch/docs/button_in_matter_bridging.md b/examples/coin_cell_demo/switch/docs/button_in_matter_bridging.md
@@ -44,7 +44,7 @@ A few configurations are applied to try to speed up the execution and reduce the
 * `CONFIG_BOOTLOADER_LOG_LEVEL_NONE=y`: Let bootloader logging level to none.
 * `CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_PERF=y`: Set bootloader optimization level to -O2.
 * `CONFIG_COMPILER_OPTIMIZATION_PERF=y`: Set application optimization level to -O2.
-* `CONFIG_ESP_PHY_RF_CAL_NONE=y`: This disables the RF calibration during bootup.
+* `CONFIG_ESP_PHY_RF_CAL_NONE=y`: This disables the RF calibration during boot-up.
 * `CONFIG_LOG_DEFAULT_LEVEL_NONE=y`: This disables all logs.
 * `CONFIG_ESPNOW_LIGHT_SLEEP=y`: This asks the device to enter light sleep before starting the next transmission.
 * `CONFIG_ESPNOW_LIGHT_SLEEP_DURATION`: After ```CONFIG_ESPNOW_LIGHT_SLEEP``` is enabled, the duration can be set with this configuration. Default is 30ms.
@@ -271,7 +271,7 @@ In actual usage, usually we will only bind once and will not unbind the coin cel
 
 > However, note that with V1 hardware, for each bind operation, the button needs to send one extra control, and for each unbind, the button needs to send one extra control and one extra bind.
 
-In control tranmission, we will calculate the power consumption for both one time transmission and three-time transmission. We will also calculate the power consumption for channel switching. The numbers will be taken from the measurements above.
+In control transmission, we will calculate the power consumption for both one time transmission and three-time transmission. We will also calculate the power consumption for channel switching. The numbers will be taken from the measurements above.
 
 In battery life calculation, we assume the coin cell button will be pressed 50 times a day, and there will be 1 channel switching per day.
 
diff --git a/examples/ota/README.md b/examples/ota/README.md
@@ -32,7 +32,7 @@ python -m http.server 8070
 While the server is running, you may open this `http://localhost:8070/` in browse to check the build directory.
 
 > Note:
-	1. If there are firewall softwares that prevent any access to the port 8070, please grant the access while the example is running.
+	1. If there are firewall software that prevent any access to the port 8070, please grant the access while the example is running.
 
 ### Step 3: Build & Flash & Run the responders
 
@@ -45,7 +45,7 @@ Set following configurations under `Example Connection Configuration` Options:
 Set following configurations under `Example Configuration` Options:
 * Set `ESP-NOW mode` to `Responder Mode`
 
-When downloading the flash, it's recommend to use `erase_flash` to erase the entire flash memory (all the remaining data in ota_data partition will be deleted as well) for the first time, and then write the followings via a serial port:
+When downloading the flash, it's recommend to use `erase_flash` to erase the entire flash memory (all the remaining data in ota_data partition will be deleted as well) for the first time, and then write the following via a serial port:
 
 ```shell
 idf.py erase_flash flash
@@ -78,7 +78,7 @@ for e.g,
 http://192.168.0.3:8070/hello-world.bin
 ```
 
-When downloading the flash, it's recommend to use `erase_flash` to erase the entire flash memory (all the remaining data in ota_data partition will be deleted as well) for the first time, and then write the followings via a serial port:
+When downloading the flash, it's recommend to use `erase_flash` to erase the entire flash memory (all the remaining data in ota_data partition will be deleted as well) for the first time, and then write the following via a serial port:
 
 ```shell
 idf.py erase_flash flash
diff --git a/examples/solution/README.md b/examples/solution/README.md
@@ -77,7 +77,7 @@ Then the initiator and responders can communicate ESP-NOW application data in se
 
 If the device runs for the first time, it has not stored the router info and will not connect to AP. If it has stored the AP info, it will connect to router when WiFi start.
 
-Double click the provision button if the device is not configurated and the light will turn `white`.
+Double click the provision button if the device is not configured and the light will turn `white`.
 
 Use APP to scan the QR code to provision the initiator board, please refer to [README](https://github.com/espressif/esp-idf/blob/v4.4.1/examples/provisioning/wifi_prov_mgr/README.md)
 
@@ -308,7 +308,7 @@ I (355451) app: unbind, uuid: 7c:df:a1:76:42:38, initiator_type: 513
 
 * Errors `E (14798) espnow_sec: Failed at mbedtls_ccm_auth_decrypt with error code : -15`. It means authentication failed. Maybe initiator board erases its flash and generates a new security key, not the same with responder. If you see this error please erase responder board flash and reset responder board, the security handshake will execute again after reset initiator board. The responder board will get the security key to keep the same with initiator board.
 * Build with ESP32-C3 failed with 'ADC_BUTTON_WIDTH' undeclared.
-  Please change the defination as the following in [button_adc.c](managed_components/espressif__button/button_adc.c)
+  Please change the definition as the following in [button_adc.c](managed_components/espressif__button/button_adc.c)
 
 ```
 #if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3
diff --git a/examples/solution/components/wifi_prov/wifi_prov.c b/examples/solution/components/wifi_prov/wifi_prov.c
@@ -70,7 +70,7 @@ static void event_handler(void* arg, esp_event_base_t event_base,
 #ifdef CONFIG_APP_WIFI_PROVISION_RESET_PROV_MGR_ON_FAILURE
                 retries++;
                 if (retries >= CONFIG_APP_WIFI_PROVISION_PROV_MGR_MAX_RETRY_CNT) {
-                    ESP_LOGI(TAG, "Failed to connect with provisioned AP, reseting provisioned credentials");
+                    ESP_LOGI(TAG, "Failed to connect with provisioned AP, resetting provisioned credentials");
                     network_prov_mgr_reset_wifi_sm_state_on_failure();
                     retries = 0;
                 }
diff --git a/examples/solution/main/Kconfig.projbuild b/examples/solution/main/Kconfig.projbuild
@@ -138,13 +138,13 @@ menu "Example Configuration"
             depends on APP_WIFI_PROVISION
             prompt "Reset provisioned credentials and state machine after session failure"
             help
-                Enable reseting provisioned credentials and state machine after session failure.
+                Enable resetting provisioned credentials and state machine after session failure.
                 This will restart the provisioning service after retries are exhausted.
 
         config APP_WIFI_PROVISION_PROV_MGR_MAX_RETRY_CNT
             int
             default 5
-            prompt "Max retries before reseting provisioning state machine"
+            prompt "Max retries before resetting provisioning state machine"
             depends on APP_WIFI_PROVISION_RESET_PROV_MGR_ON_FAILURE
             help
                 Set the Maximum retry to avoid reconnecting to an inexistent AP or if credentials
diff --git a/examples/wireless_debug/components/web_server/README.md b/examples/wireless_debug/components/web_server/README.md
@@ -18,7 +18,7 @@ This example designs several APIs to fetch resources as follows:
 
 ### About mDNS
 
-The IP address of an IoT device may vary from time to time, so it’s impracticable to hard code the IP address in the webpage. In this example, we use the `mDNS` to parse the domain name `esp-home.local`, so that we can alway get access to the web server by this URL no matter what the real IP address behind it. See [here](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mdns.html) for more information about mDNS.
+The IP address of an IoT device may vary from time to time, so it’s impracticable to hard code the IP address in the webpage. In this example, we use the `mDNS` to parse the domain name `esp-home.local`, so that we can always get access to the web server by this URL no matter what the real IP address behind it. See [here](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mdns.html) for more information about mDNS.
 
 **Notes: mDNS is installed by default on most operating systems or is available as separate package.**
 
@@ -67,7 +67,7 @@ In the `Example Connection Configuration` menu:
 * If you select the Ethernet interface, you also have to set:
   * PHY model in `Ethernet PHY` option, e.g. IP101.
   * PHY address in `PHY Address` option, which should be determined by your board schematic.
-  * EMAC Clock mode, GPIO used by SMI.
+  * EMACS Clock mode, GPIO used by SMI.
 
 In the `Example Configuration` menu:
 
diff --git a/examples/wireless_debug/components/web_server/dns_server.c b/examples/wireless_debug/components/web_server/dns_server.c
@@ -89,11 +89,11 @@ static uint16_t get_uint16(const uint8_t *pnt)
 static int parse_next_query(void *data, int size, dns_query_t *query)
 {
     int len;
-    int lables;
+    int labels;
     uint8_t *ptr;
 
     len = 0;
-    lables = 0;
+    labels = 0;
     ptr = (uint8_t *)data;
 
     while (true) {
@@ -110,7 +110,7 @@ static int parse_next_query(void *data, int size, dns_query_t *query)
             break;
         }
 
-        if (lables > 0) {
+        if (labels > 0) {
             if (len == DNS_MAX_HOST_NAME_LEN) {
                 return -2;
             }
@@ -130,7 +130,7 @@ static int parse_next_query(void *data, int size, dns_query_t *query)
         len += lable_len;
         ptr += lable_len;
         size -= lable_len;
-        lables++;
+        labels++;
     }
 
     if (size < 4) {
diff --git a/src/debug/include/espnow_log.h b/src/debug/include/espnow_log.h
@@ -110,7 +110,7 @@ esp_err_t espnow_log_set_config(const espnow_log_config_t *config);
 /**
  * @brief Initialize log debug
  *        - Set log debug configuration
- *        - Create the log sendinng task
+ *        - Create the log sending task
  *
  * @param[in]  config  the configuration of the log
  * 
diff --git a/src/debug/include/sdcard/sdcard.h b/src/debug/include/sdcard/sdcard.h
@@ -102,7 +102,7 @@ esp_err_t sdcard_print_file(const char *file_name, file_format_t type, ssize_t s
  *
  * @param  file_name  file name
  * @param  offset  write offset, if offset == UINT32_MAX, add data at end of file.
- * @param  data  writen data
+ * @param  data  written data
  * @param  size  data length
  *
  * @return
diff --git a/src/debug/src/commands/cmd_iperf.c b/src/debug/src/commands/cmd_iperf.c
@@ -74,7 +74,7 @@ static int espnow_config_func(int argc, char **argv)
         esp_wifi_get_protocol(WIFI_IF_STA, &protocol_bitmap);
 
         ESP_LOGI(TAG, "Channel, primary: %d, second: %d", primary, second);
-        ESP_LOGI(TAG, "Maximum transmiting power: %d", power);
+        ESP_LOGI(TAG, "Maximum transmitting power: %d", power);
         ESP_LOGI(TAG, "Wi-Fi protocol bitmap: 0x%02x", protocol_bitmap);
         country.cc[2] = '\0';
         ESP_LOGI(TAG, "Wi-Fi country code: %s", country.cc);
diff --git a/src/debug/src/commands/cmd_system.c b/src/debug/src/commands/cmd_system.c
@@ -104,7 +104,7 @@ static int version_func(int argc, char **argv)
 #endif
 
         default:
-            chip_name = "Unknow";
+            chip_name = "Unknown";
             break;
     }
 
@@ -120,7 +120,7 @@ static int version_func(int argc, char **argv)
         { NULL,          0xff},
     };
 
-    const char *flash_manufacturer = "Unknow";
+    const char *flash_manufacturer = "Unknown";
 #if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32S2
     uint32_t raw_flash_id    = g_rom_flashchip.device_id;
 #else
diff --git a/src/debug/src/commands/cmd_wifi_sniffer.c b/src/debug/src/commands/cmd_wifi_sniffer.c
@@ -334,7 +334,7 @@ static int wifi_sniffer_func(int argc, char **argv)
                  CONFIG_SNIFFER_MOUNT_POINT, SNIFFER_DEFAULT_FILE_NAME);
     }
 
-    /* Determin file name */
+    /* Determine file name */
     if (create_packet_file() != ESP_OK) {
         return 1;
     }
diff --git a/src/debug/src/commands/pcap/pcap.h b/src/debug/src/commands/pcap/pcap.h
@@ -70,7 +70,7 @@ typedef struct {
 esp_err_t pcap_new(pcap_config_t *config);
 
 /**
- * @brief Close pcap file and recyle related resources
+ * @brief Close pcap file and recycle related resources
  *
  * @return esp_err_t ESP_OK on success, ESP_FAIL on error
  */
diff --git a/src/espnow/include/espnow.h b/src/espnow/include/espnow.h
@@ -82,9 +82,9 @@ typedef struct {
     uint32_t send_max_timeout;              /**< Maximum timeout */
     struct {
         bool ack                    : 1;    /**< Enable or disable ACK */
-        bool forward                : 1;    /**< Enable or disable forword */
+        bool forward                : 1;    /**< Enable or disable forward */
         bool group                  : 1;    /**< Enable or disable group */
-        bool provisoning            : 1;    /**< Enable or disable provisoning */
+        bool provisioning            : 1;    /**< Enable or disable provisioning */
         bool control_bind           : 1;    /**< Enable or disable control bind */
         bool control_data           : 1;    /**< Enable or disable control data */
         bool ota_status             : 1;    /**< Enable or disable OTA status */
@@ -113,7 +113,7 @@ typedef struct {
                 .ack           = 1, \
                 .forward       = 1, \
                 .group         = 1, \
-                .provisoning   = 0, \
+                .provisioning   = 0, \
                 .control_bind  = 0, \
                 .control_data  = 0, \
                 .ota_status    = 0, \
diff --git a/src/espnow/src/espnow.c b/src/espnow/src/espnow.c
@@ -70,7 +70,7 @@ typedef struct {
     uint8_t random_values[4];
     struct {
         uint8_t element_id;                 // 0xdd
-        uint8_t lenght;                     //
+        uint8_t length;                     //
         uint8_t organization_identifier[3]; // 0x18fe34
         uint8_t type;                       // 4
         uint8_t version;
diff --git a/src/ota/espnow_ota_responder.c b/src/ota/espnow_ota_responder.c
@@ -190,7 +190,7 @@ static esp_err_t espnow_ota_status_handle(const espnow_addr_t src_addr, const es
     ret = esp_ota_begin(update, g_ota_config->status.total_size, &g_ota_config->handle);
     ESP_ERROR_GOTO(ret != ESP_OK, EXIT, "esp_ota_begin failed");
 
-    /**< Save upgrade infomation to flash. */
+    /**< Save upgrade information to flash. */
     ret = espnow_storage_set(ESPNOW_OTA_STORE_CONFIG_KEY, g_ota_config,
                           sizeof(ota_config_t) + g_ota_config->status.packet_num / 8 + 1);
     ESP_ERROR_GOTO(ret != ESP_OK, EXIT, "info_store_save, ret: %d", ret);
diff --git a/src/security/include/espnow_security_handshake.h b/src/security/include/espnow_security_handshake.h
@@ -94,7 +94,7 @@ typedef struct espnow_sec_result_s {
  * @attention Only called at the root
  *
  * @param[out]  info_list  destination nodes of mac
- * @param[out]  num  number of scaned nodes
+ * @param[out]  num  number of scanned nodes
  * @param[in]  wait_ticks  the maximum scanning time in ticks
  *
  * @return
diff --git a/src/security/src/protocomm/security/client_security1.c b/src/security/src/protocomm/security/client_security1.c
diff --git a/src/utils/include/espnow_mem.h b/src/utils/include/espnow_mem.h
diff --git a/src/utils/include/espnow_storage.h b/src/utils/include/espnow_storage.h
diff --git a/src/utils/include/espnow_utils.h b/src/utils/include/espnow_utils.h
