From fc5270ad87561a131374ed822d0ffb972ca9d68d Mon Sep 17 00:00:00 2001
From: Harald Rietman <h.rietman@portofrotterdam.com>
Date: Mon, 3 Jul 2017 17:44:05 +0200
Subject: [PATCH] Added info notes

---
 .../xiaomi-configurator.html                  | 22 +++++++++-
 node-red-contrib-xiaomi-ht/xiaomi-ht.html     | 38 +++++++++++++++-
 .../xiaomi-magnet.html                        | 38 +++++++++++++++-
 .../xiaomi-motion.html                        | 37 +++++++++++++++-
 .../xiaomi-socket.html                        | 44 ++++++++++++++++++-
 5 files changed, 174 insertions(+), 5 deletions(-)

diff --git a/node-red-contrib-xiaomi-configurator/xiaomi-configurator.html b/node-red-contrib-xiaomi-configurator/xiaomi-configurator.html
index b5775a8..c0bdbd8 100644
--- a/node-red-contrib-xiaomi-configurator/xiaomi-configurator.html
+++ b/node-red-contrib-xiaomi-configurator/xiaomi-configurator.html
@@ -94,5 +94,25 @@
 </script>
 
 <script type="text/x-red" data-help-name="xiaomi-configurator">
-    <p>Configuration node for a xiaomi gateway device</p>
+    <p>Device configuration for Xiaomi nodes.</p>
+    <h3>Details</h3>
+    <p>This configuration node is used by the Xiaomi device nodes. Here you can add
+    devices with their device-id (SID), type and a description.</p>
+    <p>At the moment the following devices are supported:
+    <lu>
+        <li>Humidity & Temperature sensor [sensor ht]</li>
+        <li>Body motion sensor [motion]</li>
+        <li>Magnet contact sensor [contact]</li>
+        <li>Wall socket plug (zigbee) [plug]</li>
+        <li>Push button [switch]</li>
+    </lu>
+    </p>
+    <p>To be able to receive messages from the Xiaomi gateway, you need to set the gateway
+    in developer mode. Once in developer mode, the gateway sends JSON messages over the network as
+    UDP packages. On the internet their are a lot of guides on how to put the gateway in developer mode.</p>
+    <p>If you want to use the wall sockets, you need to set the key from the gateway. The key can be
+    retrieved via the Xiaomi Home App when in developer mode. Enter the key here and it is used
+    together with the token from the gateway's heartbeat message to recalculate the key to switch
+    the plug. If you do not specify a key, the plug-node can not be used.</p>
+
 </script>
diff --git a/node-red-contrib-xiaomi-ht/xiaomi-ht.html b/node-red-contrib-xiaomi-ht/xiaomi-ht.html
index d26bb1c..903b1ed 100644
--- a/node-red-contrib-xiaomi-ht/xiaomi-ht.html
+++ b/node-red-contrib-xiaomi-ht/xiaomi-ht.html
@@ -92,6 +92,42 @@
 </script>
 
 <script type="text/x-red" data-help-name="xiaomi-ht">
-    <p>A simple node that converts the message payloads into a temperature and a humidity message for the MQTT homebridge plugin</p>
+    <p>The Xiaomi Humidity & Temperature sensor node</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 for humidity and temperature.</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: "read_ack"
+        model: "sensor_ht"
+        sid: "158d00010b7f1b"
+        short_id: 8451
+        data: "{
+                    "voltage":3005,
+                    "temperature":"2325",
+                    "humidity":"5699"
+               }"
+    }</pre></p>
 
 </script>
diff --git a/node-red-contrib-xiaomi-magnet/xiaomi-magnet.html b/node-red-contrib-xiaomi-magnet/xiaomi-magnet.html
index 9242afa..2fc62ba 100644
--- a/node-red-contrib-xiaomi-magnet/xiaomi-magnet.html
+++ b/node-red-contrib-xiaomi-magnet/xiaomi-magnet.html
@@ -85,5 +85,41 @@
 </script>
 
 <script type="text/x-red" data-help-name="xiaomi-magnet">
-    <p>A simple node that converts the message payloads into a ON or OFF message</p>
+    <p>The Xiaomi contact sensor node</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>open</code> or <code>close</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: "read_ack"
+        model: "magnet"
+        sid: "158d000112fb5d"
+        short_id: 50301
+        data: "{
+                    "voltage":3015,
+                    "status":"close"
+               }"
+    }</pre></p>
+
 </script>
diff --git a/node-red-contrib-xiaomi-motion/xiaomi-motion.html b/node-red-contrib-xiaomi-motion/xiaomi-motion.html
index ae3279b..f62732b 100644
--- a/node-red-contrib-xiaomi-motion/xiaomi-motion.html
+++ b/node-red-contrib-xiaomi-motion/xiaomi-motion.html
@@ -85,5 +85,40 @@
 </script>
 
 <script type="text/x-red" data-help-name="xiaomi-motion">
-    <p>A simple node that converts the message payloads into a message</p>
+    <p>The Xiaomi body motion sensor node</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>motion</code> or <code>no_motion</code>. In case of <code>no_motion</code> also the duration is passed on the second output.</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: "read_ack"
+        model: "motion"
+        sid: "158d00015ef56c"
+        short_id: 21672
+        data: "{
+                    "voltage":3035,
+                    "status":"motion"
+               }"
+    }</pre></p>
 </script>
diff --git a/node-red-contrib-xiaomi-socket/xiaomi-socket.html b/node-red-contrib-xiaomi-socket/xiaomi-socket.html
index 1ef8cf6..543d3e0 100644
--- a/node-red-contrib-xiaomi-socket/xiaomi-socket.html
+++ b/node-red-contrib-xiaomi-socket/xiaomi-socket.html
@@ -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>