2015-03-04 20:55:53 +01:00
|
|
|
node-red-node-discover
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
A <a href="http://nodered.org" target="_new">Node-RED</a> node that uses Bonjour
|
|
|
|
|
/ Avahi to discover local network services such as iTunes libraries, printers, etc.
|
|
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
Now also supports announcing new services.
|
|
|
|
|
|
2015-03-04 20:55:53 +01:00
|
|
|
Prerequisites
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
please read the [install instructions](https://www.npmjs.com/package/mdns) for the underlying npm.
|
|
|
|
|
|
|
|
|
|
For Debian / Ubuntu this requires installing
|
|
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
sudo apt-get install libavahi-compat-libdnssd-dev
|
2015-03-04 20:55:53 +01:00
|
|
|
|
|
|
|
|
Install
|
|
|
|
|
-------
|
|
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
Run the following command in the root directory of your Node-RED install, usually `~/.node-red`
|
2015-03-04 20:55:53 +01:00
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
npm install node-red-node-discovery
|
2015-03-04 20:55:53 +01:00
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
### Discovery
|
|
|
|
|
|
|
|
|
|
Uses an implemetation of mdns to provide a Bonjour / Avahi
|
2015-03-04 20:55:53 +01:00
|
|
|
service discovery capability.
|
|
|
|
|
|
|
|
|
|
**msg.payload** contains the service object on both arrival and leaving.
|
|
|
|
|
|
|
|
|
|
**msg.state** contains boolean true or false depending if the service has arrived (true) or gone away (false)..
|
|
|
|
|
|
|
|
|
|
Within the msg.payload object the most interesting things are:
|
|
|
|
|
|
|
|
|
|
* msg.payload.name
|
|
|
|
|
* msg.payload.interface
|
|
|
|
|
* msg.payload.port
|
|
|
|
|
* msg.payload.addresses
|
|
|
|
|
* msg.payload.txtRecord
|
|
|
|
|
|
|
|
|
|
For a full list of official service types see [this list](http://www.dns-sd.org/ServiceTypes.html" target="_new).
|
|
|
|
|
|
2015-05-08 21:57:15 +02:00
|
|
|
###Announce
|
|
|
|
|
|
|
|
|
|
Provides a Bonjour / Avahi / Zeroconf announcement node.
|
|
|
|
|
|
|
|
|
|
If **msg.payload** is 0 - the announcement is stopped. Any other value starts the announcement process.
|
|
|
|
|
|
|
|
|
|
The announcement can be customised by the msg if not configured in the edit panel.
|
|
|
|
|
|
|
|
|
|
- **msg.service** - For a full list of official service types see <a href="http://www.dns-sd.org/ServiceTypes.html" target="_new">this list</a>.
|
|
|
|
|
- **msg.port** - the tcp or udp port to use.
|
|
|
|
|
- **msg.name** - the short description name of the service. If you use %h in the name, it will be replaced by the machine hostname.
|
|
|
|
|
- **msg.txtRecord** - a set of comma separated name:value pairs
|
|
|
|
|
|
|
|
|
|
###Note:
|
|
|
|
|
|
|
|
|
|
When Node-RED starts you will get a big WARNING message about the Bonjour compatability layer... this is just a warning so don't worry.
|
