Skip to content

Commit c957566

Browse files
committed
Minor fixes and updated troubleshooting
1 parent a360899 commit c957566

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ You can override this by defining your custom interval (in seconds) using `wifiS
287287

288288
```cpp
289289
void setup() {
290-
device.wifiSignalReporting(true, seconds);
290+
device.wifiSignalReporting(true, 600); // Turns on and reports WiFi Signal Strength every 10 minutes (600 seconds)
291291
device.init();
292292
}
293293
```
@@ -306,7 +306,7 @@ void setup() {
306306
device.init();
307307
}
308308
void loop() {
309-
Serial.println(wifiSignal()); // Prints WiFi signal to serial
309+
Serial.println(wifiSignal()); // Prints WiFi signal to Serial
310310
}
311311
```
312312

@@ -338,8 +338,8 @@ Method accepts 4 arguments of type String, which are:
338338
Example:
339339
```cpp
340340
void setup() {
341-
Serial.begin(115200);
342-
device.debugPort(Serial);
341+
Serial.begin(115200); // Initialize Serial to 115200 baud rate
342+
device.debugPort(Serial); // Enable SDK debug output
343343
device.createAsset("led", "LED Light", "actuator", "boolean");
344344
device.createAsset("servo", "Servo Motor", "actuator", "integer");
345345
device.createAsset("button", "Push Button", "sensor", "boolean");
@@ -511,7 +511,7 @@ For example, if you have `Serial.begin(115200)` in your `setup()` function, you'
511511
512512
```cpp
513513
void setup() {
514-
Serial.begin(115200);
514+
Serial.begin(115200); // Initialize Serial to 115200 baud rate
515515
device.debugPort(Serial); // Now the library knows where to output debug information
516516
device.init();
517517
}
@@ -548,7 +548,7 @@ Example:
548548

549549
```cpp
550550
void setup() {
551-
Serial.begin(115200);
551+
Serial.begin(115200); // Initialize Serial to 115200 baud rate
552552
device.debugPort(Serial, true); // Verbose Debug Output is now enabled
553553
device.init();
554554
}
@@ -557,7 +557,7 @@ void setup() {
557557

558558
# Troubleshooting and Notes
559559

560-
- This SDK has been tested and confirmed to work with the following software, so if you're having issues with your device/code, **make sure** you're working with at least these versions:
560+
- This SDK has been tested and confirmed to work with the following software, so if you're having issues with your device/code, **make sure you're working with at least these versions**:
561561

562562
| Name | Version | Used for | Type | Description |
563563
|--|--|--|--|--|
@@ -571,6 +571,8 @@ void setup() {
571571
| [PubSubClient](https://pubsubclient.knolleary.net/) (INCLUDED) | 2.7.0 | All | Arduino Library | Used by this SDK to connect to AllThingsTalk. Already included in this SDK. |
572572
- Make sure to [enable verbose debug output](#enable-verbose-debug-output) as it could tell you a lot and thus help you resolve your problem.
573573
- If you try to send data to a non-existent asset on AllThingsTalk, you might get disconnected. This is by design. You can make sure the asset exists by using the [create assets](#creating-assets) feature of this SDK.
574+
- If you get connected to WiFi easily but AllThingsTalk is connecting and disconnecting erratically, check your AllThingsTalk [credentials](#defining-credentials) (they could be wrong, token could be revoked, device may be deleted, etc)
575+
- If you are constantly getting disconnected (WiFi taking too long to connect, AllThingsTalk connection being dropped constantly), try to change your WiFi access point - it could be that it's congested.
574576
- Connection to AllThingsTalk may break if you use the `delay()` function too often or for prolonged periods of time due to the nature of that function. The SDK will recover the connection automatically, but if this happens too often, try to use `millis()` to create delays when possible.
575577
- Due to how ESP8266 works, the WiFi Connection may break when using `AnalogRead()` sometimes. This is out of our control. It will most likely fail when reading an analog pin too often. In this case, it is okay to use `delay()` for about 50 or more milliseconds (see what works for you) in order to avoid this issue.
576578
- Receiving **JSON Objects** or **JSON Arrays** is not currently supported. Support is planned in a future release.

0 commit comments

Comments
 (0)