Skip to content

Commit 732c2d9

Browse files
committed
Update based on feedback
removed a number of methods that are not going to be public soon, and general revised some of the other methods
1 parent 0bc469f commit 732c2d9

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

docs/api.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -51,26 +51,22 @@ ArduinoCloud.setTimestamp(cloudVariable, timestamp)
5151
- `String` - property name
5252
- `unsigned long const` - timestamp
5353

54-
### `setThingId()`
5554

56-
Sets the Thing ID.
55+
### `getThingId()`
56+
57+
Gets the Thing ID.
5758

5859
#### Syntax
5960

6061
```
61-
ArduinoCloud.setThingId(thingId)
62+
ArduinoCloud.getThingId()
6263
```
6364

6465
#### Parameters
65-
- `String` - your Thing's ID. Obtainable in the IoT Cloud interface.
66-
67-
### `String & getThingId()`
68-
69-
Gets the Thing ID.
70-
71-
#### Syntax
66+
None.
7267

73-
#### Parameters
68+
#### Returns
69+
- `String` - Thing ID.
7470

7571
### `setDeviceId()`
7672

@@ -214,14 +210,6 @@ None
214210
- `unsigned long` - local time
215211

216212

217-
### `updateInternalTimezoneInfo()`
218-
219-
Updates the internal timezone information.
220-
221-
#### Syntax
222-
223-
#### Parameters
224-
225213
### `addCallback()`
226214

227215
Adds a callback function for IoT Cloud events.
@@ -355,6 +343,10 @@ Nothing.
355343

356344
This method is only enabled if you are using an ESP32/ESP8266 board, and sets the board/device id.
357345

346+
Currently, the following official Arduino boards uses this method:
347+
- [Arduino UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi)
348+
- [Arduino Nano ESP32](https://store.arduino.cc/products/nano-esp32)
349+
358350
#### Syntax
359351

360352
```
@@ -430,16 +422,7 @@ This function initializes the ArduinoIoTCloudLPWAN library with the specified co
430422

431423
#### Description
432424

433-
**Note:** for TCP devices, the `update()` function is implemented differently. See [ArduinoCloud Class (TCP)]().
434-
435-
Responsible for updating the IoT Cloud connection.
436-
- First it feeds a watchdog timer, making sure it is not stuck anywhere,
437-
- then sends variable updates to the IoT Cloud (via MQTT client)
438-
- finally, it checks for new data from the IoT Cloud (via the MQTT client)
439-
440-
Any IoT Cloud sketch needs to continuously call the `update()` function, as it will otherwise time out and reset. The `update()` is by default placed inside of the `loop()`.
441-
442-
**Note:** do not use the `delay()` function in the sketch, as the watchdog timer will cause the board to reset and attempt to reconnect.
425+
This method handles the update between the board and the IoT Cloud.
443426

444427
#### Syntax
445428

@@ -505,7 +488,21 @@ ArduinoCloud.addProperty(cloudVariable, tag, permission, policy, callbackFunctio
505488
#### Returns
506489
Nothing.
507490

508-
## `isRetryEnabled()`
491+
### `setThingId()`
492+
493+
Sets the Thing ID.
494+
495+
#### Syntax
496+
497+
```
498+
ArduinoCloud.setThingId(thingId)
499+
```
500+
501+
#### Parameters
502+
- `String` - your Thing's ID. Obtainable in the IoT Cloud interface.
503+
504+
505+
### `isRetryEnabled()`
509506

510507
#### Description
511508
This method is used to check whether retry functionality is enabled.

0 commit comments

Comments
 (0)