2
0

Added info notes

This commit is contained in:
Harald Rietman
2017-07-03 17:44:05 +02:00
parent c518c83553
commit fc5270ad87
5 changed files with 174 additions and 5 deletions

View File

@@ -85,5 +85,47 @@
</script>
<script type="text/x-red" data-help-name="xiaomi-plug">
<p>A simple node that converts the message payloads into a ON or OFF message</p>
<p>The Xiaomi plug (zigbee) sensor node</p>
<p>This is the plug (socket) version which is attached to a Xiaomi gateway. The Wifi version is not yet supported.</p>
<p>To switch an output you need to specify the key of the gateway in the gateway configuration; without the key
no output can be switched. To retrieve the gateway key consult the Xiaomi Mi Home App.</p>
<p>On the input you can send <code>on</code> to switch the plug on. To turn it off just send <code>off</code></p>
<p>Output 1 reports the status, output 2 is the write command for the plug.</p>
<dl class="message-properties">
<dt class="mandatory">Gateway</dt>
<dd>The Gateway configuration node this sensor is attached.</dd>
<dt class="optional">Name</dt>
<dd>A descriptive name for this sensor.</dd>
<dt class="mandatory">Device</dt>
<dd>The device to associate this node with. This device is configured in the Gateway configuration.</dd>
<dt class="mandatory">Output</dt>
<dd>Three output types are supported:</dd>
<ul>
<li>Full data</li>
<li>Just values</li>
<li>Template</li>
</ul>
<dt class="mandatory">Full data</dt>
<dd>Passes the complete object received from the gateway. Use this if you need the raw data.</dd>
<dt class="mandatory">Just values</dt>
<dd>Only passes the values <code>on</code> or <code>off</code>.</dd>
<dt class="mandatory">Template</dt>
<dd>Use your own template to pass the values on. The template can contain <a href="http://mustache.github.io/mustache.5.html">mustache-style</a> tags.
Any property from the data section of the full object can be used.</dd>
</dl>
<p>Sample message:</p>
<p><pre>
{
cmd: "write_ack"
model: "plug"
sid: "158d00012f1fb5"
short_id: 47414
data: "{
"voltage":3600,
"status":"off",
"inuse":"0",
"power_consumed":"4000",
"load_power":"0"
}"
}</pre></p>
</script>