Skip to content

Commit d3ff3cd

Browse files
committed
cleanup and simplify docs
1 parent 857b0c2 commit d3ff3cd

9 files changed

Lines changed: 22 additions & 64 deletions
-140 KB
Loading
-126 KB
Loading

docs/assets/Device_Name_ENS160.JPG

-3.48 KB
Loading
62.6 KB
Loading
10.8 KB
Loading
174 KB
Loading
-24.6 KB
Loading
-21.5 KB
Loading

docs/troubleshooting.md

Lines changed: 22 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
1-
!!! note
2-
<span class="glyphicon glyphicon-question-sign" aria-hidden="true"></span>
3-
<strong> Not working as expected and need help? </strong> <br /><br />
1+
---
2+
icon: material/help-circle-outline
3+
---
44

5-
If you need technical assistance and more information on a product that is not working as you expected, we recommend heading on over to the <a href="https://www.sparkfun.com/technical_assistance">SparkFun Technical Assistance</a> page for some initial troubleshooting. <br /><br />
6-
7-
<div style="text-align: center"><a href="https://www.sparkfun.com/technical_assistance" target="sfe_technical_assistance" class="md-button">SparkFun Technical Assistance Page</a></div>
8-
9-
If you don't find what you need there, the <a href="https://forum.sparkfun.com/index.php">SparkFun Forums</a> are a great place to find and ask for help. If this is your first visit, you'll need to <a href="https://forum.sparkfun.com/ucp.php?mode=register">create a Forum Account</a> to search product forums and post questions.<br /><br />
10-
11-
<div style="text-align: center"><a href="https://forum.sparkfun.com/ucp.php?mode=register" class="md-button">Create New Forum Account</a>&nbsp;&nbsp;&nbsp;<a href="https://forum.sparkfun.com/index.php" class="md-button md-button--primary">Log Into SparkFun Forums</a></div>
5+
# Troubleshooting and Support
126

7+
## Support
138

9+
If you need technical assistance and more information on a product that is not working as you expected, visit the [SparkFun Community](https://community.sparkfun.com). The community forums are monitored by the SparkFun Technical Support Team and the SparkFun community as a whole.
1410

1511
### Issues Connecting to IoT Service
1612

1713
Having trouble connecting your DataLogger IoT to an IoT service? Make sure to check your credentials and ensure that the configuration matches the IoT Service (such as your WiFi network, port, server, topic, certificates, keys, etc. to name a few). Make sure to also include the associated certificates and keys in the microSD card as well. You may see an output similar to the following errors below.
1814

19-
20-
2115
#### AWS IoT Error
2216

2317
The following error occurred when the DataLogger IoT was initializing with AWS.
@@ -26,15 +20,10 @@ The following error occurred when the DataLogger IoT was initializing with AWS.
2620
[W] AWS IoT disconnected - reconnecting.......[E] AWS IoT: MQTT connection failed. Error Code: -2
2721
```
2822

29-
<div style="text-align: center">
30-
<a href="../assets/Incorrect_Configuration_Connection_Failed_IoT_Service_AWS.JPG">
31-
<img src="../assets/Incorrect_Configuration_Connection_Failed_IoT_Service_AWS.JPG" width="600px" height="600px" alt="Configuration entered incorrectly, DataLogger not connecting to IoT Service"></a>
32-
</div>
23+
![Configuration entered incorrectly, DataLogger not connecting to IoT Service](assets/Incorrect_Configuration_Connection_Failed_IoT_Service_AWS.JPG)
3324

3425
In this case, the DataLogger IoT failed to connect to AWS IoT service because the port was using the default value that was saved: `1883`. Ensure that the port is set to `8883` for your IoT service (e.g. AWS IoT, Azure, and ThingSpeak) and saved in persistent memory in order for the DataLogger IoT to successfully connect. As of firmware v01.00.04, the default is `8883`.
3526

36-
37-
3827
#### ThinkSpeak IoT Error
3928

4029
The following error occurred when the DataLogger IoT was initializing with ThingSpeak.
@@ -43,15 +32,10 @@ The following error occurred when the DataLogger IoT was initializing with Thing
4332
[I] ThingSpeak MQTT: connecting to MQTT endpoint mqtt3.thingspeak.com:8883 .......[E] ThingSpeak MQTT: Connection Error [4]
4433
```
4534

46-
<div style="text-align: center">
47-
<a href="../assets/Incorrect_Configuration_Connection_Failed_IoT_Service_ThingSpeak.JPG">
48-
<img src="../assets/Incorrect_Configuration_Connection_Failed_IoT_Service_ThingSpeak.JPG" width="600px" height="600px" alt="Configuration entered incorrectly, DataLogger not connecting to IoT Service - ThingSpeak"></a>
49-
</div>
35+
![Configuration entered incorrectly, DataLogger not connecting to IoT Service - ThingSpeak](assets/Incorrect_Configuration_Connection_Failed_IoT_Service_ThingSpeak.JPG)
5036

5137
In this case, the DataLogger IoT failed to connect to ThingSpeak service because the credentials were entered incorrectly. Ensure that the and saved in persistent memory in order for the DataLogger IoT to successfully connect.
5238

53-
54-
5539
#### Arduino Cloud Error 1
5640

5741
The following error was occurred when the DataLogger IoT was initializing with Arduino Cloud.
@@ -65,15 +49,10 @@ The following error was occurred when the DataLogger IoT was initializing with A
6549
[E] Arduino IoT Cloud not available or account credentials incorrect
6650
```
6751

68-
<div style="text-align: center">
69-
<a href="../assets/Arduion_IoT_Error_Connecting_Incorrect_Configuration.JPG">
70-
<img src="../assets/Arduion_IoT_Error_Connecting_Incorrect_Configuration.JPG" width="600px" height="600px" alt="Configuration entered incorrectly, DataLogger not connecting to IoT Service"></a>
71-
</div>
52+
![Configuration entered incorrectly, DataLogger not connecting to IoT Service](assets/Arduion_IoT_Error_Connecting_Incorrect_Configuration.JPG)
7253

7354
In this case, the DataLogger IoT failed to connect to the Arduino Cloud service because the credentials were incorrect. Ensure that the credentials (i.e. API client ID, API secret, device secret, device ID) are entered correctly and saved in persistent memory in order for the DataLogger IoT to successfully connect.
7455

75-
76-
7756
#### Arduino Cloud Error 2
7857

7958
The following error was occurred when the DataLogger IoT was initializing with Arduino Cloud.
@@ -84,11 +63,7 @@ The following error was occurred when the DataLogger IoT was initializing with A
8463

8564
In this case, the DataLogger IoT failed to connect to the Arduino Cloud service because the credentials were incorrect. The string was supposed to be the device ID. When copying and pasting the device ID from a PDF that was generated with the Arduino Cloud, a carriage return (`\r`) was also copied and entered in the serial terminal. By pasting the device ID into a text editor and then re-copying/pasting it into the serial terminal helped to ensure that the credentials were entered correctly.
8665

87-
88-
!!! note
89-
The device ID in this example was a randomly generated string. You will need to check to make sure that your device matches the one that the Arduino Cloud generated specifically for your account.
90-
91-
66+
> **NOTE** The device ID in this example was a randomly generated string. You will need to check to make sure that your device matches the one that the Arduino Cloud generated specifically for your account.
9267
9368
#### Arduino Cloud Error 3
9469

@@ -104,51 +79,34 @@ ArduinoIoTCloudTCP::handle_ConnectMqttBroker 2 connection attempt at tick time 3
10479

10580
In this case, the DataLogger IoT failed to connect to the Arduino Cloud service because there was already a Thing that was created. By deleting the Thing in the Arduino Cloud, the DataLogger IoT was able to automatically create another Thing and setup the variables.
10681

107-
108-
10982
### ThingSpeak Data Points Not Updating
11083

111-
If your DataLogger IoT is connected to ThingSpeak but you do not see any data, ensure that the device name matches the Qwiic device that is connect to the DataLogger IoT. For example, the DataLogger IoT and Qwiic-enabled ENS160 was able to connect to ThingSpeak as shown in the image on the bottom left. However, there were no data points in any of the graphs as shown on ThingSpeak as shown in the image on the bottom right.
84+
If your DataLogger IoT is connected to ThingSpeak but you do not see any data, ensure that the device name matches the Qwiic device that is connect to the DataLogger IoT. For example, the DataLogger IoT and Qwiic-enabled ENS160 was able to connect to ThingSpeak as shown in the following image:
11285

113-
<div style="text-align: center; pointer-events:none;">
114-
<table style="border:none;>
115-
<tr style="vertical-align:middle;">
116-
<td style="text-align: center; vertical-align: middle; border: none;"><a href="../assets/DataLogger_Connected_ThingSpeak.JPG"><img src="../assets/DataLogger_Connected_ThingSpeak.JPG" width="600px" height="600px" alt="DataLogger Connected to ThingSpeak"></a></td>
117-
<td style="text-align: center; vertical-align: middle; border: none;"><a href="../assets/ThingSpeak_ENS160_No_Data.JPG"><img src="../assets/ThingSpeak_ENS160_No_Data.JPG" width="600px" height="600px" alt="No Data Points in ThingSpeak Channel"></a></td>
118-
</tr>
119-
</table>
120-
</div>
86+
![DataLogger Connected to ThingSpeak](assets/DataLogger_Connected_ThingSpeak.JPG)
12187

122-
If you head back into the configuration menu for the DataLogger's ThingSpeak channel, make sure that the _<device name>_ matches the connected Qwiic device's name that was shown during initialization. In this case, the device that was loaded and detected was **ENS160**. Then add the channel ID before saving the system settings.
88+
However, there were no data points in any of the graphs as shown on ThingSpeak:
12389

124-
<div style="text-align: center">
125-
<a href="../assets/Device_Name_ENS160.JPG">
126-
<img src="../assets/Device_Name_ENS160.JPG" width="600px" height="600px" alt="Matching Device Name with Qwiic-Enabled ENS160 Breakout Board"></a>
127-
</div>
90+
![No Data Points in ThingSpeak Channel](assets/ThingSpeak_ENS160_No_Data.JPG)
12891

129-
!!! note
130-
Only one device can be loaded per channel! ThingSpeak is not able graph two different devices in the same channel.
92+
If you head back into the configuration menu for the DataLogger's ThingSpeak channel, make sure that the ```<device name>``` matches the connected Qwiic device's name that was shown during initialization. In this case, the device that was loaded and detected was **ENS160**. Then add the channel ID before saving the system settings.
13193

132-
Head back to your ThingSpeak Channel to verify that data is being plotted on the graphs.
94+
![Matching Device Name with Qwiic-Enabled ENS160 Breakout Board](assets/Device_Name_ENS160.JPG)
13395

134-
<div style="text-align: center">
135-
<a href="../assets/ThingSpeak_ENS160_with_Data.JPG">
136-
<img src="../assets/ThingSpeak_ENS160_with_Data.JPG" width="600px" height="600px" alt="ThingSpeak Outputting ENS160 Sensor Data on Graphs"></a>
137-
</div>
96+
> **NOTE** Only one device can be loaded per channel! ThingSpeak is not able graph two different devices in the same channel.
13897
98+
Head back to your ThingSpeak Channel to verify that data is being plotted on the graphs.
13999

100+
![ThingSpeak Outputting ENS160 Sensor Data on Graphs](assets/ThingSpeak_ENS160_with_Data.JPG)
140101

141-
### U-Blox I<sup>2</sup>C Device Disappears when IoT DataLogger Initializes
102+
### U-Blox Device Disappears when IoT DataLogger Initializes
142103

143-
If you have issues where a u-blox device that is connected to the I<sup>2</sup>C port fails to connect a second time when the IoT DataLogger initializes, this is due to a bug in the firmware from an initial release. You may see an output similar to the following message and image shown below.
104+
If you have issues where a u-blox device that is connected via qwiic fails to connect a second time when the IoT DataLogger initializes, this is due to a bug in the firmware from an initial release. You may see an output similar to the following message and image shown below.
144105

145106
``` bash
146107
[W] GNSS::isConnected no traffic seen (first attempt)
147108
```
148109

149-
<div style="text-align: center">
150-
<a href="../assets/No_GNSS_Satellite_Lock.PNG">
151-
<img src="../assets/No_GNSS_Satellite_Lock.PNG" width="600px" height="600px" alt="No Satellite Lock... Bug"></a>
152-
</div>
110+
![No Satellite Lock... Bug](assets/No_GNSS_Satellite_Lock.PNG)
153111

154112
If you see the following output and the IoT DataLogger not loading your u-blox device, you will need to [update the firmware to v01.00.03 and above](https://github.com/sparkfun/SparkFun_DataLogger/releases). For more information, make sure to check out the [tutorial on updating your IoT DataLogger's firmware](https://docs.sparkfun.com/SparkFun_DataLogger/updating_firmware/).

0 commit comments

Comments
 (0)