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

Add check prov mgr is stopped (IDFGH-11433) #12570

Closed
wants to merge 2 commits into from

Conversation

Diam2023
Copy link
Contributor

When I called the wifi_prov_mgr_stop_provisioning function it didn't stop immediately,
So I added a check to see if the prov was stopped

@CLAassistant
Copy link

CLAassistant commented Nov 13, 2023

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Nov 13, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add check prov mgr is stopped":
    • 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
  • sufficiently descriptive message summary should be between 20 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 Diam2023, 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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 9cdf5ab

@espressif-bot espressif-bot added the Status: Opened Issue is new label Nov 13, 2023
@github-actions github-actions bot changed the title Add check prov mgr is stopped Add check prov mgr is stopped (IDFGH-11433) Nov 13, 2023
@laukik-hase
Copy link
Collaborator

Hello, @Diam2023!

Thanks for the contribution.

Rather than adding a new API, could you use an event handler to handle the WIFI_PROV_END which signifies the stopping of the provisioning service? See reference here.

@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Nov 27, 2023
@Diam2023
Copy link
Contributor Author

Hello, @Diam2023!

Thanks for the contribution.

Rather than adding a new API, could you use an event handler to handle the WIFI_PROV_END which signifies the stopping of the provisioning service? See reference here.

Hello, @laukik-hase!

Thanks for your reply.

This is my idea, Consider the following situation:
In an inappropriate usage event, when the device is connected to Android, Android actively disconnects the Bluetooth connection, causing prov to fail.
Now the status value obtained by wifi_prov_mgr_get_wifi_state is WIFI_PROV_STA_DISCONNECTED. This cannot indicate whether the prov_mgr prov is successful or not. The status is caused by prov failure, but the reason for the disconnection can be obtained by wifi_prov_mgr_get_wifi_disconnect_reason.
If I don't care about event, I need to call the stop network provisioning API and wait for it to completely stop before calling wifi_prov_mgr_start_provisioning to restart prov, But There is no way to know the status of prov_ctx->prov_state, so I want an API to get whether it is completely stopped or blocked until it is completely stopped.

For example:

void wifi_prov_mgr_stop_provisioning_blocking()
{

    if (!prov_ctx_lock) {
        ESP_LOGE(TAG, "Provisioning manager not initialized");
        return;
    }

    ACQUIRE_LOCK(prov_ctx_lock);

    wifi_prov_mgr_stop_service(1);

    RELEASE_LOCK(prov_ctx_lock);
}

//  -------------- OR

bool wifi_prov_mgr_is_stopped()
{
    return prov_ctx->prov_state == WIFI_PROV_STATE_IDLE;
}

@laukik-hase
Copy link
Collaborator

sha=65bc5668da702dead5424bc238bf548361a2ca1c

@laukik-hase laukik-hase added the PR-Sync-Merge Pull request sync as merge commit label Dec 19, 2023
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: In Progress Work is in progress labels Dec 20, 2023
@laukik-hase
Copy link
Collaborator

Merged with c93bce2

Thanks for the contribution, @Diam2023!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Merge Pull request sync as merge commit Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants