Skip to content
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.

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

Fix issue with Wifi AP stopping debug in VS for IDF 5.x #2954

Merged
merged 3 commits into from
Jun 8, 2024
Merged

Fix issue with Wifi AP stopping debug in VS for IDF 5.x #2954

merged 3 commits into from
Jun 8, 2024

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Jun 8, 2024

Description

When you start a debug session the nanoClr is warm restarted.

With latest IDF we now have to make sure the created esp_netif(esp network interfaces) are destroyed when wifi & wifi AP are closed on soft reboot otherwise it fails to create new ones on new start creating an exception when netif is accessed.

  • Destroy esp_netif for both wifi station and AP on close.

Motivation and Context

How Has This Been Tested?

Tested on mini S3 device using WifiAP sample.

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features
    • Improved Wi-Fi initialization and deinitialization processes for better stability and performance on ESP32 devices.

@AdrianSoundy AdrianSoundy added Type: bug Platform: ESP32 Everything related specifically with ESP32 platform labels Jun 8, 2024
Automated fixes for code style.
@nfbot
Copy link
Member

nfbot commented Jun 8, 2024

@AdrianSoundy there are issues with the code style on the source files.
A PR was submitted with the code style fixes. Please click https://github.com/AdrianSoundy/nf-interpreter/pull/111, review the changes if you want and merge it.

Make sure to follow the project code style. Check the details here on how it works and the tools required to help you with that.

Copy link

coderabbitai bot commented Jun 8, 2024

Walkthrough

The changes in NF_ESP32_Wireless.cpp introduce two new static variables, wifiStaNetif and wifiAPNetif, which are initialized and destroyed within the Wi-Fi initialization and deinitialization functions. These modifications aim to address issues related to Wi-Fi Access Point (AP) functionality on ESP32 devices, ensuring stable operation and debugging capabilities.

Changes

File Change Summary
.../NF_ESP32_Wireless.cpp Added wifiStaNetif and wifiAPNetif variables, their initialization, and destruction in Wi-Fi functions.

Sequence Diagram(s)

sequenceDiagram
    participant UserApp
    participant NF_ESP32_Wireless
    participant ESP32

    UserApp->>NF_ESP32_Wireless: NF_ESP32_InitaliseWifi()
    NF_ESP32_Wireless->>ESP32: Initialize wifiStaNetif and wifiAPNetif
    ESP32-->>NF_ESP32_Wireless: Initialization success
    NF_ESP32_Wireless-->>UserApp: Return initialization status

    UserApp->>NF_ESP32_Wireless: NF_ESP32_DeinitWifi()
    NF_ESP32_Wireless->>ESP32: Deinitialize wifiStaNetif and wifiAPNetif
    ESP32-->>NF_ESP32_Wireless: Deinitialization success
    NF_ESP32_Wireless-->>UserApp: Return deinitialization status
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure Wi-Fi AP functionality works without causing device crashes or debugger issues (#1488, #1493)
Proper initialization and deinitialization of Wi-Fi interfaces to prevent device lock-ups (#1488)
Stable operation and debugging capabilities when Wi-Fi AP is enabled (#1493)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1f78896 and a90540e.

Files selected for processing (1)
  • targets/ESP32/_Network/NF_ESP32_Wireless.cpp (4 hunks)
Additional comments not posted (3)
targets/ESP32/_Network/NF_ESP32_Wireless.cpp (3)

20-21: Initialization of wifiStaNetif and wifiAPNetif as NULL.

This change ensures that the pointers are properly initialized to NULL before use, which is a good practice to avoid undefined behavior.


123-126: Proper destruction of esp_netif instances.

This change is crucial for preventing exceptions when esp_netif is accessed after a soft reboot, as described in the PR. It ensures that the network interfaces are properly cleaned up, which should help resolve the issues reported.


156-156: Creation of default WiFi interfaces and setting flags.

The creation of default WiFi station and AP interfaces is handled correctly. Additionally, setting the ESP_NETIF_FLAG_AUTOUP flag on the AP interface ensures that it is brought up automatically, aligning with the expected behavior.

Also applies to: 165-165, 171-172

…0c339-cc4a-4b7b-bd6f-ac908c936cb9

Code style fixes for nanoframework/nf-interpreter PR#2954
Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a90540e and 9b23f29.

Files selected for processing (1)
  • targets/ESP32/_Network/NF_ESP32_Wireless.cpp (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • targets/ESP32/_Network/NF_ESP32_Wireless.cpp

@AdrianSoundy
Copy link
Member Author

Quite interesting the output from coderabbitai

@josesimoes
Copy link
Member

@AdrianSoundy the plan is to have network debugging in the future. That's why we had wifi configured and started at boot and only config changes allowed. Therefore the network interface can not be destroyed and recreated with CLR restart. Otherwise the connection would be lost.

Can you please revisit this and make sure the fix doesn't involve restarting the network interface? :)

@AdrianSoundy
Copy link
Member Author

AdrianSoundy commented Jun 8, 2024

It's always has been destroying network on debug restarts. it's just that with idf 5 it expects more to be unitialised for it to work correctly. And that's what this fixes. So this PR doesn't change that and is to fix a problem which has occurred with latest release.

For network debugging we would need to automatically connect on startup which isn't case with how most people are using wifi. I feel this is a separate issue to be addressed. We could maintain network if set to auto connect and has ssid and already connected.
@josesimoes

@josesimoes
Copy link
Member

@AdrianSoundy understood. Let's go for this then. Thanks! 😉

@AdrianSoundy AdrianSoundy merged commit 2378ea6 into nanoframework:main Jun 8, 2024
17 checks passed
@AdrianSoundy AdrianSoundy deleted the Ap_review branch June 8, 2024 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Platform: ESP32 Everything related specifically with ESP32 platform Type: bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WiFi AP crashes debugger ESP32 S3 - Wifi AP not working anymore
3 participants