Refactor repository with pre-commit hooks (espressif#9515)

* Add Config

* Add Cache and remove pre-commit action

* [pre-commit.ci lite] apply automatic fixes

* Remove freeze

* Fix

* Update action

* Use latest stable Python 3 version

* Improve caching

* Improve cache tag

* Improve bot message

* fix(typos): Fix typos

* fix(typos): Fix more typos

* refactor(udp_server): Convert script from Python 2 to 3

* Fix whitespace

* Clang-format fixes

* Prettier fixes

* Black formatting

* Manual fixes

* Line endings

* Fix flake and make Vale manual

* Fix flake and reformat

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: Rodrigo Garcia <[email protected]>

Author: 3 people

CMakeLists.txt

@@ -129,16 +129,16 @@ set(ARDUINO_LIBRARY_EEPROM_SRCS libraries/EEPROM/src/EEPROM.cpp)
 
 set(ARDUINO_LIBRARY_ESP_I2S_SRCS libraries/ESP_I2S/src/ESP_I2S.cpp)
 
-set(ARDUINO_LIBRARY_ESP_NOW_SRCS 
+set(ARDUINO_LIBRARY_ESP_NOW_SRCS
   libraries/ESP_NOW/src/ESP32_NOW.cpp
   libraries/ESP_NOW/src/ESP32_NOW_Serial.cpp)
-  
-set(ARDUINO_LIBRARY_ESP_SR_SRCS 
+
+set(ARDUINO_LIBRARY_ESP_SR_SRCS
   libraries/ESP_SR/src/ESP_SR.cpp
   libraries/ESP_SR/src/esp32-hal-sr.c)
- 
+
 set(ARDUINO_LIBRARY_ESPmDNS_SRCS libraries/ESPmDNS/src/ESPmDNS.cpp)
- 
+
 set(ARDUINO_LIBRARY_Ethernet_SRCS libraries/Ethernet/src/ETH.cpp)
 
 set(ARDUINO_LIBRARY_FFat_SRCS libraries/FFat/src/FFat.cpp)
@@ -187,7 +187,7 @@ set(ARDUINO_LIBRARY_Ticker_SRCS libraries/Ticker/src/Ticker.cpp)
 set(ARDUINO_LIBRARY_Update_SRCS
   libraries/Update/src/Updater.cpp
   libraries/Update/src/HttpsOTAUpdate.cpp)
-  
+
 set(ARDUINO_LIBRARY_USB_SRCS
   libraries/USB/src/USBHID.cpp
   libraries/USB/src/USBMIDI.cpp

Kconfig.projbuild

@@ -209,7 +209,7 @@ config ARDUHAL_ESP_LOG
     default "n"
     help
         This option will redefine the ESP_LOGx macros to Arduino's log_x macros.
-        To enable for your application, add the follwing after your includes:
+        To enable for your application, add the following after your includes:
         #ifdef ARDUINO_ARCH_ESP32
         #include "esp32-hal-log.h"
         #endif
@@ -390,4 +390,3 @@ config ARDUINO_SELECTIVE_SimpleBLE
     default y
 
 endmenu
-

LICENSE.md

@@ -4,7 +4,7 @@ Version 2.1, February 1999
 
     Copyright (C) 1991, 1999 Free Software Foundation, Inc.
     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-    
+
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.
 
@@ -500,4 +500,4 @@ if necessary. Here is a sample; alter the names:
     signature of Ty Coon, 1 April 1990
     Ty Coon, President of Vice
 
-That's all there is to it!
+That's all there is to it!

README.md

@@ -68,7 +68,7 @@ You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecod
 
 ### Issue/Bug report template
 
-Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+).
+Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labeled as [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+).
 
 Finally, if you are sure no one else had the issue, follow the **Issue template** or **Feature request template** while reporting any [new Issue](https://github.com/espressif/arduino-esp32/issues/new/choose).
 

boards.txt

@@ -16309,7 +16309,7 @@ esp32s3-devkitlipo.menu.EraseFlash.none=Disabled
 esp32s3-devkitlipo.menu.EraseFlash.none.upload.erase_cmd=
 esp32s3-devkitlipo.menu.EraseFlash.all=Enabled
 esp32s3-devkitlipo.menu.EraseFlash.all.upload.erase_cmd=-e
-     
+
 ##############################################################
 
 esp32c3-devkitlipo.name=OLIMEX ESP32-C3-DevKit-Lipo
@@ -22487,7 +22487,7 @@ heltec_capsule_sensor_V3.menu.LORAWAN_PREAMBLE_LENGTH.1.build.LORAWAN_PREAMBLE_L
 
 heltec_capsule_sensor_V3.menu.SLOW_CLK_TPYE.0=External 32K (default)
 heltec_capsule_sensor_V3.menu.SLOW_CLK_TPYE.0.build.SLOW_CLK_TPYE=1
-heltec_capsule_sensor_V3.menu.SLOW_CLK_TPYE.1=Internal 
+heltec_capsule_sensor_V3.menu.SLOW_CLK_TPYE.1=Internal
 heltec_capsule_sensor_V3.menu.SLOW_CLK_TPYE.1.build.SLOW_CLK_TPYE=0
 
 heltec_capsule_sensor_V3.menu.NetworkLogLevel.0=NONE
@@ -22499,7 +22499,7 @@ heltec_capsule_sensor_V3.menu.NetworkLogLevel.2.build.NetworkLogLevel=2
 heltec_capsule_sensor_V3.menu.NetworkLogLevel.3=INFO
 heltec_capsule_sensor_V3.menu.NetworkLogLevel.3.build.NetworkLogLevel=3
 
-heltec_capsule_sensor_V3.build.defines=-D{build.band} -DMCU_ESP32_S3 -DHELTEC_BOARD=50 -DCAPSULE_SENSOR_V3 -DSLOW_CLK_TPYE={build.SLOW_CLK_TPYE} -DRADIO_CHIP_SX1262  -DLoRaWAN_DEBUG_LEVEL={build.LoRaWanDebugLevel} -DACTIVE_REGION=LORAMAC_{build.band} -DLORAWAN_PREAMBLE_LENGTH={build.LORAWAN_PREAMBLE_LENGTH} -DLORAWAN_DEVEUI_AUTO={build.LORAWAN_DEVEUI_AUTO} -D{build.board} -DNLOG_LOCAL_LEVEL={build.NetworkLogLevel} 
+heltec_capsule_sensor_V3.build.defines=-D{build.band} -DMCU_ESP32_S3 -DHELTEC_BOARD=50 -DCAPSULE_SENSOR_V3 -DSLOW_CLK_TPYE={build.SLOW_CLK_TPYE} -DRADIO_CHIP_SX1262  -DLoRaWAN_DEBUG_LEVEL={build.LoRaWanDebugLevel} -DACTIVE_REGION=LORAMAC_{build.band} -DLORAWAN_PREAMBLE_LENGTH={build.LORAWAN_PREAMBLE_LENGTH} -DLORAWAN_DEVEUI_AUTO={build.LORAWAN_DEVEUI_AUTO} -D{build.board} -DNLOG_LOCAL_LEVEL={build.NetworkLogLevel}
 
 heltec_capsule_sensor_V3.menu.EraseFlash.none=Disabled
 heltec_capsule_sensor_V3.menu.EraseFlash.none.upload.erase_cmd=

cores/esp32/Arduino.h

@@ -48,19 +48,19 @@
 #define RAD_TO_DEG 57.295779513082320876798154814105
 #define EULER 2.718281828459045235360287471352
 
-#define SERIAL  0x0
+#define SERIAL 0x0
 #define DISPLAY 0x1
 
 #define LSBFIRST 0
 #define MSBFIRST 1
 
 //Interrupt Modes
-#define RISING    0x01
-#define FALLING   0x02
-#define CHANGE    0x03
-#define ONLOW     0x04
-#define ONHIGH    0x05
-#define ONLOW_WE  0x0C
+#define RISING 0x01
+#define FALLING 0x02
+#define CHANGE 0x03
+#define ONLOW 0x04
+#define ONHIGH 0x05
+#define ONLOW_WE 0x0C
 #define ONHIGH_WE 0x0D
 
 #define DEFAULT 1
@@ -71,27 +71,27 @@
 #endif
 
 // can't define max() / min() because of conflicts with C++
-#define _min(a,b) ((a)<(b)?(a):(b))  
-#define _max(a,b) ((a)>(b)?(a):(b))
-#define _abs(x) ((x)>0?(x):-(x))  // abs() comes from STL
-#define constrain(amt,low,high) ((amt)<(low)?(low):((amt)>(high)?(high):(amt)))
-#define _round(x)     ((x)>=0?(long)((x)+0.5):(long)((x)-0.5))  // round() comes from STL
+#define _min(a, b) ((a) < (b) ? (a) : (b))
+#define _max(a, b) ((a) > (b) ? (a) : (b))
+#define _abs(x) ((x) > 0 ? (x) : -(x))  // abs() comes from STL
+#define constrain(amt, low, high) ((amt) < (low) ? (low) : ((amt) > (high) ? (high) : (amt)))
+#define _round(x) ((x) >= 0 ? (long)((x) + 0.5) : (long)((x)-0.5))  // round() comes from STL
 #define radians(deg) ((deg)*DEG_TO_RAD)
 #define degrees(rad) ((rad)*RAD_TO_DEG)
-#define sq(x) ((x)*(x))
+#define sq(x) ((x) * (x))
 
 // ESP32xx runs FreeRTOS... disabling interrupts can lead to issues, such as Watchdog Timeout
 #define sei() portENABLE_INTERRUPTS()
 #define cli() portDISABLE_INTERRUPTS()
 #define interrupts() sei()
 #define noInterrupts() cli()
 
-#define clockCyclesPerMicrosecond() ( (long int)getCpuFrequencyMhz() )
-#define clockCyclesToMicroseconds(a) ( (a) / clockCyclesPerMicrosecond() )
-#define microsecondsToClockCycles(a) ( (a) * clockCyclesPerMicrosecond() )
+#define clockCyclesPerMicrosecond() ((long int)getCpuFrequencyMhz())
+#define clockCyclesToMicroseconds(a) ((a) / clockCyclesPerMicrosecond())
+#define microsecondsToClockCycles(a) ((a)*clockCyclesPerMicrosecond())
 
-#define lowByte(w) ((uint8_t) ((w) & 0xff))
-#define highByte(w) ((uint8_t) ((w) >> 8))
+#define lowByte(w) ((uint8_t)((w)&0xff))
+#define highByte(w) ((uint8_t)((w) >> 8))
 
 #define bitRead(value, bit) (((value) >> (bit)) & 0x01)
 #define bitSet(value, bit) ((value) |= (1UL << (bit)))
@@ -101,26 +101,27 @@
 
 // avr-libc defines _NOP() since 1.6.2
 #ifndef _NOP
-#define _NOP() do { __asm__ volatile ("nop"); } while (0)
+#define _NOP() \
+  do { __asm__ volatile("nop"); } while (0)
 #endif
 
 #define bit(b) (1UL << (b))
 #define _BV(b) (1UL << (b))
 
-#define digitalPinToTimer(pin)      (0)
-#define analogInPinToBit(P)         (P)
+#define digitalPinToTimer(pin) (0)
+#define analogInPinToBit(P) (P)
 #if SOC_GPIO_PIN_COUNT <= 32
-#define digitalPinToPort(pin)       (0)
-#define digitalPinToBitMask(pin)    (1UL << digitalPinToGPIONumber(pin))
-#define portOutputRegister(port)    ((volatile uint32_t*)GPIO_OUT_REG)
-#define portInputRegister(port)     ((volatile uint32_t*)GPIO_IN_REG)
-#define portModeRegister(port)      ((volatile uint32_t*)GPIO_ENABLE_REG)
+#define digitalPinToPort(pin) (0)
+#define digitalPinToBitMask(pin) (1UL << digitalPinToGPIONumber(pin))
+#define portOutputRegister(port) ((volatile uint32_t*)GPIO_OUT_REG)
+#define portInputRegister(port) ((volatile uint32_t*)GPIO_IN_REG)
+#define portModeRegister(port) ((volatile uint32_t*)GPIO_ENABLE_REG)
 #elif SOC_GPIO_PIN_COUNT <= 64
-#define digitalPinToPort(pin)       ((digitalPinToGPIONumber(pin)>31)?1:0)
-#define digitalPinToBitMask(pin)    (1UL << (digitalPinToGPIONumber(pin)&31))
-#define portOutputRegister(port)    ((volatile uint32_t*)((port)?GPIO_OUT1_REG:GPIO_OUT_REG))
-#define portInputRegister(port)     ((volatile uint32_t*)((port)?GPIO_IN1_REG:GPIO_IN_REG))
-#define portModeRegister(port)      ((volatile uint32_t*)((port)?GPIO_ENABLE1_REG:GPIO_ENABLE_REG))
+#define digitalPinToPort(pin) ((digitalPinToGPIONumber(pin) > 31) ? 1 : 0)
+#define digitalPinToBitMask(pin) (1UL << (digitalPinToGPIONumber(pin) & 31))
+#define portOutputRegister(port) ((volatile uint32_t*)((port) ? GPIO_OUT1_REG : GPIO_OUT_REG))
+#define portInputRegister(port) ((volatile uint32_t*)((port) ? GPIO_IN1_REG : GPIO_IN_REG))
+#define portModeRegister(port) ((volatile uint32_t*)((port) ? GPIO_ENABLE1_REG : GPIO_ENABLE_REG))
 #else
 #error SOC_GPIO_PIN_COUNT > 64 not implemented
 #endif
@@ -131,16 +132,16 @@
 #define NOT_ON_TIMER 0
 
 // some defines generic for all SoC moved from variants/board_name/pins_arduino.h
-#define NUM_DIGITAL_PINS        SOC_GPIO_PIN_COUNT                                // All GPIOs
+#define NUM_DIGITAL_PINS SOC_GPIO_PIN_COUNT  // All GPIOs
 #if SOC_ADC_PERIPH_NUM == 1
-#define NUM_ANALOG_INPUTS       (SOC_ADC_CHANNEL_NUM(0))                          // Depends on the SoC (ESP32C6, ESP32H2, ESP32C2, ESP32P4)
+#define NUM_ANALOG_INPUTS (SOC_ADC_CHANNEL_NUM(0))  // Depends on the SoC (ESP32C6, ESP32H2, ESP32C2, ESP32P4)
 #elif SOC_ADC_PERIPH_NUM == 2
-#define NUM_ANALOG_INPUTS       (SOC_ADC_CHANNEL_NUM(0)+SOC_ADC_CHANNEL_NUM(1))   // Depends on the SoC (ESP32, ESP32S2, ESP32S3, ESP32C3)
+#define NUM_ANALOG_INPUTS (SOC_ADC_CHANNEL_NUM(0) + SOC_ADC_CHANNEL_NUM(1))  // Depends on the SoC (ESP32, ESP32S2, ESP32S3, ESP32C3)
 #endif
-#define EXTERNAL_NUM_INTERRUPTS NUM_DIGITAL_PINS                                  // All GPIOs
-#define analogInputToDigitalPin(p)  (((p)<NUM_ANALOG_INPUTS)?(analogChannelToDigitalPin(p)):-1)
-#define digitalPinToInterrupt(p)    ((((uint8_t)digitalPinToGPIONumber(p))<NUM_DIGITAL_PINS)?digitalPinToGPIONumber(p):NOT_AN_INTERRUPT)
-#define digitalPinHasPWM(p)         (((uint8_t)digitalPinToGPIONumber(p))<NUM_DIGITAL_PINS)
+#define EXTERNAL_NUM_INTERRUPTS NUM_DIGITAL_PINS  // All GPIOs
+#define analogInputToDigitalPin(p) (((p) < NUM_ANALOG_INPUTS) ? (analogChannelToDigitalPin(p)) : -1)
+#define digitalPinToInterrupt(p) ((((uint8_t)digitalPinToGPIONumber(p)) < NUM_DIGITAL_PINS) ? digitalPinToGPIONumber(p) : NOT_AN_INTERRUPT)
+#define digitalPinHasPWM(p) (((uint8_t)digitalPinToGPIONumber(p)) < NUM_DIGITAL_PINS)
 
 typedef bool boolean;
 typedef uint8_t byte;
@@ -150,7 +151,7 @@ typedef unsigned int word;
 void setup(void);
 void loop(void);
 
-// The default is using Real Hardware random number generator  
+// The default is using Real Hardware random number generator
 // But when randomSeed() is called, it turns to Psedo random
 // generator, exactly as done in Arduino mainstream
 long random(long);
@@ -169,15 +170,15 @@ long map(long, long, long, long, long);
 extern "C" {
 #endif
 
-void init(void);
-void initVariant(void);
-void initArduino(void);
+  void init(void);
+  void initVariant(void);
+  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);
+  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);
-void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
+  uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
+  void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
 
 #ifdef __cplusplus
 }
@@ -211,23 +212,29 @@ uint16_t makeWord(uint8_t h, uint8_t l);
 #define word(...) makeWord(__VA_ARGS__)
 
 size_t getArduinoLoopTaskStackSize(void);
-#define SET_LOOP_TASK_STACK_SIZE(sz) size_t getArduinoLoopTaskStackSize() { return sz;}
+#define SET_LOOP_TASK_STACK_SIZE(sz) \
+  size_t getArduinoLoopTaskStackSize() { return sz; }
 
 bool shouldPrintChipDebugReport(void);
-#define ENABLE_CHIP_DEBUG_REPORT bool shouldPrintChipDebugReport(void){return true;}
+#define ENABLE_CHIP_DEBUG_REPORT \
+  bool shouldPrintChipDebugReport(void) { return true; }
 
 // allows user to bypass esp_spiram_test()
 bool esp_psram_extram_test(void);
-#define BYPASS_SPIRAM_TEST(bypass) bool testSPIRAM(void) { if (bypass) return true; else return esp_psram_extram_test(); }
+#define BYPASS_SPIRAM_TEST(bypass) \
+  bool testSPIRAM(void) { \
+    if (bypass) return true; \
+    else return esp_psram_extram_test(); \
+  }
 
 unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);
 unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);
 
-extern "C" bool getLocalTime(struct tm * info, uint32_t ms = 5000);
+extern "C" bool getLocalTime(struct tm* info, uint32_t ms = 5000);
 extern "C" void configTime(long gmtOffset_sec, int daylightOffset_sec,
-        const char* server1, const char* server2 = nullptr, const char* server3 = nullptr);
+                           const char* server1, const char* server2 = nullptr, const char* server3 = nullptr);
 extern "C" void configTzTime(const char* tz,
-        const char* server1, const char* server2 = nullptr, const char* server3 = nullptr);
+                             const char* server1, const char* server2 = nullptr, const char* server3 = nullptr);
 
 void setToneChannel(uint8_t channel = 0);
 void tone(uint8_t _pin, unsigned int frequency, unsigned long duration = 0);

cores/esp32/Client.h

@@ -23,26 +23,24 @@
 #include "Stream.h"
 #include "IPAddress.h"
 
-class Client: public Stream
-{
+class Client : public Stream {
 public:
-    virtual int connect(IPAddress ip, uint16_t port) =0;
-    virtual int connect(const char *host, uint16_t port) =0;
-    virtual size_t write(uint8_t) =0;
-    virtual size_t write(const uint8_t *buf, size_t size) =0;
-    virtual int available() = 0;
-    virtual int read() = 0;
-    virtual int read(uint8_t *buf, size_t size) = 0;
-    virtual int peek() = 0;
-    virtual void flush() = 0;
-    virtual void stop() = 0;
-    virtual uint8_t connected() = 0;
-    virtual operator bool() = 0;
+  virtual int connect(IPAddress ip, uint16_t port) = 0;
+  virtual int connect(const char *host, uint16_t port) = 0;
+  virtual size_t write(uint8_t) = 0;
+  virtual size_t write(const uint8_t *buf, size_t size) = 0;
+  virtual int available() = 0;
+  virtual int read() = 0;
+  virtual int read(uint8_t *buf, size_t size) = 0;
+  virtual int peek() = 0;
+  virtual void flush() = 0;
+  virtual void stop() = 0;
+  virtual uint8_t connected() = 0;
+  virtual operator bool() = 0;
 protected:
-    uint8_t* rawIPAddress(IPAddress& addr)
-    {
-        return addr.raw_address();
-    }
+  uint8_t *rawIPAddress(IPAddress &addr) {
+    return addr.raw_address();
+  }
 };
 
 #endif