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

Wifi stay disconnected after manual disconnect #3033

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Nov 6, 2024

Description

If the Wifi connection was disconnected using WifiNetworkHelper.Disconnect() the connection was disconnected and then reconnected automatically as if it was a network error.

This change causes the Wifi to stay disconected.

Motivation and Context

Reported on discord.
https://discord.com/channels/478725473862549535/483428854493478913/1301627595619700776

How Has This Been Tested?

Tested using Wifi test program and monitoring events, access point.

Note : There is also a problem with WifiNetworkHelper which doesn't allow you to connect again after the disconnect.

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/declarations (update dependencies or assembly declarations 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

    • Enhanced connection management by ensuring the disconnect operation clears the connection flag.
    • Added a check to verify wireless station mode before initiating a connection.
  • Bug Fixes

    • Improved robustness of connection logic to prevent connection attempts when the station mode is inactive.

Stay disconnected after manual disconnect
@nfbot nfbot added the Type: bug label Nov 6, 2024
Copy link

coderabbitai bot commented Nov 6, 2024

Walkthrough

The pull request modifies two functions in the NF_ESP32_Wireless.cpp file. The NF_ESP32_Wireless_Disconnect function now sets the NF_ESP32_IsToConnect flag to false before disconnecting, enhancing connection state management. The NF_ESP32_Wireless_Open function has been updated to check if the wireless station mode is enabled before initiating a connection, preventing connection attempts when the mode is inactive. These changes aim to improve the robustness and accuracy of connection handling.

Changes

File Change Summary
targets/ESP32/_Network/NF_ESP32_Wireless.cpp - Updated NF_ESP32_Wireless_Disconnect to set NF_ESP32_IsToConnect to false before disconnecting.
- Modified NF_ESP32_Wireless_Open to check for active wireless station mode before connecting.

Possibly related PRs

Suggested labels

Platform: ESP32


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

@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

🧹 Outside diff range and nitpick comments (1)
targets/ESP32/_Network/NF_ESP32_Wireless.cpp (1)

284-285: Consider improving connection state management.

While the current solution using a global flag works, consider these future improvements:

  1. Encapsulate connection state management in a dedicated class/struct
  2. Use an enum for connection states instead of boolean flags
  3. Add state transition validation

This would make the code more maintainable and robust.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0516bd1 and dc848b3.

📒 Files selected for processing (1)
  • targets/ESP32/_Network/NF_ESP32_Wireless.cpp (1 hunks)
🔇 Additional comments (1)
targets/ESP32/_Network/NF_ESP32_Wireless.cpp (1)

284-285: LGTM! Setting connection flag prevents auto-reconnection.

The addition of NF_ESP32_IsToConnect = false before disconnecting is the correct approach to maintain the disconnected state and prevent automatic reconnection. This change directly addresses the PR objective.

Let's verify the flag usage across the codebase:

✅ Verification successful

Setting NF_ESP32_IsToConnect = false is correctly integrated with the WiFi connection management

The verification shows that NF_ESP32_IsToConnect is consistently used across the codebase:

  • It's declared as a global flag in NF_ESP32_Network.h
  • Used in targetHAL_Network.cpp to control WiFi connection attempts
  • In NF_ESP32_Wireless.cpp, it's properly managed:
    • Set to true when opening a connection
    • Set to false before disconnecting
    • Reset to false in error conditions

The change aligns with the existing connection management logic and correctly prevents auto-reconnection after manual disconnect.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all places where NF_ESP32_IsToConnect is used to ensure consistent behavior
rg -A 3 "NF_ESP32_IsToConnect" 

Length of output: 2617

@josesimoes josesimoes added the Platform: ESP32 Everything related specifically with ESP32 platform label Nov 6, 2024
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

Simple and effective! 😉

@AdrianSoundy
Copy link
Member Author

Any idea why its getting a build error with

2024-11-06T06:24:29.5803921Z CMake Error at D:/a/1/s/esp-idf/tools/cmake/build.cmake:592 (message):
2024-11-06T06:24:29.5805983Z Failed to resolve component 'littlefs'.

@josesimoes

@josesimoes
Copy link
Member

@AdrianSoundy I do... just spent the last hour trying to figure out this... 🙄
Espressif has made breaking changes (without any notice) to their component registry IDs and API.
PR with fixes in the pipeline. I'll merge it here when its merged.

@josesimoes josesimoes enabled auto-merge (squash) November 6, 2024 11:42
@josesimoes josesimoes merged commit 8f13c66 into nanoframework:main Nov 6, 2024
18 checks passed
@AdrianSoundy AdrianSoundy deleted the wifiDisconnect branch November 7, 2024 01:23
TerryFogg pushed a commit to TerryFogg/nf-interpreter that referenced this pull request Dec 3, 2024
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.

3 participants