Skip to content

Commit

Permalink
Update nodes documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
datech committed Jan 13, 2019
1 parent da71618 commit 02bdbf5
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 2 deletions.
83 changes: 82 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,59 @@
</script>

<script type="text/x-red" data-help-name="amazon-echo-hub">
<p>Amazon Echo Hub</p>
<p>Amazon Echo Hub</p>

<h3>Inputs</h3>
Enable input to allow input payload signals
<dl class="message-properties">
<dt>payload
<span class="property-type">string | buffer</span>
</dt>
<dd> the payload of the message to publish</dd>

<dt>payload.nodeid <span class="property-type">string</span></dt>
<dd>Node ID is Amazon Echo Device Node ID</dd>

<dt>payload.on <span class="property-type">string</span></dt>
<dd>on/off state of the light</dd>

<dt>payload.bri <span class="property-type">number</span></dt>
<dd>Brightness of the light (min 1, max 254)</dd>

<dt>payload.hue <span class="property-type">number</span></dt>
<dd>Hue of the light (min 0, max 65535)</dd>

<dt>payload.sat <span class="property-type">number</span></dt>
<dd>Saturation of the light (min 0, max 65535)</dd>

<dt>payload.ct <span class="property-type">string</span></dt>
<dd>The mired color temperature of the light (min 153, max 500)</dd>
</dl>

<h3>Outputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">string</span></dt>
<dd>On state of the light (On - true, Off - false)</dd>

<dt>on <span class="property-type">boolean</span></dt>
<dd>On/Off state of the light</dd>

<dt>bri <span class="property-type">number</span></dt>
<dd>Brightness of the light (min 1, max 254)</dd>

<dt>hue <span class="property-type">number</span></dt>
<dd>Hue of the light (min 0, max 65535)</dd>

<dt>sat <span class="property-type">number</span></dt>
<dd>Saturation of the light (min 0, max 65535)</dd>

<dt>ct <span class="property-type">string</span></dt>
<dd>The mired color temperature of the light (min 153, max 500)</dd>

<dt>colormode <span class="property-type">string</span></dt>
<dd>Indicates the color mode (cr - Color Temperature | hs - Hue and Saturation)</dd>

</dl>
</script>


Expand Down Expand Up @@ -73,3 +125,32 @@
<input type="text" id="node-input-topic">
</div>
</script>

<script type="text/x-red" data-help-name="amazon-echo-device">
<p>Amazon Echo Device</p>

<h3>Outputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">string</span></dt>
<dd>On state of the light (On - true, Off - false)</dd>

<dt>on <span class="property-type">boolean</span></dt>
<dd>On/Off state of the light</dd>

<dt>bri <span class="property-type">number</span></dt>
<dd>Brightness of the light (min 1, max 254)</dd>

<dt>hue <span class="property-type">number</span></dt>
<dd>Hue of the light (min 0, max 65535)</dd>

<dt>sat <span class="property-type">number</span></dt>
<dd>Saturation of the light (min 0, max 65535)</dd>

<dt>ct <span class="property-type">string</span></dt>
<dd>The mired color temperature of the light (min 153, max 500)</dd>

<dt>colormode <span class="property-type">string</span></dt>
<dd>Indicates the color mode (cr - Color Temperature | hs - Hue and Saturation)</dd>

</dl>
</script>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"dependencies": {
"ip": "^1.1.5",
"node-persist": "^3.0.2",
"peer-ssdp": "0.0.5",
"peer-ssdp": "^0.0.5",
"stoppable": "^1.0.4",
"mustache": "^3.0.1",
"express": "^4.16.4",
Expand Down

0 comments on commit 02bdbf5

Please sign in to comment.