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

update io nodes info style

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

View File

@ -31,11 +31,11 @@
<script type="text/x-red" data-help-name="emoncms"> <script type="text/x-red" data-help-name="emoncms">
<p>Posts data to Emoncms.</p> <p>Posts data to Emoncms.</p>
<p>The <b>msg.payload</b> can contain either a comma separated list of name <p>The <code>msg.payload</code> can contain either a comma separated list of name
value pairs e.g. <pre>name:value,...</pre> or a comma separated list of values e.g. <pre>1,2,...</pre> value pairs e.g. <pre>name:value,...</pre> or a comma separated list of values e.g. <pre>1,2,...</pre>
or a simple javascript object e.g. <pre>msg.payload = {temp:12}</pre> or a simple javascript object e.g. <pre>msg.payload = {temp:12}</pre>
<p>If <i>Node</i> is left blank <b>msg.nodegroup</b> will used.</p> <p>If <i>Node</i> is left blank <code>msg.nodegroup</code> will used.</p>
<p>Insertion time can be manipulated by setting <b>msg.time</b>. <p>Insertion time can be manipulated by setting <code>msg.time</code>.
This must be in epoch format - seconds since 1970.</p> This must be in epoch format - seconds since 1970.</p>
</script> </script>
@ -82,7 +82,7 @@
<script type="text/x-red" data-help-name="emoncms in"> <script type="text/x-red" data-help-name="emoncms in">
<p>Fetches data from emoncms.</p> <p>Fetches data from emoncms.</p>
<p>The <b>msg.payload</b> contains last emoncms feed value <p>The <code>msg.payload</code> contains last emoncms feed value
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send fetch/pos
Install Install
------- -------
Run the following command in the root directory of your Node-RED install Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-emoncms npm install node-red-node-emoncms

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-emoncms", "name" : "node-red-node-emoncms",
"version" : "0.0.9", "version" : "0.0.10",
"description" : "A Node-RED node to fetch/post data to/from emoncms", "description" : "A Node-RED node to fetch/post data to/from emoncms",
"dependencies" : { "dependencies" : {
}, },

View File

@ -18,23 +18,23 @@ For Debian / Ubuntu this requires installing
Install 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 Usage
----- -----
### Discovery ### Discovery
Uses an implemetation of mdns to provide a Bonjour / Avahi Uses an implementation of mdns to provide a Bonjour / Avahi
service discovery capability. 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.name
* msg.payload.interface * msg.payload.interface
@ -48,15 +48,15 @@ For a full list of official service types see [this list](http://www.dns-sd.org/
Provides a Bonjour / Avahi / Zeroconf announcement node. 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. 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.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.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.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.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.

View File

@ -32,8 +32,8 @@
<script type="text/x-red" data-help-name="discovery"> <script type="text/x-red" data-help-name="discovery">
<p>Provides a Bonjour / Avahi / Zeroconf discovery node.</p> <p>Provides a Bonjour / Avahi / Zeroconf discovery node.</p>
<p><b>msg.payload</b> contains the service object on both arrival and leaving.</p> <p><code>msg.payload</code> contains the service object on both arrival and leaving.</p>
<p><b>msg.state</b> contains boolean <i>true</i> or <i>false</i> depending <p><code>msg.state</code> contains boolean <i>true</i> or <i>false</i> depending
if the service has arrived (<i>true</i>) or gone away (<i>false</i>).</p> if the service has arrived (<i>true</i>) or gone away (<i>false</i>).</p>
<p>Within the msg.payload object the most interesting things are: <p>Within the msg.payload object the most interesting things are:
<ul><li>msg.payload.name</li> <ul><li>msg.payload.name</li>
@ -88,13 +88,13 @@
<script type="text/x-red" data-help-name="announce"> <script type="text/x-red" data-help-name="announce">
<p>Provides a Bonjour / Avahi / Zeroconf announcement node.</p> <p>Provides a Bonjour / Avahi / Zeroconf announcement node.</p>
<p>If <b>msg.payload</b> is 0 - the announcement is stopped. Any other value starts the announcement process.</p> <p>If <code>msg.payload</code> is 0 - the announcement is stopped. Any other value starts the announcement process.</p>
<p>The announcement can be customised by the msg if not configured in the edit panel.</p> <p>The announcement can be customised by the msg if not configured in the edit panel.</p>
<p><ul> <p><ul>
<li><b>msg.service</b> - For a full list of official service types see <i><a href="http://www.dns-sd.org/ServiceTypes.html" target="_new">this list</a></i>.</li> <li><code>msg.service</code> - For a full list of official service types see <i><a href="http://www.dns-sd.org/ServiceTypes.html" target="_new">this list</a></i>.</li>
<li><b>msg.port</b> - the tcp or udp port to use.</li> <li><code>msg.port</code> - the tcp or udp port to use.</li>
<li><b>msg.name</b> - the short description name of the service. If you use %h in the name, it will be replaced by the machine hostname.</li> <li><code>msg.name</code> - the short description name of the service. If you use %h in the name, it will be replaced by the machine hostname.</li>
<li><b>msg.txtRecord</b> - a javascript object of name:value pairs.</li> <li><code>msg.txtRecord</code> - a javascript object of name:value pairs.</li>
</ul></p> </ul></p>
</script> </script>

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-discovery", "name" : "node-red-node-discovery",
"version" : "0.0.11", "version" : "0.0.12",
"description" : "A Node-RED node that uses Bonjour / Avahi to discover nearby services.", "description" : "A Node-RED node that uses Bonjour / Avahi to discover nearby services.",
"dependencies" : { "dependencies" : {
"mdns" : "2.2.*" "mdns" : "2.2.*"

View File

@ -6,8 +6,6 @@ A [Node-RED](http://nodered.org) node to send/receive messages using [IBM MQ Lig
Install Install
------- -------
Run the following command in the root directory of your Node-RED install Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-mqlight npm install node-red-node-mqlight

View File

@ -36,9 +36,12 @@
<script type="text/x-red" data-help-name="mqlight in"> <script type="text/x-red" data-help-name="mqlight in">
<p>Provides an MQ Light receive client.</p> <p>Provides an MQ Light receive client.</p>
<p>Subscribes the client to a destination based on the supplied topic and (optional) share arguments.</p> <p>Subscribes the client to a destination based on the supplied topic and (optional) share arguments.</p>
<p>Topic can contain any character in the Unicode character set, with # representing a multilevel wildcard and + a single level wildcard as described <a href="https://developer.ibm.com/messaging/mq-light/wildcard-topicpatterns/">here</a>. <p>Topic can contain any character in the Unicode character set, with # representing a multilevel wildcard
<p>Share identifies a shared destination for which messages are anycast between connected subscribers. If left blank, it defaults to a private destination.</p> and + a single level wildcard as described <a href="https://developer.ibm.com/messaging/mq-light/wildcard-topicpatterns/">here</a>.
<p>Received messages will be sent on in <b>msg.payload</b> with their topic sent in <b>msg.topic</b> and the share, if specified, sent in <b>msg.share</b>.</p> <p>Share identifies a shared destination for which messages are anycast between connected subscribers.
If left blank, it defaults to a private destination.</p>
<p>Received messages will be sent on in <code>msg.payload</code> with their topic sent in <code>msg.topic</code>
and the share, if specified, sent in <code>msg.share</code>.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
@ -86,8 +89,10 @@
<script type="text/x-red" data-help-name="mqlight out"> <script type="text/x-red" data-help-name="mqlight out">
<p>Provides an MQ Light send client.</p> <p>Provides an MQ Light send client.</p>
<p>Sends the value passed in on <b>msg.payload</b> to the specified topic.</p> <p>Sends the value passed in on <code>msg.payload</code> to the specified topic.</p>
<p>The topic can be passed in on <b>msg.topic</b>, however the topic in the node must be blank for this to take effect. If the topic is set in the node <b>msg.topic</b> will be overridden.</p> <p>The topic can be passed in on <code>msg.topic</code>, however the topic in the node
must be blank for this to take effect. If the topic is set in the node <code>msg.topic</code>
will be overridden.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-mqlight", "name" : "node-red-node-mqlight",
"version" : "0.0.7", "version" : "0.0.8",
"description" : "A Node-RED node to send and receive message from IBM MQ Light", "description" : "A Node-RED node to send and receive message from IBM MQ Light",
"dependencies" : { "dependencies" : {
"mqlight" : "1.0.x" "mqlight" : "1.0.x"

View File

@ -7,8 +7,7 @@ fetch either individual oids, or a table oid from a SNMP enabled host.
Install Install
------- -------
Run the following command in the user directory of your Node-RED install. Run the following command in your Node-RED user directory - typically `~/.node-red`
( typically ~/.node-red )
npm install node-red-node-snmp npm install node-red-node-snmp
@ -21,8 +20,8 @@ SNMP oids fetcher. Can fetch a single or comma separated list of oids. Triggered
`msg.oid` may contain a comma separated list of oids to search for. (no spaces) `msg.oid` may contain a comma separated list of oids to search for. (no spaces)
The oids confgured in the edit config will override msg.oid. Leave blank if you The oids confgured in the edit config will override `msg.oid`. Leave blank if you
want to use msg.oid to provide input. want to use `msg.oid` to provide input.
Outputs `msg.payload` containing a table of objects, and the requested `msg.oid`. Outputs `msg.payload` containing a table of objects, and the requested `msg.oid`.
Values depends on the oids being requested. Values depends on the oids being requested.
@ -32,8 +31,8 @@ Values depends on the oids being requested.
Simple SNMP table oid fetcher. Triggered by any input. Simple SNMP table oid fetcher. Triggered by any input.
`msg.oid` may contain the oid of a single table to search for. `msg.oid` may contain the oid of a single table to search for.
The oid confgured in the edit config will override msg.oid. Leave blank if you The oid confgured in the edit config will override `msg.oid`. Leave blank if you
want to use msg.oid to provide input. want to use `msg.oid` to provide input.
Outputs `msg.payload` containing the table of objects, and the requested `msg.oid`. Outputs `msg.payload` containing the table of objects, and the requested `msg.oid`.
Values depends on the oids being requested. Values depends on the oids being requested.

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-snmp", "name" : "node-red-node-snmp",
"version" : "0.0.4", "version" : "0.0.5",
"description" : "A Node-RED node that looks for SNMP oids.", "description" : "A Node-RED node that looks for SNMP oids.",
"dependencies" : { "dependencies" : {
"net-snmp" : "1.1.13" "net-snmp" : "1.1.13"

View File

@ -31,10 +31,10 @@
<script type="text/x-red" data-help-name="stomp in"> <script type="text/x-red" data-help-name="stomp in">
<p>Connects to a server using the Stomp protocol to receive messages.</p> <p>Connects to a server using the Stomp protocol to receive messages.</p>
<p>If the message received is JSON <b>msg.payload</b> will be parsed into an <p>If the message received is JSON <code>msg.payload</code> will be parsed into an
object. If not it will be the raw data.</p> object. If not it will be the raw data.</p>
<p><b>msg.headers</b> contains any header information that was also delivered.</p> <p><code>msg.headers</code> contains any header information that was also delivered.</p>
<p><b>msg.topic</b> is set to the predefined subscription topic.</p> <p><code>msg.topic</code> is set to the predefined subscription topic.</p>
<p><b>Note</b>: While not a requirement of the Stomp protocol, if connecting to an ActiveMQ server, the destination should <p><b>Note</b>: While not a requirement of the Stomp protocol, if connecting to an ActiveMQ server, the destination should
begin with <i>"/queue/"</i> or with <i>"/topic/"</i>. See begin with <i>"/queue/"</i> or with <i>"/topic/"</i>. See
<a href="https://stomp.github.io/stomp-specification-1.0.html#frame-SEND" target="new">Stomp 1.0 spec</a> <a href="https://stomp.github.io/stomp-specification-1.0.html#frame-SEND" target="new">Stomp 1.0 spec</a>
@ -75,14 +75,15 @@
<label for="node-input-name" style="width: 110px;"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name" style="width: 110px;"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips">The <b>Destination</b> field is optional. If not set uses the <b>msg.topic</b> property of the message.</div> <div class="form-tips">The <b>Destination</b> field is optional. If not set uses the <code>msg.topic</code>
property of the message.</div>
</script> </script>
<script type="text/x-red" data-help-name="stomp out"> <script type="text/x-red" data-help-name="stomp out">
<p>Connects to an Stomp capable server to send messages.</p> <p>Connects to an Stomp capable server to send messages.</p>
<p>The <b>Destination</b> field is optional. If set it overrides the <b>msg.topic</b> <p>The <b>Destination</b> field is optional. If set it overrides the <code>msg.topic</code>
property of the message.</p> property of the message.</p>
<p><b>msg.headers</b></code>, if set, should be an object containing field/value <p><code>msg.headers</code></code>, if set, should be an object containing field/value
pairs to be added as request headers.</p> pairs to be added as request headers.</p>
<p><b>Note</b>: While not a requirement of the Stomp protocol, if connecting <p><b>Note</b>: While not a requirement of the Stomp protocol, if connecting
to an ActiveMQ server, the destination should to an ActiveMQ server, the destination should

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to publish and su
Install Install
------- -------
Run the following command in the root directory of your Node-RED install Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-stomp npm install node-red-node-stomp
@ -16,7 +16,7 @@ Usage
Connects to a Stomp capable server to send and receive messages. Connects to a Stomp capable server to send and receive messages.
The **destination** field is optional. If set it overrides the **msg.topic** The **destination** field is optional. If set it overrides the `msg.topic`
property of the message. property of the message.
As noted [here](https://github.com/easternbloc/node-stomp-client#queue-names), As noted [here](https://github.com/easternbloc/node-stomp-client#queue-names),

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-stomp", "name" : "node-red-node-stomp",
"version" : "0.0.8", "version" : "0.0.9",
"description" : "A Node-RED node to publish and subscribe to/from a Stomp server", "description" : "A Node-RED node to publish and subscribe to/from a Stomp server",
"dependencies" : { "dependencies" : {
"stomp-client" : "0.8.*" "stomp-client" : "0.8.*"

View File

@ -23,12 +23,12 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips">Tip: leave blank if you want to use <b>msg.mac</b> to dynamically set target mac address.</div> <div class="form-tips">Tip: leave blank if you want to use <code>msg.mac</code> to dynamically set target mac address.</div>
</script> </script>
<script type="text/x-red" data-help-name="wake on lan"> <script type="text/x-red" data-help-name="wake on lan">
<p>Sends a Wake-On-LAN magic packet to the mac address specified.</p> <p>Sends a Wake-On-LAN magic packet to the mac address specified.</p>
<p>You may instead set <b>msg.mac</b> to dynamically set the target device mac to wake up.</p> <p>You may instead set <code>msg.mac</code> to dynamically set the target device mac to wake up.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -5,10 +5,9 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send Wake-On-L
Install Install
------- -------
Run the following command in your Node-RED user directory - typically `~/.node-red`
Run the following command in the root directory of your Node-RED install npm i node-red-node-wol
npm install node-red-node-wol
Usage Usage
@ -16,4 +15,4 @@ Usage
Sends a Wake-On-LAN magic packet to the mac address specified. Sends a Wake-On-LAN magic packet to the mac address specified.
You may instead set **msg.mac** to dynamically set the target device mac to wake up. You may instead set `msg.mac` to dynamically set the target device mac to wake up.

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-wol", "name" : "node-red-node-wol",
"version" : "0.0.5", "version" : "0.0.6",
"description" : "A Node-RED node to send Wake-On-LAN (WOL) magic packets", "description" : "A Node-RED node to send Wake-On-LAN (WOL) magic packets",
"dependencies" : { "dependencies" : {
"wake_on_lan" : "0.0.4" "wake_on_lan" : "0.0.4"