1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/io/mdns/README.md

63 lines
2.0 KiB
Markdown
Raw Normal View History

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.
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
sudo apt-get install libavahi-compat-libdnssd-dev
2015-03-04 20:55:53 +01:00
Install
-------
2016-03-02 14:26:19 +01:00
Run the following command in your Node-RED user directory - typically `~/.node-red`
2015-03-04 20:55:53 +01:00
2016-03-02 14:26:19 +01:00
npm i node-red-node-discovery
2015-03-04 20:55:53 +01:00
Usage
-----
### Discovery
2016-03-02 14:26:19 +01:00
Uses an implementation of mdns to provide a Bonjour / Avahi
2015-03-04 20:55:53 +01:00
service discovery capability.
2016-03-02 14:26:19 +01:00
`msg.payload` contains the service object on both arrival and leaving.
2015-03-04 20:55:53 +01:00
2016-03-02 14:26:19 +01:00
`msg.state` contains boolean true or false depending if the service has arrived (true) or gone away (false)..
2015-03-04 20:55:53 +01:00
2016-03-02 14:26:19 +01:00
Within the `msg.payload` object the most interesting things are:
2015-03-04 20:55:53 +01:00
* 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).
2016-03-02 14:26:19 +01:00
### Announce
Provides a Bonjour / Avahi / Zeroconf announcement node.
2016-03-02 14:26:19 +01:00
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.
2016-03-02 14:26:19 +01:00
- `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
2016-03-02 14:26:19 +01:00
### Note:
2016-03-02 14:26:19 +01:00
When Node-RED starts you will get a big WARNING message about the Bonjour Compatibility layer... this is just a warning so don't worry.