You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`permission` - can either be `READ` / `WRITE` or `READWRITE`
346
+
-`policy` - `ON_CHANGE` (whenever variable data changes) or `<seconds> * SECONDS`. `<seconds>` is specified in the Thing configuration.
347
+
-`callBackFunction` - by default, a callback function is added to a variable with **WRITE** permissions. A variable called `test` will automatically be added as `onTestChange` which also is added to your sketch.
348
+
349
+
#### Returns
350
+
Nothing.
351
+
332
352
### `setBoardId()`
333
353
334
354
#### Description
@@ -464,6 +484,27 @@ None.
464
484
#### Returns
465
485
Nothing.
466
486
487
+
### `addProperty()` (LPWAN)
488
+
489
+
#### Description
490
+
491
+
Adds a variable/property with a set of parameters.
-`permission` - can either be `READ` / `WRITE` or `READWRITE`
501
+
-`tag` - matches the cloud and local variables with a number. E.g. adding a second variable will have the tag `2`.
502
+
-`policy` - `ON_CHANGE` (whenever variable data changes) or `<seconds> * SECONDS`. `<seconds>` is specified in the Thing configuration.
503
+
-`callBackFunction` - by default, a callback function is added to a variable with **WRITE** permissions. A variable called `test` will automatically be added as `onTestChange` which also is added to your sketch.
Copy file name to clipboardExpand all lines: docs/readme.md
+13Lines changed: 13 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,19 @@ The ArduinoIoTCloud library is the central element of the firmware enabling cert
5
5
- To get started, check out the [official documentation](https://docs.arduino.cc/arduino-cloud/)
6
6
- For source code, check out the [GitHub repository](https://github.com/arduino-libraries/ArduinoIoTCloud)
7
7
8
+
## thingProperties.h
9
+
10
+
When you are create and configure a Thing in the [Arduino IoT Cloud interface](https://create.arduino.cc/iot/), the `thingProperties.h` file is generated automatically.
11
+
12
+
This file adds all the variable/properties along with its specifications (e.g. update policy, read/write permissions), and the type of connection handler depending on what device you have attached.
13
+
14
+
Methods such as `addProperty()` and `setThingId()` are implemented here, so there's no need for manually entering anything.
15
+
16
+
We recommend that **you do not edit this file** as it is automatically updating whenever you make changes in the Arduino IoT Cloud.
17
+
18
+
### Offline Editing
19
+
20
+
If you have set up your sketch in an offline environment, make sure that whatever changes you make are reflected in this file, as it will be updated in the online environment.
0 commit comments