Merge branch 'master' into release/v3.1.x

Author: me-no-dev

.codespellrc

@@ -1,9 +1,8 @@
 [codespell]
 # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
 # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
-ignore-words-list = ba,licence,ot,dout,als,exten,acount,totaly,pasttime
+ignore-words-list = ba,licence,ot,dout,als,exten
 skip = ./.git,./.licenses,__pycache__,.clang-format,.codespellrc,.editorconfig,.flake8,.prettierignore,.yamllint.yml,.gitignore,boards.txt,platform.txt,programmers.txt
 builtin = clear,informal,en-GB_to_en-US
 check-filenames =
 check-hidden =
-write-changes =

.pre-commit-config.yaml

@@ -1,7 +1,9 @@
 exclude: |
   (?x)(
       ^\.github\/|
-      ^tests\/performance\/coremark\/.*\.[ch]$
+      ^tests\/performance\/coremark\/.*\.[ch]$|
+      ^tests\/performance\/superpi\/.*\.(cpp|h)$|
+      LICENSE\.md$
   )
 
 default_language_version:
@@ -24,11 +26,10 @@ repos:
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/codespell-project/codespell
-    rev: "v2.2.4"
+    rev: "v2.3.0"
     hooks:
       - id: codespell
         exclude: ^.*\.(svd|SVD)$
-        stages: [manual]
   - repo: https://github.com/pre-commit/mirrors-clang-format
     rev: "v18.1.3"
     hooks:
@@ -64,8 +65,6 @@ repos:
         pass_filenames: false
         args: [sync]
         types_or: [markdown, rst]
-        stages: [manual]
       - id: vale
         language_version: "1.21.6"
         types_or: [markdown, rst]
-        stages: [manual]

.vale.ini

@@ -23,7 +23,7 @@ StylesPath = .vale/styles
 
 
 # Specify the minimum alert severity that Vale will report.
-MinAlertLevel = suggestion # "suggestion", "warning", or "error"
+MinAlertLevel = error # "suggestion", "warning", or "error"
 
 
 # Specify vocabulary for special treatment.

CODE_OF_CONDUCT.md

@@ -5,7 +5,7 @@
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, religion, or sexual identity
 and orientation.
 

cores/esp32/Arduino.h

@@ -179,7 +179,7 @@ void initArduino(void);
 unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout);
 unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout);
 
-uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
+uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);  // codespell:ignore shiftin
 void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
 
 #ifdef __cplusplus

cores/esp32/HWCDC.cpp

@@ -443,7 +443,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
       if (connected) {
         usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SERIAL_IN_EMPTY);
       }
-      // tracks CDC trasmission progress to avoid hanging if CDC is unplugged while still sending data
+      // tracks CDC transmission progress to avoid hanging if CDC is unplugged while still sending data
       size_t last_toSend = to_send;
       uint32_t tries = tx_timeout_ms;  // waits 1ms per sending data attempt, in case CDC is unplugged
       while (connected && to_send) {
@@ -479,7 +479,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
         }
       }
     }
-    // CDC was diconnected while sending data ==> flush the TX buffer keeping the last data
+    // CDC was disconnected while sending data ==> flush the TX buffer keeping the last data
     if (to_send && !usb_serial_jtag_ll_txfifo_writable()) {
       connected = false;
       flushTXBuffer(buffer + so_far, to_send);

cores/esp32/HardwareSerial.h

@@ -228,7 +228,7 @@ class HardwareSerial : public Stream {
 
   // onReceive will setup a callback that will be called whenever an UART interruption occurs (UART_INTR_RXFIFO_FULL or UART_INTR_RXFIFO_TOUT)
   // UART_INTR_RXFIFO_FULL interrupt triggers at UART_FULL_THRESH_DEFAULT bytes received (defined as 120 bytes by default in IDF)
-  // UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbos by default in IDF)
+  // UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbols by default in IDF)
   // onlyOnTimeout parameter will define how onReceive will behave:
   // Default: true -- The callback will only be called when RX Timeout happens.
   //                  Whole stream of bytes will be ready for being read on the callback function at once.

cores/esp32/esp32-hal-uart.c

@@ -45,7 +45,7 @@ struct uart_struct_t {
   bool has_peek;                   // flag to indicate that there is a peek byte pending to be read
   uint8_t peek_byte;               // peek byte that has been read but not consumed
   QueueHandle_t uart_event_queue;  // export it by some uartGetEventQueue() function
-  // configuration data:: Arduino API tipical data
+  // configuration data:: Arduino API typical data
   int8_t _rxPin, _txPin, _ctsPin, _rtsPin;  // UART GPIOs
   uint32_t _baudrate, _config;              // UART baudrate and config
   // UART ESP32 specific data

cores/esp32/wiring_shift.c

@@ -20,7 +20,7 @@
 #include "esp32-hal.h"
 #include "wiring_private.h"
 
-uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {
+uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {  // codespell:ignore shiftin
   uint8_t value = 0;
   uint8_t i;
 

docs/en/api/adc.rst

@@ -53,7 +53,7 @@ analogReadResolution
 ^^^^^^^^^^^^^^^^^^^^
 
 This function is used to set the resolution of ``analogRead`` return value. Default is 12 bits (range from 0 to 4095)
-for all chips except ESP32S3 where default is 13 bits (range from 0 to 8191).
+for all chips except ESP32-S3 where default is 13 bits (range from 0 to 8191).
 When different resolution is set, the values read will be shifted to match the given resolution.
 
 Range is 1 - 16 .The default value will be used, if this function is not used.
@@ -146,7 +146,7 @@ analogSetWidth
 .. note:: This function is only available for ESP32 chip.
 
 This function is used to set the hardware sample bits and read resolution.
-Default is 12bit (0 - 4095).
+Default is 12 bits (0 - 4095).
 Range is 9 - 12.
 
 .. code-block:: arduino
@@ -250,13 +250,13 @@ This function is used to set the attenuation for ADC continuous peripheral. For
 
     void analogContinuousSetAtten(adc_attenuation_t attenuation);
 
-* ``attenuation`` sets the attenuation (default is 11db).
+* ``attenuation`` sets the attenuation (default is 11 dB).
 
 analogContinuousSetWidth
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 This function is used to set the hardware resolution bits.
-Default value for all chips is 12bit (0 - 4095).
+Default value for all chips is 12 bits (0 - 4095).
 
 .. note:: This function will take effect only for ESP32 chip, as it allows to set resolution in range 9-12 bits.
 

docs/en/api/dac.rst

@@ -33,7 +33,7 @@ This function is used to set the DAC value for a given pin/DAC channel.
     void dacWrite(uint8_t pin, uint8_t value);
 
 * ``pin`` GPIO pin.
-* ``value`` to be set. Range is 0 - 255 (equals 0V - 3.3V).
+* ``value`` to be set. Range is 0 - 255 (equals 0 V - 3.3 V).
 
 dacDisable
 **********

docs/en/api/espnow.rst

@@ -104,7 +104,7 @@ Create an instance of the `ESP_NOW_Peer` class.
 
 * ``mac_addr``: MAC address of the peer device.
 * ``channel``: Communication channel.
-* ``iface``: WiFi interface.
+* ``iface``: Wi-Fi interface.
 * ``lmk``: Optional. Pass the local master key (LMK) if encryption is enabled.
 
 add
@@ -190,24 +190,24 @@ Set the communication channel of the peer.
 getInterface
 ^^^^^^^^^^^^
 
-Get the WiFi interface of the peer.
+Get the Wi-Fi interface of the peer.
 
 .. code-block:: cpp
 
     wifi_interface_t getInterface() const;
 
-Returns the WiFi interface.
+Returns the Wi-Fi interface.
 
 setInterface
 ^^^^^^^^^^^^
 
-Set the WiFi interface of the peer.
+Set the Wi-Fi interface of the peer.
 
 .. code-block:: cpp
 
     void setInterface(wifi_interface_t iface);
 
-* ``iface``: WiFi interface.
+* ``iface``: Wi-Fi interface.
 
 isEncrypted
 ^^^^^^^^^^^

docs/en/api/gpio.rst

@@ -9,7 +9,7 @@ One of the most used and versatile peripheral in a microcontroller is the GPIO.
 
 GPIO stands to General Purpose Input Output, and is responsible to control or read the state of a specific pin in the digital world. For example, this peripheral is widely used to create the LED blinking or to read a simple button.
 
-.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the developemnt board. For more information about it, see the corresponding board pin layout information.
+.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the development board. For more information about it, see the corresponding board pin layout information.
 
 GPIOs Modes
 ***********

docs/en/api/i2c.rst

@@ -103,7 +103,7 @@ This function will return the current frequency configuration.
 setTimeOut
 ^^^^^^^^^^
 
-Set the bus timeout given in milliseconds. The default value is 50ms.
+Set the bus timeout given in milliseconds. The default value is 50 ms.
 
 .. code-block:: arduino
 

docs/en/api/insights.rst

@@ -5,7 +5,7 @@ ESP Insights
 About
 -----
 
-ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of ESP devices in the field.
+ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of Espressif devices in the field.
 
 Developers normally prefer debugging issues by physically probing them using gdb or observing the logs. This surely helps debug issues, but there are often cases wherein issues are seen only in specific environments under specific conditions. Even things like casings and placement of the product can affect the behavior. A few examples are
 
@@ -156,8 +156,8 @@ This function will return
 Insights.metrics.dumpWiFi
 *************************
 
-Dumps the wifi metrics and prints them to the console.
-This API can be used to collect wifi metrics at any given point in time.
+Dumps the Wi-Fi metrics and prints them to the console.
+This API can be used to collect Wi-Fi metrics at any given point in time.
 
 .. code-block:: arduino
 
@@ -185,8 +185,8 @@ Insights.metrics.setWiFiPeriod
 ******************************
 
 Reset the periodic interval
-By default, wifi metrics are collected every 30 seconds, this function can be used to change the interval.
-If the interval is set to 0, wifi metrics collection disabled.
+By default, Wi-Fi metrics are collected every 30 seconds, this function can be used to change the interval.
+If the interval is set to 0, Wi-Fi metrics collection disabled.
 
 .. code-block:: arduino
 

docs/en/api/rainmaker.rst

@@ -29,7 +29,7 @@ ESP RainMaker Agent API
 RMaker.initNode
 ***************
 
-This initializes the ESP RainMaker agent, wifi and creates the node.
+This initializes the ESP RainMaker agent, Wi-Fi and creates the node.
 
 You can also set the configuration of the node using the following API
 
@@ -54,7 +54,7 @@ It starts the ESP RainMaker agent.
 **NOTE**:
 
 1. ESP RainMaker agent should be initialized before this call.
-2. Once ESP RainMaker agent starts, compulsorily call WiFi.beginProvision() API.
+2. Once ESP RainMaker agent starts, compulsorily call ``WiFi.beginProvision()`` API.
 
 .. code-block:: arduino
 

docs/en/api/touch.rst

@@ -36,7 +36,7 @@ touchSetCycles
 ^^^^^^^^^^^^^^
 
 This function is used to set cycles that measurement operation takes. The result from touchRead, threshold and detection accuracy depend on these values.
-The defaults are setting touchRead to take ~0.5ms.
+The defaults are setting touchRead to take ~0.5 ms.
 
 .. code-block:: arduino
 
@@ -112,8 +112,8 @@ the threshold value. Default is lower.
 
     void touchInterruptSetThresholdDirection(bool mustbeLower);
 
-TOUCH API specific for ESP32S2 and ESP32S3 chip (TOUCH_V2)
-**********************************************************
+TOUCH API specific for ESP32-S2 and ESP32-S3 chip (TOUCH_V2)
+************************************************************
 
 touchInterruptGetLastStatus
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/en/api/usb.rst

@@ -154,7 +154,7 @@ Get the USB power configuration.
 
     uint16_t usbPower(void);
 
-Return the current in mA. The default value is: ``0x500`` (500mA).
+Return the current in mA. The default value is: ``0x500`` (500 mA).
 
 usbClass
 ^^^^^^^^

docs/en/api/wifi.rst

@@ -43,7 +43,7 @@ This is the mode to be used if you want to connect your project to the Internet.
 API Description
 ---------------
 
-Here is the description of the WiFi API.
+Here is the description of the Wi-Fi API.
 
 Common API
 ----------
@@ -53,7 +53,7 @@ Here are the common APIs that are used for both modes, AP and STA.
 onEvent (and removeEvent)
 *************************
 
-Registers a caller-supplied function to be called when WiFi events
+Registers a caller-supplied function to be called when Wi-Fi events
 occur. Several forms are available.
 
 Function pointer callback taking the event ID:
@@ -92,7 +92,7 @@ A similar set of functions are available to remove callbacks:
 
 In all cases, the subscribing function accepts an optional event type to
 invoke the callback only for that specific event; with the default
-``ARDUINO_EVENT_MAX``, the callback will be invoked for all WiFi events.
+``ARDUINO_EVENT_MAX``, the callback will be invoked for all Wi-Fi events.
 
 Any callback function is given the event type in a parameter.
 Some of the possible callback function formats also take an
@@ -141,9 +141,9 @@ may be retrieved:
 
 .. warning::
 
-    The ``setHostname()`` function must be called BEFORE WiFi is started with
+    The ``setHostname()`` function must be called BEFORE Wi-Fi is started with
     ``WiFi.begin()``, ``WiFi.softAP()``, ``WiFi.mode()``, or ``WiFi.run()``.
-    To change the name, reset WiFi with ``WiFi.mode(WIFI_MODE_NULL)``,
+    To change the name, reset Wi-Fi with ``WiFi.mode(WIFI_MODE_NULL)``,
     then proceed with ``WiFi.setHostname(...)`` and restart WiFi from scratch.
 
 useStaticBuffers
@@ -619,7 +619,7 @@ WiFiScan
 
 To perform the Wi-Fi scan for networks, you can use the following functions:
 
-Start scan WiFi networks available.
+Start scan Wi-Fi networks available.
 
 .. code-block:: arduino
 
@@ -637,7 +637,7 @@ Delete last scan result from RAM.
 
     void scanDelete();
 
-Loads all infos from a scanned wifi in to the ptr parameters.
+Loads all infos from a scanned Wi-Fi in to the ptr parameters.
 
 .. code-block:: arduino
 
@@ -648,7 +648,7 @@ To see how to use the ``WiFiScan``, take a look at the ``WiFiScan.ino`` or ``WiF
 Examples
 --------
 
-`Complete list of WiFi examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi/examples>`_.
+`Complete list of Wi-Fi examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi/examples>`_.
 
 .. _ap example:
 

docs/en/boards/ESP32-C3-DevKitM-1.rst

@@ -7,8 +7,8 @@ The ESP32-C3-DevKitM-1 development board is one of Espressif's official boards.
 Specifications
 --------------
 
-- Small­ sized 2.4 GHz Wi­Fi (802.11 b/g/n) and Bluetooth® 5 module
-- Built around ESP32­C3 series of SoCs, RISC­V single­core microprocessor
+- Small sized 2.4 GHz Wi-Fi (802.11b/g/n) and Bluetooth® 5 module
+- Built around ESP32-C3 series of SoCs, RISC-V single-core microprocessor
 - 4 MB flash in chip package
 - 15 available GPIOs (module)
 - Peripherals
@@ -30,7 +30,7 @@ Specifications
         - 2 × 54-bit general-purpose timers
         - 3 × watchdog timers
         - 1 × 52-bit system timer
-- On­board PCB antenna or external antenna connector
+- PCB antenna or external antenna connector
 
 Header Block
 ------------
@@ -40,6 +40,9 @@ Header Block
 
 J1
 ^^^
+
+.. vale off
+
 ===  ====  ==========  ===================================
 No.  Name  Type [1]_   Function
 ===  ====  ==========  ===================================
@@ -60,6 +63,8 @@ No.  Name  Type [1]_   Function
 15   GND   G           Ground
 ===  ====  ==========  ===================================
 
+.. vale on
+
 J3
 ^^^
 ===  ====  ==========  ====================================