Skip to content

Conversation

@DedeHai
Copy link
Collaborator

@DedeHai DedeHai commented Feb 15, 2025

this fixes the AP not initializing on some hardware due to incorrect timing.
Adding this short delay fixes it on tested C3 devices. I did not find any documentation stating how much delay is required.

@blazoncek is there any downside to adding this delay for all devices? The delay is not the cleanest solution, it would be better to check the state of the wifi hardware but I have no idea what to check.

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced WiFi connection reliability with a brief delay during the initialization process to ensure optimal hardware readiness.

@DedeHai DedeHai added this to the 0.15.1 candidate milestone Feb 15, 2025
@DedeHai DedeHai requested a review from blazoncek February 15, 2025 09:47
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 15, 2025

Walkthrough

The modification in this change introduces a 5-millisecond delay in the WLED::initConnection() method of the wled00/wled.cpp file immediately after the call to WiFi.disconnect(true). This delay is intended to allow the hardware sufficient time to stabilize before proceeding with additional WiFi configuration steps. No changes were made to any exported or public entities.

Changes

File Change Summary
wled00/wled.cpp Modified WLED::initConnection() by adding a 5ms delay after WiFi.disconnect(true) to allow hardware stabilization before further setup.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
wled00/wled.cpp (1)

763-763: LGTM! Consider adding a comment explaining the delay's purpose.

The 5ms delay is a reasonable fix for WiFi hardware initialization issues on C3 devices. While not the most elegant solution, it's a pragmatic approach given the lack of documentation on exact timing requirements.

Consider adding a comment explaining the delay's purpose:

  WiFi.disconnect(true); // close old connections
- delay(5);              // wait for hardware to be ready
+ delay(5);              // wait for WiFi hardware to stabilize (fixes AP initialization on C3 devices)

Future improvements could include:

  1. Making the delay configurable per device type
  2. Investigating hardware status registers to implement a proper wait-until-ready check
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a0c55c6 and b34d65f.

📒 Files selected for processing (1)
  • wled00/wled.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: wled_build / Build Enviornments (esp32_wrover)
  • GitHub Check: wled_build / Build Enviornments (esp32s3_4M_qspi)
  • GitHub Check: wled_build / Build Enviornments (esp32s3dev_8MB_opi)
  • GitHub Check: wled_build / Build Enviornments (esp32s3dev_16MB_opi)
  • GitHub Check: wled_build / Build Enviornments (esp32c3dev)
  • GitHub Check: wled_build / Build Enviornments (lolin_s2_mini)
  • GitHub Check: wled_build / Build Enviornments (esp32_eth)
  • GitHub Check: wled_build / Build Enviornments (esp32dev_V4)
  • GitHub Check: wled_build / Build Enviornments (esp32dev)
  • GitHub Check: wled_build / Build Enviornments (esp8266_2m_compat)
  • GitHub Check: wled_build / Build Enviornments (nodemcuv2_compat)
  • GitHub Check: wled_build / Build Enviornments (nodemcuv2)

@blazoncek
Copy link
Collaborator

initConnection() is called from within loop() context so loop processing will be postponed by 5ms. That may not be noticeable unless you are using very fast FPS.
Additionally, initConnection() is only called when attempting to start connecting again (ie. after disconnect).

BTW I am making modifications to connection handling in esp-now-search branch of my fork.

@netmindz netmindz merged commit c3f6537 into wled:main Feb 16, 2025
20 checks passed
@DedeHai DedeHai deleted the wifi_hardware_timing_fix branch February 16, 2025 15:57
@netmindz netmindz mentioned this pull request May 26, 2025
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants