Skip to content

Commit b82a16c

Browse files
fabik111fabik111
committed
add payload description
1 parent 9710236 commit b82a16c

File tree

1 file changed

+115
-1
lines changed

1 file changed

+115
-1
lines changed

‎arduino-cloud.html‎

Lines changed: 115 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,30 @@ <h3>Outputs</h3>
265265
<dt>topic <span class="property-type">string</span></dt>
266266
<dd>the message topic.</dd>
267267
<dt>payload <span class="property-type"></span></dt>
268-
<dd>the property last value.</dd>
268+
<dd>the property incoming value.</dd>
269+
<dd>The payload format type is the property type for primitive types. Instead, for multi-value property the payload is a JSON object according documented notation.</dd>
270+
<dd>Examples</dd>
271+
<dd>
272+
<table border="1" style="border-collapse:collapse">
273+
<tr>
274+
<th style="min-width:100px;text-align:left">Property type</th>
275+
<th style="text-align:left">Payload example</th>
276+
</tr>
277+
<tr>
278+
<td>Boolean</td>
279+
<td><code>true/false</code></td>
280+
</tr>
281+
<tr>
282+
<td>Colored Light</td>
283+
<td><code>{<br>
284+
"hue": number,<br>
285+
"sat": number,<br>
286+
"bri": number,<br>
287+
"swi": bool on/off <br>
288+
}</code></td>
289+
</tr>
290+
</table>
291+
</dd>
269292
<dt>timestamp <span class="property-type">number</span></dt>
270293
<dd>the value timestamp.</dd>
271294
</dl>
@@ -314,6 +337,29 @@ <h3>Inputs</h3>
314337
<dl class="message-properties">
315338
<dt>payload<span class="property-type"></span></dt>
316339
<dd> the payload of the message that update the Arduino IoT Cloud property.</dd>
340+
<dd>The payload format type is the property type for primitive types. Instead, for multi-value property the payload is a JSON object according documented notation.</dd>
341+
<dd>Examples</dd>
342+
<dd>
343+
<table border="1" style="border-collapse:collapse">
344+
<tr>
345+
<th style="min-width:100px;text-align:left">Property type</th>
346+
<th style="text-align:left">Payload example</th>
347+
</tr>
348+
<tr>
349+
<td>Boolean</td>
350+
<td><code>true/false</code></td>
351+
</tr>
352+
<tr>
353+
<td>Colored Light</td>
354+
<td><code>{<br>
355+
"hue": number,<br>
356+
"sat": number,<br>
357+
"bri": number,<br>
358+
"swi": bool on/off <br>
359+
}</code></td>
360+
</tr>
361+
</table>
362+
</dd>
317363
</dl>
318364

319365
<h3>Details</h3>
@@ -377,6 +423,28 @@ <h3>Outputs</h3>
377423
<dd>the message topic.</dd>
378424
<dt>payload.data <span class="property-type">JSON</span></dt>
379425
<dd>array of elements <p><code>{x: value_timestamp, y: value}</code></p> </dd>
426+
<dd>The value format type is the property type for primitive types. Instead, for multi-value property the value is a JSON object according documented notation.</dd>
427+
<dd>Examples</dd>
428+
<dd>
429+
<table border="1" style="border-collapse:collapse">
430+
<tr>
431+
<th style="min-width:100px;text-align:left">Property type</th>
432+
<th style="text-align:left">Value example</th>
433+
</tr>
434+
<tr>
435+
<td>Boolean</td>
436+
<td><code>true/false</code></td>
437+
</tr>
438+
<tr>
439+
<td>Colored Light</td>
440+
<td><code>{<br>
441+
"hue": number,<br>
442+
"sat": number,<br>
443+
"bri": number,<br>
444+
"swi": bool on/off <br>
445+
}</code></td>
446+
</tr>
447+
</table>
380448
<dt>timestamp <span class="property-type">number</span></dt>
381449
<dd>the value timestamp.</dd>
382450
</dl>
@@ -440,6 +508,29 @@ <h3>Outputs</h3>
440508
<dd>the message topic.</dd>
441509
<dt>payload <span class="property-type"></span></dt>
442510
<dd>the property last value.</dd>
511+
<dd>The payload format type is the property type for primitive types. Instead, for multi-value property the payload is a JSON object according documented notation.</dd>
512+
<dd>Examples</dd>
513+
<dd>
514+
<table border="1" style="border-collapse:collapse">
515+
<tr>
516+
<th style="min-width:100px;text-align:left">Property type</th>
517+
<th style="text-align:left">Payload example</th>
518+
</tr>
519+
<tr>
520+
<td>Boolean</td>
521+
<td><code>true/false</code></td>
522+
</tr>
523+
<tr>
524+
<td>Colored Light</td>
525+
<td><code>{<br>
526+
"hue": number,<br>
527+
"sat": number,<br>
528+
"bri": number,<br>
529+
"swi": bool on/off <br>
530+
}</code></td>
531+
</tr>
532+
</table>
533+
</dd>
443534
<dt>timestamp <span class="property-type">number</span></dt>
444535
<dd>the value timestamp.</dd>
445536
</dl>
@@ -496,6 +587,29 @@ <h3>Outputs</h3>
496587
<dd>the message topic.</dd>
497588
<dt>payload <span class="property-type"></span></dt>
498589
<dd>the property last value.</dd>
590+
<dd>The payload format type is the property type for primitive types. Instead, for multi-value property the payload is a JSON object according documented notation.</dd>
591+
<dd>Examples</dd>
592+
<dd>
593+
<table border="1" style="border-collapse:collapse">
594+
<tr>
595+
<th style="min-width:100px;text-align:left">Property type</th>
596+
<th style="text-align:left">Payload example</th>
597+
</tr>
598+
<tr>
599+
<td>Boolean</td>
600+
<td><code>true/false</code></td>
601+
</tr>
602+
<tr>
603+
<td>Colored Light</td>
604+
<td><code>{<br>
605+
"hue": number,<br>
606+
"sat": number,<br>
607+
"bri": number,<br>
608+
"swi": bool on/off <br>
609+
}</code></td>
610+
</tr>
611+
</table>
612+
</dd>
499613
<dt>timestamp <span class="property-type">number</span></dt>
500614
<dd>the value timestamp.</dd>
501615
</dl>

0 commit comments

Comments
 (0)