Skip to content

Commit e4ab05d

Browse files
fabik111fabik111
committed
add nodes description
1 parent da9e6f5 commit e4ab05d

File tree

1 file changed

+132
-1
lines changed

1 file changed

+132
-1
lines changed

‎arduino-cloud.html‎

Lines changed: 132 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,35 @@
257257
</script>
258258
<script type="text/x-red" data-help-name="property in">
259259
<p>This node injects in the flow the changed value of a specific Arduino IoT Cloud property.</p>
260+
261+
<h3>Outputs</h3>
262+
263+
264+
<dl class="message-properties">
265+
<dt>topic <span class="property-type">string</span></dt>
266+
<dd>the message topic.</dd>
267+
<dt>payload <span class="property-type"></span></dt>
268+
<dd>the property last value.</dd>
269+
<dt>timestamp <span class="property-type">number</span></dt>
270+
<dd>the value timestamp.</dd>
271+
</dl>
272+
273+
274+
275+
276+
<h3>Details</h3>
277+
<h4>Node Properties</h4>
278+
<code>Connection</code>
279+
<p>This property allow to set up a connection to Arduino Cloud.</p>
280+
<p>Get Client ID and Client Secret from Arduino Cloud and create or select a connection.</p>
281+
<code>Thing</code>
282+
<p>Choose an Arduino Thing.</p>
283+
<code>Property</code>
284+
<p>Choose a property of the selected Arduino Thing.</p>
285+
<code>Name</code>
286+
<p>Insert a node name. Default is the Arduino Property name.</p>
287+
288+
260289
</script>
261290

262291
<script type="text/x-red" data-template-name="property out">
@@ -281,6 +310,23 @@
281310
</script>
282311
<script type="text/x-red" data-help-name="property out">
283312
<p>This node update a specific Arduino IoT Cloud property with the value received in input</p>
313+
<h3>Inputs</h3>
314+
<dl class="message-properties">
315+
<dt>payload<span class="property-type"></span></dt>
316+
<dd> the payload of the message that update the Arduino IoT Cloud property.</dd>
317+
</dl>
318+
319+
<h3>Details</h3>
320+
<h4>Node Properties</h4>
321+
<code>Connection</code>
322+
<p>This property allow to set up a connection to Arduino Cloud.</p>
323+
<p>Get Client ID and Client Secret from Arduino Cloud and create or select a connection.</p>
324+
<code>Thing</code>
325+
<p>Choose an Arduino Thing.</p>
326+
<code>Property</code>
327+
<p>Choose a property of the selected Arduino Thing.</p>
328+
<code>Name</code>
329+
<p>Insert a node name. Default is the Arduino Property name.</p>
284330
</script>
285331

286332
<script type="text/x-red" data-template-name="property in hist">
@@ -319,6 +365,37 @@
319365
</script>
320366
<script type="text/x-red" data-help-name="property in hist">
321367
<p>This node injects in the flow a set of values of an Arduino Cloud Property based on the node configuration.</p>
368+
<h3>Inputs</h3>
369+
<dl class="message-properties">
370+
Any input message triggers a request to get the set of values.
371+
</dl>
372+
373+
<h3>Outputs</h3>
374+
375+
<dl class="message-properties">
376+
<dt>topic <span class="property-type">string</span></dt>
377+
<dd>the message topic.</dd>
378+
<dt>payload.data <span class="property-type">JSON</span></dt>
379+
<dd>array of elements <p><code>{x: value_timestamp, y: value}</code></p> </dd>
380+
<dt>timestamp <span class="property-type">number</span></dt>
381+
<dd>the value timestamp.</dd>
382+
</dl>
383+
384+
385+
<h3>Details</h3>
386+
<h4>Node Properties</h4>
387+
<code>Connection</code>
388+
<p>This property allow to set up a connection to Arduino Cloud.</p>
389+
<p>Get Client ID and Client Secret from Arduino Cloud and create or select a connection.</p>
390+
<code>Thing</code>
391+
<p>Choose an Arduino Thing.</p>
392+
<code>Property</code>
393+
<p>Choose a property of the selected Arduino Thing.</p>
394+
<code>Time filter</code>
395+
<p>Insert the desired period.</p>
396+
<code>Name</code>
397+
<p>Insert a node name. Default is the Arduino Property name.</p>
398+
322399
</script>
323400

324401
<script type="text/x-red" data-template-name="property in poll">
@@ -356,6 +433,31 @@
356433
</script>
357434
<script type="text/x-red" data-help-name="property in poll">
358435
<p>This node injects in the flow the value of an Arduino Cloud Property with a periodicity based on the node configuration.</p>
436+
<h3>Outputs</h3>
437+
438+
<dl class="message-properties">
439+
<dt>topic <span class="property-type">string</span></dt>
440+
<dd>the message topic.</dd>
441+
<dt>payload <span class="property-type"></span></dt>
442+
<dd>the property last value.</dd>
443+
<dt>timestamp <span class="property-type">number</span></dt>
444+
<dd>the value timestamp.</dd>
445+
</dl>
446+
447+
448+
<h3>Details</h3>
449+
<h4>Node Properties</h4>
450+
<code>Connection</code>
451+
<p>This property allow to set up a connection to Arduino Cloud.</p>
452+
<p>Get Client ID and Client Secret from Arduino Cloud and create or select a connection.</p>
453+
<code>Thing</code>
454+
<p>Choose an Arduino Thing.</p>
455+
<code>Property</code>
456+
<p>Choose a property of the selected Arduino Thing.</p>
457+
<code>Poll Every</code>
458+
<p>Insert the polling period.</p>
459+
<code>Name</code>
460+
<p>Insert a node name. Default is the Arduino Property name.</p>
359461
</script>
360462

361463

@@ -380,5 +482,34 @@
380482
</div>
381483
</script>
382484
<script type="text/x-red" data-help-name="property in push">
383-
<p>This node injects in the flow the value of an Arduino Cloud Property after receiving an input event.</p>
485+
<p>This node injects in the flow the value of an Arduino IoT Cloud Property after receiving an input event.</p>
486+
487+
<h3>Inputs</h3>
488+
<dl class="message-properties">
489+
Any input message triggers a request to get the property last value.
490+
</dl>
491+
492+
<h3>Outputs</h3>
493+
494+
<dl class="message-properties">
495+
<dt>topic <span class="property-type">string</span></dt>
496+
<dd>the message topic.</dd>
497+
<dt>payload <span class="property-type"></span></dt>
498+
<dd>the property last value.</dd>
499+
<dt>timestamp <span class="property-type">number</span></dt>
500+
<dd>the value timestamp.</dd>
501+
</dl>
502+
503+
504+
<h3>Details</h3>
505+
<h4>Node Properties</h4>
506+
<code>Connection</code>
507+
<p>This property allow to set up a connection to Arduino Cloud.</p>
508+
<p>Get Client ID and Client Secret from Arduino Cloud and create or select a connection.</p>
509+
<code>Thing</code>
510+
<p>Choose an Arduino Thing.</p>
511+
<code>Property</code>
512+
<p>Choose a property of the selected Arduino Thing.</p>
513+
<code>Name</code>
514+
<p>Insert a node name. Default is the Arduino Property name.</p>
384515
</script>

0 commit comments

Comments
 (0)