Skip to content

Commit 75b29fd

Browse files
me-no-devme-no-dev
authored
Merge branch 'master' into release/v3.1.x
2 parents fa67115 + 683fea1 commit 75b29fd

File tree

90 files changed

+221
-193
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+221
-193
lines changed

‎.codespellrc

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

‎.pre-commit-config.yaml

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
exclude: |
22
(?x)(
33
^\.github\/|
4-
^tests\/performance\/coremark\/.*\.[ch]$
4+
^tests\/performance\/coremark\/.*\.[ch]$|
5+
^tests\/performance\/superpi\/.*\.(cpp|h)$|
6+
LICENSE\.md$
57
)
68
79
default_language_version:
@@ -24,11 +26,10 @@ repos:
2426
- id: trailing-whitespace
2527
args: [--markdown-linebreak-ext=md]
2628
- repo: https://github.com/codespell-project/codespell
27-
rev: "v2.2.4"
29+
rev: "v2.3.0"
2830
hooks:
2931
- id: codespell
3032
exclude: ^.*\.(svd|SVD)$
31-
stages: [manual]
3233
- repo: https://github.com/pre-commit/mirrors-clang-format
3334
rev: "v18.1.3"
3435
hooks:
@@ -64,8 +65,6 @@ repos:
6465
pass_filenames: false
6566
args: [sync]
6667
types_or: [markdown, rst]
67-
stages: [manual]
6868
- id: vale
6969
language_version: "1.21.6"
7070
types_or: [markdown, rst]
71-
stages: [manual]

‎.vale.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ StylesPath = .vale/styles
2323

2424

2525
# Specify the minimum alert severity that Vale will report.
26-
MinAlertLevel = suggestion # "suggestion", "warning", or "error"
26+
MinAlertLevel = error # "suggestion", "warning", or "error"
2727

2828

2929
# Specify vocabulary for special treatment.

‎CODE_OF_CONDUCT.md

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

‎cores/esp32/Arduino.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ void initArduino(void);
179179
unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout);
180180
unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout);
181181

182-
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
182+
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder); // codespell:ignore shiftin
183183
void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
184184

185185
#ifdef __cplusplus

‎cores/esp32/HWCDC.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
443443
if (connected) {
444444
usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SERIAL_IN_EMPTY);
445445
}
446-
// tracks CDC trasmission progress to avoid hanging if CDC is unplugged while still sending data
446+
// tracks CDC transmission progress to avoid hanging if CDC is unplugged while still sending data
447447
size_t last_toSend = to_send;
448448
uint32_t tries = tx_timeout_ms; // waits 1ms per sending data attempt, in case CDC is unplugged
449449
while (connected && to_send) {
@@ -479,7 +479,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
479479
}
480480
}
481481
}
482-
// CDC was diconnected while sending data ==> flush the TX buffer keeping the last data
482+
// CDC was disconnected while sending data ==> flush the TX buffer keeping the last data
483483
if (to_send && !usb_serial_jtag_ll_txfifo_writable()) {
484484
connected = false;
485485
flushTXBuffer(buffer + so_far, to_send);

‎cores/esp32/HardwareSerial.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ class HardwareSerial : public Stream {
228228

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

‎cores/esp32/esp32-hal-uart.c

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

‎cores/esp32/wiring_shift.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#include "esp32-hal.h"
2121
#include "wiring_private.h"
2222

23-
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {
23+
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) { // codespell:ignore shiftin
2424
uint8_t value = 0;
2525
uint8_t i;
2626

‎docs/en/api/adc.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ analogReadResolution
5353
^^^^^^^^^^^^^^^^^^^^
5454

5555
This function is used to set the resolution of ``analogRead`` return value. Default is 12 bits (range from 0 to 4095)
56-
for all chips except ESP32S3 where default is 13 bits (range from 0 to 8191).
56+
for all chips except ESP32-S3 where default is 13 bits (range from 0 to 8191).
5757
When different resolution is set, the values read will be shifted to match the given resolution.
5858

5959
Range is 1 - 16 .The default value will be used, if this function is not used.
@@ -146,7 +146,7 @@ analogSetWidth
146146
.. note:: This function is only available for ESP32 chip.
147147

148148
This function is used to set the hardware sample bits and read resolution.
149-
Default is 12bit (0 - 4095).
149+
Default is 12 bits (0 - 4095).
150150
Range is 9 - 12.
151151

152152
.. code-block:: arduino
@@ -250,13 +250,13 @@ This function is used to set the attenuation for ADC continuous peripheral. For
250250
251251
void analogContinuousSetAtten(adc_attenuation_t attenuation);
252252
253-
* ``attenuation`` sets the attenuation (default is 11db).
253+
* ``attenuation`` sets the attenuation (default is 11 dB).
254254

255255
analogContinuousSetWidth
256256
^^^^^^^^^^^^^^^^^^^^^^^^
257257

258258
This function is used to set the hardware resolution bits.
259-
Default value for all chips is 12bit (0 - 4095).
259+
Default value for all chips is 12 bits (0 - 4095).
260260

261261
.. note:: This function will take effect only for ESP32 chip, as it allows to set resolution in range 9-12 bits.
262262

‎docs/en/api/dac.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This function is used to set the DAC value for a given pin/DAC channel.
3333
void dacWrite(uint8_t pin, uint8_t value);
3434
3535
* ``pin`` GPIO pin.
36-
* ``value`` to be set. Range is 0 - 255 (equals 0V - 3.3V).
36+
* ``value`` to be set. Range is 0 - 255 (equals 0 V - 3.3 V).
3737

3838
dacDisable
3939
**********

‎docs/en/api/espnow.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Create an instance of the `ESP_NOW_Peer` class.
104104
105105
* ``mac_addr``: MAC address of the peer device.
106106
* ``channel``: Communication channel.
107-
* ``iface``: WiFi interface.
107+
* ``iface``: Wi-Fi interface.
108108
* ``lmk``: Optional. Pass the local master key (LMK) if encryption is enabled.
109109

110110
add
@@ -190,24 +190,24 @@ Set the communication channel of the peer.
190190
getInterface
191191
^^^^^^^^^^^^
192192

193-
Get the WiFi interface of the peer.
193+
Get the Wi-Fi interface of the peer.
194194

195195
.. code-block:: cpp
196196
197197
wifi_interface_t getInterface() const;
198198
199-
Returns the WiFi interface.
199+
Returns the Wi-Fi interface.
200200

201201
setInterface
202202
^^^^^^^^^^^^
203203

204-
Set the WiFi interface of the peer.
204+
Set the Wi-Fi interface of the peer.
205205

206206
.. code-block:: cpp
207207
208208
void setInterface(wifi_interface_t iface);
209209
210-
* ``iface``: WiFi interface.
210+
* ``iface``: Wi-Fi interface.
211211

212212
isEncrypted
213213
^^^^^^^^^^^

‎docs/en/api/gpio.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ One of the most used and versatile peripheral in a microcontroller is the GPIO.
99

1010
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.
1111

12-
.. 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.
12+
.. 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.
1313

1414
GPIOs Modes
1515
***********

‎docs/en/api/i2c.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This function will return the current frequency configuration.
103103
setTimeOut
104104
^^^^^^^^^^
105105

106-
Set the bus timeout given in milliseconds. The default value is 50ms.
106+
Set the bus timeout given in milliseconds. The default value is 50 ms.
107107

108108
.. code-block:: arduino
109109

‎docs/en/api/insights.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ESP Insights
55
About
66
-----
77

8-
ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of ESP devices in the field.
8+
ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of Espressif devices in the field.
99

1010
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
1111

@@ -156,8 +156,8 @@ This function will return
156156
Insights.metrics.dumpWiFi
157157
*************************
158158

159-
Dumps the wifi metrics and prints them to the console.
160-
This API can be used to collect wifi metrics at any given point in time.
159+
Dumps the Wi-Fi metrics and prints them to the console.
160+
This API can be used to collect Wi-Fi metrics at any given point in time.
161161

162162
.. code-block:: arduino
163163
@@ -185,8 +185,8 @@ Insights.metrics.setWiFiPeriod
185185
******************************
186186

187187
Reset the periodic interval
188-
By default, wifi metrics are collected every 30 seconds, this function can be used to change the interval.
189-
If the interval is set to 0, wifi metrics collection disabled.
188+
By default, Wi-Fi metrics are collected every 30 seconds, this function can be used to change the interval.
189+
If the interval is set to 0, Wi-Fi metrics collection disabled.
190190

191191
.. code-block:: arduino
192192

‎docs/en/api/rainmaker.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ESP RainMaker Agent API
2929
RMaker.initNode
3030
***************
3131

32-
This initializes the ESP RainMaker agent, wifi and creates the node.
32+
This initializes the ESP RainMaker agent, Wi-Fi and creates the node.
3333

3434
You can also set the configuration of the node using the following API
3535

@@ -54,7 +54,7 @@ It starts the ESP RainMaker agent.
5454
**NOTE**:
5555

5656
1. ESP RainMaker agent should be initialized before this call.
57-
2. Once ESP RainMaker agent starts, compulsorily call WiFi.beginProvision() API.
57+
2. Once ESP RainMaker agent starts, compulsorily call ``WiFi.beginProvision()`` API.
5858

5959
.. code-block:: arduino
6060

‎docs/en/api/touch.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ touchSetCycles
3636
^^^^^^^^^^^^^^
3737

3838
This function is used to set cycles that measurement operation takes. The result from touchRead, threshold and detection accuracy depend on these values.
39-
The defaults are setting touchRead to take ~0.5ms.
39+
The defaults are setting touchRead to take ~0.5 ms.
4040

4141
.. code-block:: arduino
4242
@@ -112,8 +112,8 @@ the threshold value. Default is lower.
112112
113113
void touchInterruptSetThresholdDirection(bool mustbeLower);
114114
115-
TOUCH API specific for ESP32S2 and ESP32S3 chip (TOUCH_V2)
116-
**********************************************************
115+
TOUCH API specific for ESP32-S2 and ESP32-S3 chip (TOUCH_V2)
116+
************************************************************
117117

118118
touchInterruptGetLastStatus
119119
^^^^^^^^^^^^^^^^^^^^^^^^^^^

‎docs/en/api/usb.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Get the USB power configuration.
154154
155155
uint16_t usbPower(void);
156156
157-
Return the current in mA. The default value is: ``0x500`` (500mA).
157+
Return the current in mA. The default value is: ``0x500`` (500 mA).
158158

159159
usbClass
160160
^^^^^^^^

‎docs/en/api/wifi.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This is the mode to be used if you want to connect your project to the Internet.
4343
API Description
4444
---------------
4545

46-
Here is the description of the WiFi API.
46+
Here is the description of the Wi-Fi API.
4747

4848
Common API
4949
----------
@@ -53,7 +53,7 @@ Here are the common APIs that are used for both modes, AP and STA.
5353
onEvent (and removeEvent)
5454
*************************
5555

56-
Registers a caller-supplied function to be called when WiFi events
56+
Registers a caller-supplied function to be called when Wi-Fi events
5757
occur. Several forms are available.
5858

5959
Function pointer callback taking the event ID:
@@ -92,7 +92,7 @@ A similar set of functions are available to remove callbacks:
9292
9393
In all cases, the subscribing function accepts an optional event type to
9494
invoke the callback only for that specific event; with the default
95-
``ARDUINO_EVENT_MAX``, the callback will be invoked for all WiFi events.
95+
``ARDUINO_EVENT_MAX``, the callback will be invoked for all Wi-Fi events.
9696

9797
Any callback function is given the event type in a parameter.
9898
Some of the possible callback function formats also take an
@@ -141,9 +141,9 @@ may be retrieved:
141141
142142
.. warning::
143143

144-
The ``setHostname()`` function must be called BEFORE WiFi is started with
144+
The ``setHostname()`` function must be called BEFORE Wi-Fi is started with
145145
``WiFi.begin()``, ``WiFi.softAP()``, ``WiFi.mode()``, or ``WiFi.run()``.
146-
To change the name, reset WiFi with ``WiFi.mode(WIFI_MODE_NULL)``,
146+
To change the name, reset Wi-Fi with ``WiFi.mode(WIFI_MODE_NULL)``,
147147
then proceed with ``WiFi.setHostname(...)`` and restart WiFi from scratch.
148148

149149
useStaticBuffers
@@ -619,7 +619,7 @@ WiFiScan
619619

620620
To perform the Wi-Fi scan for networks, you can use the following functions:
621621

622-
Start scan WiFi networks available.
622+
Start scan Wi-Fi networks available.
623623

624624
.. code-block:: arduino
625625
@@ -637,7 +637,7 @@ Delete last scan result from RAM.
637637
638638
void scanDelete();
639639
640-
Loads all infos from a scanned wifi in to the ptr parameters.
640+
Loads all infos from a scanned Wi-Fi in to the ptr parameters.
641641

642642
.. code-block:: arduino
643643
@@ -648,7 +648,7 @@ To see how to use the ``WiFiScan``, take a look at the ``WiFiScan.ino`` or ``WiF
648648
Examples
649649
--------
650650

651-
`Complete list of WiFi examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi/examples>`_.
651+
`Complete list of Wi-Fi examples <https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi/examples>`_.
652652

653653
.. _ap example:
654654

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

+8-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The ESP32-C3-DevKitM-1 development board is one of Espressif's official boards.
77
Specifications
88
--------------
99

10-
- Small­ sized 2.4 GHz Wi­Fi (802.11 b/g/n) and Bluetooth® 5 module
11-
- Built around ESP32­C3 series of SoCs, RISC­V single­core microprocessor
10+
- Small sized 2.4 GHz Wi-Fi (802.11b/g/n) and Bluetooth® 5 module
11+
- Built around ESP32-C3 series of SoCs, RISC-V single-core microprocessor
1212
- 4 MB flash in chip package
1313
- 15 available GPIOs (module)
1414
- Peripherals
@@ -30,7 +30,7 @@ Specifications
3030
- 2 × 54-bit general-purpose timers
3131
- 3 × watchdog timers
3232
- 1 × 52-bit system timer
33-
- On­board PCB antenna or external antenna connector
33+
- PCB antenna or external antenna connector
3434

3535
Header Block
3636
------------
@@ -40,6 +40,9 @@ Header Block
4040

4141
J1
4242
^^^
43+
44+
.. vale off
45+
4346
=== ==== ========== ===================================
4447
No. Name Type [1]_ Function
4548
=== ==== ========== ===================================
@@ -60,6 +63,8 @@ No. Name Type [1]_ Function
6063
15 GND G Ground
6164
=== ==== ========== ===================================
6265

66+
.. vale on
67+
6368
J3
6469
^^^
6570
=== ==== ========== ====================================

0 commit comments

Comments
 (0)