-
-
Notifications
You must be signed in to change notification settings - Fork 468
[PXCT-1060] Added device provisioning documentation #2556
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
base: main
Are you sure you want to change the base?
[PXCT-1060] Added device provisioning documentation #2556
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some updates on sentences and formatting 🙏🏼
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
Preview Deployment🚀 Preview this PR: https://68c29c4df203cd14611f11cd--docs-content.netlify.app |
content/arduino-cloud/02.hardware/06.device-provisioning/assets/creating-new-device.png
Outdated
Show resolved
Hide resolved
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
…nt.md Co-authored-by: Josefine Herlin <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some comments @BenjaminDannegard 🙏🏼
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
content/arduino-cloud/02.hardware/06.device-provisioning/content.md
Outdated
Show resolved
Hide resolved
|
||
Now you have to decide how you want to set up your board with the Cloud, either via Bluetooth® or USB cable (you can check if your board is compatible with the Bluetooth method below). These two options have different processes, pick the method that suits your needs best and follow the section for your chosen method. | ||
|
||
***NOTE: If you want to use the Bluetooth method and you have an older board you need to first connect the board to the Cloud in order to update it to the newer provisioning version. Please follow the instructions [here]((#migrating-from-version-10-to-20)) first.*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is misleading compared to what actually happens. Written this way, it seems like it's possible to update the board via FE and then complete the provisioning via BLE. Actually when the user connects with the cable the board to the Web UI, the board, compatible with the Prov 2.0, is not only updated, but the migration flow completes the provisioning, so at the end it's not needed the provisioning via BLE.
The only way that the user has for seeing if the board is enabled and ready for the provisioning via BLE is checking if the led is pulsing as written in the info box of the screenshot assets/connect-with-bluetooth.png.
Being a BLE method compatible board it's not a sufficient condition to the user for having the provisioning 2.0 via BLE because the board may not execute the sketch that enables and handles it, even if the board is new and comes directly from our warehouse.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the confusing sentance, let me know if it is easier to understand now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
## Migrating from version 1.0 to 2.0 | ||
|
||
If you have a board that is compatible with version 2.0 but have provisioned it previously with version 1.0 you will need to follow these steps to upgrade it. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the user has a board that wants to migrate that he had provisioned previously, he must delete the old the one from the Devices page before starting the procedure.
Tips: the user reading this guide might wonder why he should do the migration. Maybe you can recall the user that with the Provisioning 2.0 the network credentials are moved to the board storage and that the user can update it via BLE.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added this information
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok this LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Throughout the document we always talk about wifi credentials, but with provisioning 2.0 all network types are supported if the board compatible with provisioning 2.0 supports them.
For example with the Portenta H7 are supported also the Ethernet, CAT-M1 and Cellular connectivities. Opta supports both WiFi and Ethernet.
So, via BLE is possible to configure all these connectivity types
|
||
Here are the boards that are compatible with Bluetooth provisioning via a Bluetooth connection: | ||
|
||
- [Arduino UNO R4 WiFi](https://docs.arduino.cc/hardware/uno-r4-wifi/) (Wi-Fi firmware version 0.6.0 or later required) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the Arduino Uno R4 the only listed because it's the only currently produced from factory with the new Provisioning sketch 2.0 installed?
Keep in mind that in the future also the other boards (Opta, Portenta H7, Giga, Nicla Vision....) will be produced in this way.
At that point what will differentiate a board that can be provisioned via BLE or not is whether there is a pulsating LED after the boot.
So the user can easily recognize if he can (or not) have the provisioning via BLE by the pulsing LED.
The pulsing LED can be
- blue led if the board has an RGB led
- the LED_BUILTIN in case the board doesn't have an RGB led
|
||
 | ||
|
||
You will now be taken to the device page. Here you can see the details of the board, change the name, attach it to a thing and change the network configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No! After the click on "continue" the user will be asked to insert the network credentials as using BLE. It's the same flow as via BLE.
What This PR Changes
Contribution Guidelines