Merge branch 'master' into esp_insights

Author: me-no-dev

.gitignore

@@ -32,6 +32,8 @@ boards.sloeber.txt
 # Ignore docs build (Sphinx)
 docs/build
 docs/source/_build
+__pycache__/
+_build/
 
 # Test log files
 *.log

CMakeLists.txt

@@ -222,9 +222,10 @@ if(NOT CONFIG_FREERTOS_HZ EQUAL 1000 AND NOT "$ENV{ARDUINO_SKIP_TICK_CHECK}")
 endif()
 
 string(TOUPPER ${CONFIG_ARDUINO_VARIANT} idf_target_caps)
+string(REPLACE "-" "_" idf_target_for_macro "${idf_target_caps}")
 target_compile_options(${COMPONENT_TARGET} PUBLIC
     -DARDUINO=10812
-    -DARDUINO_${idf_target_caps}_DEV
+    -DARDUINO_${idf_target_for_macro}_DEV
     -DARDUINO_ARCH_ESP32
     -DARDUINO_BOARD="${idf_target_caps}_DEV"
     -DARDUINO_VARIANT="${CONFIG_ARDUINO_VARIANT}"

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+vojtech.bartoska@espressif.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -56,3 +56,5 @@ Finally, if you are sure no one else had the issue, follow the **Issue template*
 We welcome contributions to the Arduino ESP32 project!
 
 See [contributing](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html) in the documentation for more information on how to contribute to the project.
+
+> We would like to have this repository in a polite and friendly atmosphere, so please be kind and respectful to others. For more details, look at [Code of Conduct](https://github.com/espressif/arduino-esp32/blob/master/CODE_OF_CONDUCT.md).

boards.txt

@@ -2241,6 +2241,9 @@ rmp.vid.0=0x303a
 rmp.pid.0=0x80F6
 
 rmp.upload.tool=esptool_py
+rmp.upload.tool.default=esptool_py
+rmp.upload.tool.network=esp_ota
+
 rmp.upload.maximum_size=1310720
 rmp.upload.maximum_data_size=327680
 rmp.upload.flags=
@@ -10000,6 +10003,9 @@ esp32doit-devkit-v1.menu.EraseFlash.all.upload.erase_cmd=-e
 esp32doit-espduino.name=DOIT ESPduino32
 
 esp32doit-espduino.upload.tool=esptool_py
+esp32doit-espduino.upload.tool.default=esptool_py
+esp32doit-espduino.upload.tool.network=esp_ota
+
 esp32doit-espduino.upload.maximum_size=1310720
 esp32doit-espduino.upload.maximum_data_size=327680
 esp32doit-espduino.upload.wait_for_upload_port=true
@@ -13153,7 +13159,10 @@ oroca_edubot.menu.EraseFlash.all.upload.erase_cmd=-e
 
 fm-devkit.name=ESP32 FM DevKit
 
-fm-devkit.upload.tool=esptool
+fm-devkit.upload.tool=esptool_py
+fm-devkit.upload.tool.default=esptool_py
+fm-devkit.upload.tool.network=esp_ota
+
 fm-devkit.upload.maximum_size=1310720
 fm-devkit.upload.maximum_data_size=327680
 fm-devkit.upload.flags=
@@ -19659,3 +19668,118 @@ redpill_esp32s3.menu.EraseFlash.all=Enabled
 redpill_esp32s3.menu.EraseFlash.all.upload.erase_cmd=-e
 
 ##############################################################
+
+esp32c3m1IKit.name=ESP-C3-M1-I-Kit
+
+esp32c3m1IKit.bootloader.tool=esptool_py
+esp32c3m1IKit.bootloader.tool.default=esptool_py
+
+esp32c3m1IKit.upload.tool=esptool_py
+esp32c3m1IKit.upload.tool.default=esptool_py
+esp32c3m1IKit.upload.tool.network=esp_ota
+
+esp32c3m1IKit.upload.maximum_size=1310720
+esp32c3m1IKit.upload.maximum_data_size=327680
+esp32c3m1IKit.upload.flags=
+esp32c3m1IKit.upload.extra_flags=
+esp32c3m1IKit.upload.use_1200bps_touch=false
+esp32c3m1IKit.upload.wait_for_upload_port=false
+
+esp32c3m1IKit.serial.disableDTR=false
+esp32c3m1IKit.serial.disableRTS=false
+
+esp32c3m1IKit.build.tarch=riscv32
+esp32c3m1IKit.build.target=esp
+esp32c3m1IKit.build.mcu=esp32c3
+esp32c3m1IKit.build.core=esp32
+esp32c3m1IKit.build.variant=esp_c3_m1_i_kit
+esp32c3m1IKit.build.board=ESP32C3_M1_I_KIT
+esp32c3m1IKit.build.bootloader_addr=0x0
+
+esp32c3m1IKit.build.cdc_on_boot=0
+esp32c3m1IKit.build.f_cpu=160000000L
+esp32c3m1IKit.build.flash_size=4MB
+esp32c3m1IKit.build.flash_freq=80m
+esp32c3m1IKit.build.flash_mode=qio
+esp32c3m1IKit.build.boot=qio
+esp32c3m1IKit.build.partitions=default
+esp32c3m1IKit.build.defines=
+
+esp32c3m1IKit.menu.CDCOnBoot.default=Disabled
+esp32c3m1IKit.menu.CDCOnBoot.default.build.cdc_on_boot=0
+esp32c3m1IKit.menu.CDCOnBoot.cdc=Enabled
+esp32c3m1IKit.menu.CDCOnBoot.cdc.build.cdc_on_boot=1
+
+esp32c3m1IKit.menu.PartitionScheme.default=Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.default.build.partitions=default
+esp32c3m1IKit.menu.PartitionScheme.defaultffat=Default 4MB with ffat (1.2MB APP/1.5MB FATFS)
+esp32c3m1IKit.menu.PartitionScheme.defaultffat.build.partitions=default_ffat
+esp32c3m1IKit.menu.PartitionScheme.minimal=Minimal (1.3MB APP/700KB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.minimal.build.partitions=minimal
+esp32c3m1IKit.menu.PartitionScheme.no_ota=No OTA (2MB APP/2MB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.no_ota.build.partitions=no_ota
+esp32c3m1IKit.menu.PartitionScheme.no_ota.upload.maximum_size=2097152
+esp32c3m1IKit.menu.PartitionScheme.noota_3g=No OTA (1MB APP/3MB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.noota_3g.build.partitions=noota_3g
+esp32c3m1IKit.menu.PartitionScheme.noota_3g.upload.maximum_size=1048576
+esp32c3m1IKit.menu.PartitionScheme.noota_ffat=No OTA (2MB APP/2MB FATFS)
+esp32c3m1IKit.menu.PartitionScheme.noota_ffat.build.partitions=noota_ffat
+esp32c3m1IKit.menu.PartitionScheme.noota_ffat.upload.maximum_size=2097152
+esp32c3m1IKit.menu.PartitionScheme.noota_3gffat=No OTA (1MB APP/3MB FATFS)
+esp32c3m1IKit.menu.PartitionScheme.noota_3gffat.build.partitions=noota_3gffat
+esp32c3m1IKit.menu.PartitionScheme.noota_3gffat.upload.maximum_size=1048576
+esp32c3m1IKit.menu.PartitionScheme.huge_app=Huge APP (3MB No OTA/1MB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.huge_app.build.partitions=huge_app
+esp32c3m1IKit.menu.PartitionScheme.huge_app.upload.maximum_size=3145728
+esp32c3m1IKit.menu.PartitionScheme.min_spiffs=Minimal SPIFFS (1.9MB APP with OTA/190KB SPIFFS)
+esp32c3m1IKit.menu.PartitionScheme.min_spiffs.build.partitions=min_spiffs
+esp32c3m1IKit.menu.PartitionScheme.min_spiffs.upload.maximum_size=1966080
+esp32c3m1IKit.menu.PartitionScheme.rainmaker=RainMaker
+esp32c3m1IKit.menu.PartitionScheme.rainmaker.build.partitions=rainmaker
+esp32c3m1IKit.menu.PartitionScheme.rainmaker.upload.maximum_size=3145728
+
+esp32c3m1IKit.menu.CPUFreq.160=160MHz (WiFi)
+esp32c3m1IKit.menu.CPUFreq.160.build.f_cpu=160000000L
+esp32c3m1IKit.menu.CPUFreq.80=80MHz (WiFi)
+esp32c3m1IKit.menu.CPUFreq.80.build.f_cpu=80000000L
+esp32c3m1IKit.menu.CPUFreq.40=40MHz
+esp32c3m1IKit.menu.CPUFreq.40.build.f_cpu=40000000L
+esp32c3m1IKit.menu.CPUFreq.20=20MHz
+esp32c3m1IKit.menu.CPUFreq.20.build.f_cpu=20000000L
+esp32c3m1IKit.menu.CPUFreq.10=10MHz
+esp32c3m1IKit.menu.CPUFreq.10.build.f_cpu=10000000L
+
+esp32c3m1IKit.menu.UploadSpeed.921600=921600
+esp32c3m1IKit.menu.UploadSpeed.921600.upload.speed=921600
+esp32c3m1IKit.menu.UploadSpeed.115200=115200
+esp32c3m1IKit.menu.UploadSpeed.115200.upload.speed=115200
+esp32c3m1IKit.menu.UploadSpeed.256000.windows=256000
+esp32c3m1IKit.menu.UploadSpeed.256000.upload.speed=256000
+esp32c3m1IKit.menu.UploadSpeed.230400.windows.upload.speed=256000
+esp32c3m1IKit.menu.UploadSpeed.230400=230400
+esp32c3m1IKit.menu.UploadSpeed.230400.upload.speed=230400
+esp32c3m1IKit.menu.UploadSpeed.460800.linux=460800
+esp32c3m1IKit.menu.UploadSpeed.460800.macosx=460800
+esp32c3m1IKit.menu.UploadSpeed.460800.upload.speed=460800
+esp32c3m1IKit.menu.UploadSpeed.512000.windows=512000
+esp32c3m1IKit.menu.UploadSpeed.512000.upload.speed=512000
+
+esp32c3m1IKit.menu.DebugLevel.none=None
+esp32c3m1IKit.menu.DebugLevel.none.build.code_debug=0
+esp32c3m1IKit.menu.DebugLevel.error=Error
+esp32c3m1IKit.menu.DebugLevel.error.build.code_debug=1
+esp32c3m1IKit.menu.DebugLevel.warn=Warn
+esp32c3m1IKit.menu.DebugLevel.warn.build.code_debug=2
+esp32c3m1IKit.menu.DebugLevel.info=Info
+esp32c3m1IKit.menu.DebugLevel.info.build.code_debug=3
+esp32c3m1IKit.menu.DebugLevel.debug=Debug
+esp32c3m1IKit.menu.DebugLevel.debug.build.code_debug=4
+esp32c3m1IKit.menu.DebugLevel.verbose=Verbose
+esp32c3m1IKit.menu.DebugLevel.verbose.build.code_debug=5
+
+esp32c3m1IKit.menu.EraseFlash.none=Disabled
+esp32c3m1IKit.menu.EraseFlash.none.upload.erase_cmd=
+esp32c3m1IKit.menu.EraseFlash.all=Enabled
+esp32c3m1IKit.menu.EraseFlash.all.upload.erase_cmd=-e
+
+##############################################################

cores/esp32/HWCDC.cpp

@@ -32,7 +32,11 @@ static uint8_t rx_data_buf[64];
 static intr_handle_t intr_handle = NULL;
 static volatile bool initial_empty = false;
 static xSemaphoreHandle tx_lock = NULL;
-static uint32_t tx_timeout_ms = 200;
+
+// workaround for when USB CDC is not connected
+static uint32_t tx_timeout_ms = 0;
+static bool tx_timeout_change_request = false;
+
 static esp_event_loop_handle_t arduino_hw_cdc_event_loop_handle = NULL;
 
 static esp_err_t arduino_hw_cdc_event_post(esp_event_base_t event_base, int32_t event_id, void *event_data, size_t event_data_size, BaseType_t *task_unblocked){
@@ -72,9 +76,14 @@ static void hw_cdc_isr_handler(void *arg) {
         if (usb_serial_jtag_ll_txfifo_writable() == 1) {
             // We disable the interrupt here so that the interrupt won't be triggered if there is no data to send.
             usb_serial_jtag_ll_disable_intr_mask(USB_SERIAL_JTAG_INTR_SERIAL_IN_EMPTY);
-
             if(!initial_empty){
                 initial_empty = true;
+                // First time USB is plugged and the application has not explicitly set TX Timeout, set it to default 100ms.
+                // Otherwise, USB is still unplugged and the timeout will be kept as Zero in order to avoid any delay in the
+                // application whenever it uses write() and the TX Queue gets full.
+                if (!tx_timeout_change_request) {
+                    tx_timeout_ms = 100;
+                }
                 //send event?
                 //ets_printf("CONNECTED\n");
                 arduino_hw_cdc_event_post(ARDUINO_HW_CDC_EVENTS, ARDUINO_HW_CDC_CONNECTED_EVENT, &event, sizeof(arduino_hw_cdc_event_data_t), &xTaskWoken);
@@ -197,6 +206,9 @@ void HWCDC::end()
 
 void HWCDC::setTxTimeoutMs(uint32_t timeout){
     tx_timeout_ms = timeout;
+    // it registers that the user has explicitly requested to use a value as TX timeout
+    // used for the workaround with unplugged USB and TX Queue Full that causes a delay on every write()
+    tx_timeout_change_request = true;
 }
 
 /*

cores/esp32/HardwareSerial.cpp

@@ -450,10 +450,12 @@ int HardwareSerial::peek(void)
 
 int HardwareSerial::read(void)
 {
-    if(available()) {
-        return uartRead(_uart);
+    uint8_t c = 0;
+    if (uartReadBytes(_uart, &c, 1, 0) == 1) {
+        return c;
+    } else {
+        return -1;
     }
-    return -1;
 }
 
 // read characters into buffer
@@ -462,16 +464,13 @@ int HardwareSerial::read(void)
 // the buffer is NOT null terminated.
 size_t HardwareSerial::read(uint8_t *buffer, size_t size)
 {
-    size_t avail = available();
-    if (size < avail) {
-        avail = size;
-    }
-    size_t count = 0;
-    while(count < avail) {
-        *buffer++ = uartRead(_uart);
-        count++;
-    }
-    return count;
+    return uartReadBytes(_uart, buffer, size, 0);
+}
+
+// Overrides Stream::readBytes() to be faster using IDF
+size_t HardwareSerial::readBytes(uint8_t *buffer, size_t length)
+{
+    return uartReadBytes(_uart, buffer, length, (uint32_t)getTimeout());
 }
 
 void HardwareSerial::flush(void)

cores/esp32/HardwareSerial.h

@@ -118,6 +118,12 @@ class HardwareSerial: public Stream
     {
         return read((uint8_t*) buffer, size);
     }
+    // Overrides Stream::readBytes() to be faster using IDF
+    size_t readBytes(uint8_t *buffer, size_t length);
+    size_t readBytes(char *buffer, size_t length)
+    {
+        return readBytes((uint8_t *) buffer, length);
+    }    
     void flush(void);
     void flush( bool txOnly);
     size_t write(uint8_t);