Skip to content

feat(core): Add wait time before setup #11367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

feat(core): Add wait time before setup #11367

wants to merge 11 commits into from
+31 −0

Conversation

tanakamasayuki
Copy link
Contributor

Description of Change

Added initialization time for UART, etc.
Default value is 0.

Tests scenarios

Arduino-esp32 core v3.2.0 with M5STACK_STICKC_PLUS2 Board

now or default

void setup() {
}

void loop() {
}

output

------------------------------
  Total Size        :   378124 B ( 369.3 KB)
  Free Bytes        :   336868 B ( 329.0 KB)
  Allocated Bytes   :    33972 B (  33.2 KB)
  Minimum Free Bytes:   330908 B ( 323.2 KB)
  Largest Free Block:   110580 B ( 108.0 KB)
------------------------------------------
SPIRAM Memory Info:
------------------------------------------
  Total Size        :  2097152 B (2048.0 KB)
  Free Bytes        :  2095104 B (2046.0 KB)
  Allocated Bytes   :        0 B (   0.0 KB)
  Minimum Free Bytes:  2095104 B (2046.0 KB)
  Largest Free Block:  2064372 B (2016.0 KB)
------------------------------------------
GPIO Info:
------------------------------------------
  GPIO : BUS_TYPE[bus/unit][chan]
  --------------------------------------  
     1 : UART_TX[0]
     3 : UART_RX[0]
============ After Setup End =============

Output is cut off because UART is not yet initialized.

set wait

uint64_t getArduinoSetupWaitTick(void) {
  return 1000;
}

void setup() {
}

void loop() {
}

output

=========== Before Setup Start ===========
Chip Info:
------------------------------------------
  Model             : ESP32
  Package           : PICO-V3-02
  Revision          : 3.00
  Cores             : 2
  CPU Frequency     : 240 MHz
  XTAL Frequency    : 40 MHz
  Features Bitfield : 0x000000b3
  Embedded Flash    : Yes
  Embedded PSRAM    : Yes
  2.4GHz WiFi       : Yes
  Classic BT        : Yes
  BT Low Energy     : Yes
  IEEE 802.15.4     : No
------------------------------------------
INTERNAL Memory Info:
------------------------------------------
  Total Size        :   378124 B ( 369.3 KB)
  Free Bytes        :   336956 B ( 329.1 KB)
  Allocated Bytes   :    33916 B (  33.1 KB)
  Minimum Free Bytes:   331256 B ( 323.5 KB)
  Largest Free Block:   110580 B ( 108.0 KB)
------------------------------------------
SPIRAM Memory Info:
------------------------------------------
  Total Size        :  2097152 B (2048.0 KB)
  Free Bytes        :  2095104 B (2046.0 KB)
  Allocated Bytes   :        0 B (   0.0 KB)
  Minimum Free Bytes:  2095104 B (2046.0 KB)
  Largest Free Block:  2064372 B (2016.0 KB)
  Bus Mode          : QSPI
------------------------------------------
Flash Info:
------------------------------------------
  Chip Size         :  8388608 B (8 MB)
  Block Size        :    65536 B (  64.0 KB)
  Sector Size       :     4096 B (   4.0 KB)
  Page Size         :      256 B (   0.2 KB)
  Bus Speed         : 80 MHz
  Bus Mode          : QIO
------------------------------------------
Partitions Info:
------------------------------------------
                nvs : addr: 0x00009000, size:    20.0 KB, type: DATA, subtype: NVS
            otadata : addr: 0x0000E000, size:     8.0 KB, type: DATA, subtype: OTA
               app0 : addr: 0x00010000, size:  3264.0 KB, type:  APP, subtype: OTA_0
               app1 : addr: 0x00340000, size:  3264.0 KB, type:  APP, subtype: OTA_1
             spiffs : addr: 0x00670000, size:  1536.0 KB, type: DATA, subtype: SPIFFS
           coredump : addr: 0x007F0000, size:    64.0 KB, type: DATA, subtype: COREDUMP
------------------------------------------
Software Info:
------------------------------------------
  Compile Date/Time : May 15 2025 12:17:22
  Compile Host OS   : windows
  ESP-IDF Version   : v5.4.1-1-g2f7dcd862a-dirty
  Arduino Version   : 3.2.0
------------------------------------------
Board Info:
------------------------------------------
  Arduino Board     : M5STACK_STICKC_PLUS2
  Arduino Variant   : m5stack_stickc_plus2
  Arduino FQBN      : esp32:esp32:m5stack_stickc_plus2:UploadSpeed=1500000,CPUFreq=240,FlashFreq=80,FlashMode=qio,FlashSize=8M,PartitionScheme=default_8MB,DebugLevel=verbose,PSRAM=enabled,LoopCore=1,EventsCore=1,EraseFlash=none
============ Before Setup End ============
=========== After Setup Start ============
INTERNAL Memory Info:
------------------------------------------
  Total Size        :   378124 B ( 369.3 KB)
  Free Bytes        :   336868 B ( 329.0 KB)
  Allocated Bytes   :    33972 B (  33.2 KB)
  Minimum Free Bytes:   330908 B ( 323.2 KB)
  Largest Free Block:   110580 B ( 108.0 KB)
------------------------------------------
SPIRAM Memory Info:
------------------------------------------
  Total Size        :  2097152 B (2048.0 KB)
  Free Bytes        :  2095104 B (2046.0 KB)
  Allocated Bytes   :        0 B (   0.0 KB)
  Minimum Free Bytes:  2095104 B (2046.0 KB)
  Largest Free Block:  2064372 B (2016.0 KB)
------------------------------------------
GPIO Info:
------------------------------------------
  GPIO : BUS_TYPE[bus/unit][chan]
  --------------------------------------  
     1 : UART_TX[0]
     3 : UART_RX[0]
============ After Setup End =============

All output.

@tanakamasayuki
feat(core): Add wait time before setup
3a3853c 
Added initialization time for UART, etc.
Default value is 0.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 15, 2025 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update Arduino.h":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update Arduino.h":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello tanakamasayuki, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.
🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.
Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 6638ed6

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 15, 2025 •
edited
Loading

Test Results

 76 files   76 suites   12m 48s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 6638ed6.

♻️ This comment has been updated with latest results.

Copilot

This comment was marked as outdated.

Sign in to view

@tanakamasayuki
Update Arduino.h
eaec282 
Add function definition and SET_SETUP_WAIT_TICH function
lucasssvaz
lucasssvaz reviewed May 15, 2025
View reviewed changes
@Jason2866
Copy link
Collaborator

Please do not add weak defines. There are two open issues where weak defines generate weird issues.

@tanakamasayuki
Copy link
Contributor Author

Thank you for your reply.

[memo]
I tried build_opt.h, but even if I changed it, main.cpp wouldn't be recompiled, so it didn't seem to work.

projects/build_opt.h

-DARDUINO_SETUP_WAIT_TIME=1000

main.cpp

#if defined(ARDUINO_SETUP_WAIT_TIME)
  // set the delay time before running setup in build_opt.h
  vTaskDelay(ARDUINO_SETUP_WAIT_TIME);
#endif

Restarting the Arduino IDE did not recompile main.cpp.
There is no make clean.

@me-no-dev
Copy link
Member

Rename to SET_SETUP_WAIT_MS(ms) and use delay(ms) instead.

@me-no-dev
Copy link
Member

Please do not add weak defines. There are two open issues where weak defines generate weird issues.

Reasons there were/are different.

@SuGlider
Copy link
Collaborator

SuGlider commented Jun 21, 2025 •
edited
Loading

This new feature could follow the same implementation as ARDUINO_LOOP_STACK_SIZE with the Macro SET_LOOP_TASK_STACK_SIZE(sz) - let me change it. Already done in this way.

SuGlider
SuGlider reviewed Jun 21, 2025
View reviewed changes
SuGlider
SuGlider reviewed Jun 21, 2025
View reviewed changes
SuGlider
SuGlider reviewed Jun 21, 2025
View reviewed changes
@SuGlider SuGlider requested a review from a team as a code owner June 21, 2025 21:39
@SuGlider SuGlider requested a review from Copilot June 21, 2025 21:40
Copilot

This comment was marked as outdated.

Sign in to view

SuGlider and others added 2 commits June 21, 2025 18:49
@SuGlider @Copilot
feat(arduino): changing it to use time in ms
1f7d449 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider @Copilot
fix(arduino): spacing and commentary error
e800462 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider SuGlider requested a review from Copilot June 21, 2025 21:50
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Jun 21, 2025
@SuGlider SuGlider moved this from Todo to In Review in Arduino ESP32 Core Project Roadmap Jun 21, 2025
@SuGlider SuGlider added this to the 3.2.1 milestone Jun 21, 2025
Copilot

This comment was marked as outdated.

Sign in to view

SuGlider
SuGlider approved these changes Jun 21, 2025
View reviewed changes
Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SuGlider @Copilot
fix(arduino): spacing and commentary error
6638ed6 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider SuGlider requested a review from Copilot June 21, 2025 21:52
Copilot
Copilot AI reviewed Jun 21, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new feature to allow a configurable wait time before sketch execution, giving users time to open the Serial Monitor and catch the initialization messages.

  • Adds a macro and function (getArduinoSetupWaitTime_ms) to enable a configurable delay before setup().
  • Updates the main loop task to use the new wait time.
  • Provides an example sketch to demonstrate the feature.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
libraries/ESP32/examples/ArduinoWaitTimeBeforeStartingSketch/ArduinoWaitTimeBeforeStartingSketch.ino Demonstrates use of the wait time macro with a 5-second delay before starting.
cores/esp32/main.cpp Updates loopTask to delay execution using getArduinoSetupWaitTime_ms.
cores/esp32/Arduino.h Adds the macro SET_TIME_BEFORE_STARTING_SKETCH_MS and declares getArduinoSetupWaitTime_ms.
Comments suppressed due to low confidence (1)

cores/esp32/Arduino.h:234

  • Consider marking the function definition inside the macro as 'inline' (or 'static inline') to avoid potential multiple definition issues when included in multiple source files.
#define SET_TIME_BEFORE_STARTING_SKETCH_MS(time_ms)      \

@SuGlider
Copy link
Collaborator

@tanakamasayuki - thank you for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasssvaz lucasssvaz lucasssvaz left review comments

@SuGlider SuGlider SuGlider approved these changes

Copilot code review Copilot Copilot left review comments

@me-no-dev me-no-dev Awaiting requested review from me-no-dev

@P-R-O-C-H-Y P-R-O-C-H-Y Awaiting requested review from P-R-O-C-H-Y

Assignees

@SuGlider SuGlider

Labels
Peripheral: UART Status: Review needed Issue or PR is awaiting review
Projects
Arduino ESP32 Core Project Roadmap
Status: In Review
Milestone
3.2.1
Development

Successfully merging this pull request may close these issues.
5 participants
@tanakamasayuki @Jason2866 @me-no-dev @SuGlider @lucasssvaz
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy