diff --git a/README.md b/README.md index 5f601a9..8191ae0 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,28 @@ npm install node-red-contrib-xiaomi-devices ## Usage -Below a screenshot of an example use of all nodes. +From the Xiaomi configurator screen add your different devices by selecting the type of device and a readable description. The readable discription is used on the different edit screen of the nodes to easily select the device you associate to the node. -![Xiaomi devices example in node-red](https://github.com/hrietman/node-red-contrib-xiaomi-devices/blob/master/xiaomi-devices-overview.png) +Tip: use the configurator from the side-panel (hamburger menu, configuration nodes) to manage your devices. Node-red doesn't update underlying edit screens if the configuration panel is opened / closed from the edit node screen. (If you do, you need to first close the edit node screen and reopen it by double-clicking the node you want to edit the properties for.) + +To receive/send json UDP messages from/to the gateway you need to enable the local LAN mode on the gateway. To receive the json UDP messages in node-red you need to add an udp-node with the correct configuration: + +``` +Listen for: multicast messages +Group: 224.0.0.50 +Local ip: +On port: 9898 ipv4 +Output: String +``` + +If you want to sent messages to the gateway you need to add an UDP sender, here an example configuration: + +``` +Send a: UDP message to port: 9898 +Address: ipv4 +``` +This configuration worked for me however I have seen people using different configuration to make UDP work. + +Here an example of how to use the different nodes. + +![Xiaomi devices example in node-red](https://raw.githubusercontent.com/hrietman/node-red-contrib-xiaomi-devices/master/xiaomi-devices-overview.png)