-
-
Notifications
You must be signed in to change notification settings - Fork 509
[PXCT-1579] Nesso N1 - cloud updates #2734
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?
Conversation
| 2. Navigate to **Boards Manager** (**Tools > Board > Boards Manager...**). | ||
| 3. Search for **"esp32"** and find the package by **Espressif Systems**. | ||
| 4. Click the **Install** button. | ||
| 4. Click the **Install** (or Update) button. |
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.
| 4. Click the **Install** (or Update) button. | |
| 4. Click the **Install** (or **Update**) button. |
Consistent formatting.
| ### 3. Program the Board via Desktop IDE | ||
| 1. Open the **Arduino IDE** on your computer. | ||
| 2. Install the **ArduinoIoTCloud** library via the Library Manager. | ||
| 3. Copy the sketch generated by the Cloud "Thing" (from the "Sketch" tab in the web interface) into the Arduino IDE. |
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.
Sketches are not generated for Things associated with "manual devices".
The user can use the ArduinoIoTCloud library's "ArduinoIoTCloud-Basic" example sketch as a starting point for implementing their own Thing sketch. That example is accessible by selecting File > Examples > ArduinoIoTCloud > ArduinoIoTCloud-Basic from the Arduino IDE menus.
Unfortunately that example is not very approachable to less technical users because the developers of the library added a bunch of preprocessor conditionals to make it support every possible type of Device.
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.
Another thing that should be notes about the "ArduinoIoTCloud-Basic" example sketch is that it won't compile for the Nesso N1 as written. It can still serve as a starting point for a sketch, but it will be necessary to make This is the reason why I created my own demo sketch when providing support for Nesso N1 users wanting to use Arduino Cloud:
I also think that the "ArduinoIoTCloud-Basic" example sketch program is excessively complex for something named "basic". My desire is always to start with the absolute minimum "hello world", but Arduino tends to add additional complexity to the introductory examples and tutorials. The sketch I provide at the link above is the type of simple example I always hope to find in documentation.
| 1. Open the **Arduino IDE** on your computer. | ||
| 2. Install the **ArduinoIoTCloud** library via the Library Manager. | ||
| 3. Copy the sketch generated by the Cloud "Thing" (from the "Sketch" tab in the web interface) into the Arduino IDE. | ||
| 4. Open the `thingProperties.h` tab in your local sketch. |
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.
It is true that the credentials can be configured via the thingProperties.h tab. However, the established convention is to do this via arduino_secrets.h (example). If the user is starting from a sketch that has arduino_secrets.h, I think it would be confusing for them to instead configure credentials via thingProperties.h.
The exception is that the convention is to define the Device ID via thingProperties.h (since this information is not a secret).
Preview Deployment🚀 Preview this PR: https://6920cc0c95ac7d98a0422cbc--docs-content.netlify.app |
Summary
This PR updates the Nesso N1 user manual to clarify that currently the board can be programmed with the desktop Arduino IDE, is compatible with Arduino IoT Cloud as a Manual Device, and is not yet supported by the Arduino Cloud Editor.
What changed
Software requirements
Installation section
Cloud Editor section
Arduino IoT Cloud section