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

Provisioning more than ssid and password (Discussion) (IDFGH-13601) #14488

Closed
wants to merge 1 commit into from

Conversation

eug-ev
Copy link

@eug-ev eug-ev commented Sep 3, 2024

Hi!
I've recently done a little change to wifi_provisioning library to support custom data provisioning along with wifi ssid and password.
Briefly, how it works:
If we pass this to password:
!@CDATA_%DATA_LEN%%DATA%%WifiPassword%
It would parse this string and place DATA in nvs as blob.
As example:
!@CDATA_QwAAAA==tok=1234567890:AIHyuaZFjK6qegPCojGJI0_0l7GPUNV8_PD,userid=123456789asdfzxcvb
where %DATA_LEN% is QwAAAA== (0x43),
wifi password - asdfzxcvb

Not ideal solution but it works!
Maybe some ideas for improvement or redesign to have this in idf?
Rationale: I needed to provision telegram bot token and my telegram user ID, apart from wifi credentials

@CLAassistant
Copy link

CLAassistant commented Sep 3, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

github-actions bot commented Sep 3, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "concept of providing more data than wifi creds":
    • 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 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).

⚠️
	The **target branch** for this Pull Request **must be the default branch** of the project (`master`).

	If you would like to add this feature to a different branch, please state this in the PR description and we will consider it.

👋 Hello eug-ev, 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 afe24c5

@eug-ev eug-ev changed the base branch from master to release/v5.3 September 3, 2024 05:33
@espressif-bot espressif-bot added the Status: Opened Issue is new label Sep 3, 2024
@github-actions github-actions bot changed the title Provisioning more than ssid and password (Discussion) Provisioning more than ssid and password (Discussion) (IDFGH-13601) Sep 3, 2024
@DaveLegg
Copy link

This functionality already exists, you can use calls to wifi_prov_mgr_endpoint_create/wifi_prov_mgr_endpoint_register to add additional endpoints to receive your custom data, so in your case likely one for the telegram bot token, and one for the user ID

wifi_prov_mgr_endpoint_create

@eug-ev
Copy link
Author

eug-ev commented Sep 11, 2024

Thanks for the answers and sorry I hadn't researched more for this.

Does Android app supports some extra endpoints for custom data?

I've found only one related function in Android repo, sendDataToCustomEndpoint.
However its not used anywhere and probably supposed to be implemented in custom Android app.

My point was to add some support in already existing application.
Thanks for attention!

@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Sep 17, 2024
@hrushikesh430
Copy link
Collaborator

This functionality already exists, you can use calls to wifi_prov_mgr_endpoint_create/wifi_prov_mgr_endpoint_register to add additional endpoints to receive your custom data, so in your case likely one for the telegram bot token, and one for the user ID

wifi_prov_mgr_endpoint_create

@eug-ev check this example for reference.

@hrushikesh430
Copy link
Collaborator

Thanks for the answers and sorry I hadn't researched more for this.

Does Android app supports some extra endpoints for custom data?

I've found only one related function in Android repo, sendDataToCustomEndpoint. However its not used anywhere and probably supposed to be implemented in custom Android app.

My point was to add some support in already existing application. Thanks for attention!

Thanks for the answers and sorry I hadn't researched more for this.

Does Android app supports some extra endpoints for custom data?

I've found only one related function in Android repo, sendDataToCustomEndpoint. However its not used anywhere and probably supposed to be implemented in custom Android app.

My point was to add some support in already existing application. Thanks for attention!

Yes this Api will help. If you need example or some issue you can file an issue regarding this api on this repo

@hrushikesh430
Copy link
Collaborator

As API is already available for custom data as mentioned above, so closing this PR.

@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: Won't Do This will not be worked on and removed Status: In Progress Work is in progress labels Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: Won't Do This will not be worked on Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants