frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2025-03-01 10:37:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

update io nodes info style

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:26:19 +00:00
parent 81c532fdce
commit 0880ad3987
17 changed files with 64 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
io/mdns/README.md
View File

@@ -18,23 +18,23 @@ For Debian / Ubuntu this requires installing
Install
-------
Run the following command in the root directory of your Node-RED install, usually `~/.node-red`
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-discovery
npm i node-red-node-discovery
Usage
-----
### Discovery
Uses an implemetation of mdns to provide a Bonjour / Avahi
Uses an implementation of mdns to provide a Bonjour / Avahi
service discovery capability.
**msg.payload** contains the service object on both arrival and leaving.
`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)..
`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:
Within the `msg.payload` object the most interesting things are:
* msg.payload.name
* msg.payload.interface
@@ -44,19 +44,19 @@ Within the msg.payload object the most interesting things are:
For a full list of official service types see [this list](http://www.dns-sd.org/ServiceTypes.html" target="_new).
###Announce
### Announce
Provides a Bonjour / Avahi / Zeroconf announcement node.
If **msg.payload** is 0 - the announcement is stopped. Any other value starts the announcement process.
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
- `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:
### 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.
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.