Skip to content

Commit 0504dd4

Browse files
committed
Update to Arduino Cloud and Fix Minor Typos
- Update directions and screenshots for Arduino IoT Cloud with Arduino's new UI and reference most to the new Arduino Cloud - Update menu systems to reflect changes in v01.01.01 - Update minor typos
1 parent 32e0635 commit 0504dd4

28 files changed

+79
-84
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This repository contains the latest firmware for the SparkFun DataLogger IoT pro
2222

2323
The current list of SparkFun boards supported by the SparkFun DataLogger IoT are listed in the [DataLogger Supported Device List](../supported_devices).
2424

25-
SparkFun DataLogger IoT products include Internet connectivity built in, and includes connections for a variety of IoT service services and end-point types. Connection types include MQTT, HTTP, AWS IoT, Azure IoT, ThingSpeak, Arduino IoT Cloud. To enable connectivity, connect the DataLogger IoT to a WiFi network, enter the required credentials for the specific IoT service being used, and the DataLogger IoT will do the rest - no programming required.
25+
SparkFun DataLogger IoT products include Internet connectivity built in, and includes connections for a variety of IoT service services and end-point types. Connection types include MQTT, HTTP, AWS IoT, Azure IoT, ThingSpeak, Arduino Cloud. To enable connectivity, connect the DataLogger IoT to a WiFi network, enter the required credentials for the specific IoT service being used, and the DataLogger IoT will do the rest - no programming required.
2626

2727
The DataLogger IoT products are highly configurable via an easily to use serial interface. Simply plug in a USB C cable and open a terminal at 115200 Kbps. By default the logging output is automatically streamed to the serial terminal - pressing any key will bring up the menu system. Device settings are also configurable via a JSON file contained on an inserted SD card - enabling rapid configuration for multiple devices.
2828

-52.3 KB
Binary file not shown.
54.8 KB
Loading
Loading
Loading
Loading
Loading

docs/assets/aiot_cloud_api-k.jpg

82.5 KB
Loading

docs/assets/aiot_cloud_create_key.jpg

-62.1 KB
Loading

docs/assets/aiot_cloud_home.jpg

-261 KB
Binary file not shown.

docs/assets/aiot_cloud_key_name.jpg

-12.4 KB
Loading

docs/assets/aiot_cloud_key_secret.jpg

16.1 KB
Loading
-361 KB
Binary file not shown.

docs/assets/aiot_cloud_sel.jpg

-394 KB
Binary file not shown.

docs/assets/aiot_cloud_sel_2.jpg

-422 KB
Binary file not shown.
208 KB
Loading

docs/assets/aiot_cloud_vars.jpg

28.9 KB
Loading

docs/assets/aiot_dashboard.jpg

-96 KB
Loading

docs/assets/aiot_dashboard_link.jpg

-31.7 KB
Loading
-110 KB
Loading

docs/assets/aiot_dev_add.jpg

83.7 KB
Loading

docs/assets/aiot_dev_name.jpg

-73.6 KB
Loading

docs/assets/aiot_dev_secrets.jpg

-38.7 KB
Loading

docs/assets/aiot_dev_setup_sel.jpg

-55.2 KB
Loading

docs/configuration.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -230,12 +230,13 @@ When finished, you will need to exit the menus so that the DataLogger IoT saves
230230

231231
### General: Save Settings
232232

233-
In the Settings menu, send a <kbd>2</kbd> to adjust the Save Settings.
233+
In the Settings menu, send a <kbd>2</kbd> to adjust the Save Settings. As of firmware v01.01.01, the JSON output buffer size is now user configurable. This will be under option "**JSON File Buffer Size**" when in the Save Settings Menu.
234234

235235
<div style="text-align: center">
236236
<a href="../assets/SparkFun_Datalogger_IoT_Save_Settings_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Save_Settings_Menu.JPG"" width="600" height="600"></a>
237237
</div>
238238

239+
239240
In the Save Settings Menu, users will be able to save, restore, or clear any preferences in memory (i.e. persistent storage) or a saved file to a fallback device (i.e. microSD card). Note that any passwords and secret keys are not saved in the save settings file. You will need to manually enter those values in the file saved on the microSD card.
240241

241242
* <kbd>1</kbd> **Fallback Restore** &mdash; If unable to restore settings, use the fallback source (JSON File)
@@ -246,23 +247,26 @@ In the Save Settings Menu, users will be able to save, restore, or clear any pre
246247
* Accepts a boolean value:
247248
* <kbd>1</kbd> to enable
248249
* <kbd>0</kbd> to disable _(default)_
249-
* <kbd>3</kbd> **Save Settings** &mdash; Save current settings to persistent storage
250+
* <kbd>3</kbd> **JSON File Buffer Size** &mdash; The size in bytes used for the internal I/O buffer
251+
* Accepts an unsigned integer:
252+
* <kbd>6400</kbd> _(default, as of firmware v01.01.01)_
253+
* <kbd>4</kbd> **Save Settings** &mdash; Save current settings to persistent storage
250254
* Accepts a yes/no:
251255
* <kbd>Y</kbd> or <kbd>y</kbd> for yes
252256
* <kbd>N</kbd> or <kbd>n</kbd> for no
253-
* <kbd>4</kbd> **Restore Settings** &mdash; Restore saved settings
257+
* <kbd>5</kbd> **Restore Settings** &mdash; Restore saved settings
254258
* Accepts a yes/no:
255259
* <kbd>Y</kbd> or <kbd>y</kbd> for yes
256260
* <kbd>N</kbd> or <kbd>n</kbd> for no
257-
* <kbd>5</kbd> **Clear Settings** &mdash; Erase the saved settings on the device
261+
* <kbd>6</kbd> **Clear Settings** &mdash; Erase the saved settings on the device
258262
* Accepts a yes/no:
259263
* <kbd>Y</kbd> or <kbd>y</kbd> for yes
260264
* <kbd>N</kbd> or <kbd>n</kbd> for no
261-
* <kbd>6</kbd> **Save to Fallback** &mdash; Save System Settings to the fallback storage (JSON File)
265+
* <kbd>7</kbd> **Save to Fallback** &mdash; Save System Settings to the fallback storage (JSON File)
262266
* Accepts a yes/no:
263267
* <kbd>Y</kbd> or <kbd>y</kbd> for yes
264268
* <kbd>N</kbd> or <kbd>n</kbd> for no
265-
* <kbd>7</kbd> **Restore from Fallback** &mdash; Restore system settings from the fallback storage (JSON File)
269+
* <kbd>8</kbd> **Restore from Fallback** &mdash; Restore system settings from the fallback storage (JSON File)
266270
* Accepts a yes/no:
267271
* <kbd>Y</kbd> or <kbd>y</kbd> for yes
268272
* <kbd>N</kbd> or <kbd>n</kbd> for no
@@ -287,31 +291,34 @@ When finished, you will need to exit the menus so that the DataLogger IoT saves
287291
!!! note
288292
Make sure to connect the ESP32-WROOM to a 2.4GHz WiFi network and ensure that is not a guest network that requires you to sign in. Unfortunately, 5GHz WiFi is not supported on the ESP32-WROOM module.
289293

290-
In the Settings Menu, send <kbd>3</kbd> to manage the time reference sources.
294+
In the Settings Menu, send <kbd>3</kbd> to manage the time reference sources. As of firmware v01.01.01, time zone support is at the clock level, not tied to NTP. The option to adjust the Time Zone is moved to the Time Sources menu.
291295

292296
<div style="text-align: center">
293297
<a href="../assets/SparkFun_Datalogger_IoT_Time_Sources_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Time_Sources_Menu.JPG" width="600" height="600" alt="Time Source Menu Options"></a>
294298
</div>
295299

296300
In this menu, you will have options to update the primary reference clock, update interval, add a secondary reference clock, and update it's interval. By default, the primary reference clock is set to use the Network Time Protocol (NTP). To synchronization the time, you will need to connect to a 2.4GHz WiFi network in order to update the time. To add a secondary clock, make sure to connect a compatible Qwiic-enabled devices that can keep track of time (i.e. Qwiic Real Time Clock Module - RV-8803 or a Qwiic-enabled u-blox GNSS module).
297301

298-
* <kbd>1</kbd> **Reference Clock** &mdash; The current reference clock source
302+
* <kbd>1</kbd> **The Time Zone** &mdash; Time zone setting string for the device
303+
* Accepts a string:
304+
* <kbd>MST7MDT,M3.2.0,M11.1.0</kbd> _(default, as of firmware v01.01.01)_
305+
* <kbd>2</kbd> **Reference Clock** &mdash; The current reference clock source
299306
* Accepts the following values:
300307
* <kbd>1</kbd> for no clock
301308
* <kbd>2</kbd> for NTP Client _(default)_
302-
* <kbd>2</kbd> **Update Interval** &mdash; Main clock update interval in minutes. 0 = No update
309+
* <kbd>3</kbd> **Update Interval** &mdash; Main clock update interval in minutes. 0 = No update
303310
* Accepts an unsigned integer:
304311
* <kbd>0</kbd> = No update
305312
* <kbd>60</kbd> seconds _(default)_
306-
* <kbd>3</kbd> **Enable Clock Fallback** &mdash; Use a valid reference clock if the primary is not available
313+
* <kbd>4</kbd> **Enable Clock Fallback** &mdash; Use a valid reference clock if the primary is not available
307314
* Accepts a boolean value:
308315
* <kbd>1</kbd> to enable _(default)_
309316
* <kbd>0</kbd> to disable
310-
* <kbd>4</kbd> **Dependant Interval** &mdash; Connected depedant clock update interval in minutes. 0 = No update
317+
* <kbd>5</kbd> **Dependant Interval** &mdash; Connected depedant clock update interval in minutes. 0 = No update
311318
* Accepts an unsigned integer:
312319
* <kbd>0</kbd> = No update
313320
* <kbd>60</kbd> seconds _(default)_
314-
* <kbd>5</kbd> **Update Connected** &mdash; Update connected clocks on main clock update
321+
* <kbd>6</kbd> **Update Connected** &mdash; Update connected clocks on main clock update
315322
* Accepts a boolean value:
316323
* <kbd>1</kbd> to enable _(default)_
317324
* <kbd>0</kbd> to disable
@@ -411,7 +418,7 @@ Press the reset button or cycle power to restart the DataLogger IoT. You can als
411418

412419
### Network: NTP Client
413420

414-
In the Settings menu, send a <kbd>5</kbd> to adjust the NTP Client settings.
421+
In the Settings menu, send a <kbd>5</kbd> to adjust the NTP Client settings. As of firmware v01.01.01, time sonze support is at the clock level, not tied to the NTP. The option to adjust the Time Zone is moved to the Time Sources menu.
415422

416423
<div style="text-align: center">
417424
<a href="../assets/SparkFun_Datalogger_IoT_NTP_Client_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_NTP_Client_Menu.JPG" width="600" height="600" alt="NTP Client Menu Options"></a>
@@ -429,9 +436,6 @@ In this menu, users will have the option to enable/disable the NTP client, selec
429436
* <kbd>3</kbd> **NTP Server Two** &mdash; The secondary NTP Server to use
430437
* Accepts a string:
431438
* <kbd>pool.ntp.org</kbd> _(default)_
432-
* <kbd>4</kbd> **The Time Zone** &mdash; Time zone setting string for the device
433-
* Accepts a string:
434-
* <kbd>MST7MDT,M3.2.0,M11.1.0</kbd> _(default)_
435439
* <kbd>b</kbd> **Back**
436440

437441
!!! note
@@ -793,12 +797,15 @@ In the Settings menu, send an <kbd>15</kbd> to adjust settings for MachineChat.
793797
* <kbd>b</kbd> **Back**
794798

795799

796-
### IoT Services: Arduino IoT Cloud
800+
### IoT Services: Arduino Cloud
801+
802+
!!! arduino
803+
At the time of writing, Arduino's IoT service was referred to as the "Arduino IoT Cloud." [Arduino updated the service with a different UI and is now referring to the service as the "Arduino Cloud"](https://blog.arduino.cc/2023/11/15/announcing-a-better-arduino-cloud-together/)." When referencing the Arduino IoT or Arduino IoT Cloud in this tutorial, we are referring to the Arduino Cloud.
797804

798-
In the Settings menu, send an <kbd>16</kbd> to adjust settings for Arduino IoT Cloud.
805+
In the Settings menu, send an <kbd>16</kbd> to adjust settings for Arduino Cloud. This feature was added as of firmware v01.01.01.
799806

800807
<div style="text-align: center">
801-
<a href="../assets/SparkFun_DataLogger_IoT_Arduino_IoT_Cloud_Menu.JPG"><img src="../assets/SparkFun_DataLogger_IoT_Arduino_IoT_Cloud_Menu.JPG" width="600" height="600" alt="Arduino IoT Cloud Menu Options"></a>
808+
<a href="../assets/SparkFun_DataLogger_IoT_Arduino_IoT_Cloud_Menu.JPG"><img src="../assets/SparkFun_DataLogger_IoT_Arduino_IoT_Cloud_Menu.JPG" width="600" height="600" alt="Arduino Cloud Menu Options"></a>
802809
</div>
803810

804811
* <kbd>1</kbd> **Enabled** &mdash; Enable or Disable the Arduino IoT Client

0 commit comments

Comments
 (0)