update social nodes info style
This commit is contained in:
Dave Conway-Jones
parent
0880ad3987
commit
b6116abce3
|
|
@ -8,7 +8,7 @@ This node does **NOT** support private or "locked" dweets.
|
|||
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-dweetio
|
||||
|
||||
|
|
@ -16,28 +16,28 @@ Run the following command in the root directory of your Node-RED install
|
|||
Usage
|
||||
-----
|
||||
|
||||
###Output
|
||||
### Output
|
||||
|
||||
Sends the **msg.payload** to Dweet.io
|
||||
Sends the `msg.payload` to Dweet.io
|
||||
|
||||
|
||||
Optionally uses **msg.thing** to set the thing id, if not already set in the properties.
|
||||
Optionally uses `msg.thing` to set the thing id, if not already set in the properties.
|
||||
|
||||
You need to make the thing id unique - you are recommended to use a GUID.
|
||||
|
||||
###Input
|
||||
### Input
|
||||
|
||||
Listens for messages from Dweet.io
|
||||
|
||||
The thing id should be globally unique as they are all public - you are recommended to use a GUID.
|
||||
|
||||
The Thing ID is set into **msg.dweet**, and the timesamp into **msg.created**.
|
||||
The Thing ID is set into `msg.dweet`, and the timesamp into `msg.created`.
|
||||
|
||||
|
||||
For further info see the <a href="https://dweetio.io/" target="_new">Dweet.io website</a>
|
||||
|
||||
|
||||
###Sample Flow
|
||||
### Sample Flow
|
||||
|
||||
Cut the text below - then in Node-RED use Ctrl-I (Import) - Ctrl-V (Paste) to insert into your workspace.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-dweetio",
|
||||
"version" : "0.0.11",
|
||||
"version" : "0.0.12",
|
||||
"description" : "A Node-RED node to send and receive simple dweets",
|
||||
"dependencies" : {
|
||||
"node-dweetio" : "0.0.11"
|
||||
|
|
|
|||
|
|
@ -9,8 +9,7 @@ As of v0.10.8 you will need to install it from here if still required.
|
|||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install, usually
|
||||
this is ~/.node-red .
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-irc
|
||||
|
||||
|
|
@ -27,7 +26,7 @@ Usage
|
|||
|
||||
Provides two nodes - one to receive messages, and one to send.
|
||||
|
||||
###Input
|
||||
### Input
|
||||
|
||||
Connects to an IRC server to receive messages.</p>
|
||||
|
||||
|
|
@ -35,29 +34,30 @@ The **IRC Server** field needs to be configured to a valid server, and
|
|||
you must select a default channel to join. You may join multiple channels by
|
||||
comma separating a list - #chan1,#chan2,#etc.
|
||||
|
||||
Incoming messages will appear as **msg.payload** on the first output, while
|
||||
**msg.topic** will contain who it is from. **msg.to** contains either the name of the channel or PRIV in the case of a pm.
|
||||
Incoming messages will appear as `msg.payload` on the first output, while
|
||||
`msg.topic` will contain who it is from. `msg.to` contains either the name
|
||||
of the channel or PRIV in the case of a pm.
|
||||
|
||||
The second output provides a **msg.payload** that has any status messages such as joins, parts, kicks etc.
|
||||
The second output provides a `msg.payload` that has any status messages such as joins, parts, kicks etc.
|
||||
|
||||
The type of the status message is set as **msg.payload.type**. The possible status types are:
|
||||
The type of the status message is set as `msg.payload.type`. The possible status types are:
|
||||
|
||||
- **message** : message is sent into the channel
|
||||
- **pm** : private message to the bot
|
||||
- **join** : a user joined the channel (also triggered when the bot joins a channel)
|
||||
- **invite** : the bot is being invited to a channel
|
||||
- **part** : a user leaves a channel
|
||||
- **quit** : a user quits a channe
|
||||
- **kick** : a user is kicked from a channel
|
||||
- `message` : message is sent into the channel
|
||||
- `pm` : private message to the bot
|
||||
- `join` : a user joined the channel (also triggered when the bot joins a channel)
|
||||
- `invite` : the bot is being invited to a channel
|
||||
- `part` : a user leaves a channel
|
||||
- `quit` : a user quits a channe
|
||||
- `kick` : a user is kicked from a channel
|
||||
|
||||
|
||||
###Output
|
||||
### Output
|
||||
|
||||
Sends messages to a channel on an IRC server.
|
||||
|
||||
You can send just the **msg.payload**, or the complete **msg** object to the
|
||||
selected channel, or you can select to use **msg.topic** to send the
|
||||
**msg.payload** to a specific user (private message) or channel.
|
||||
You can send just the `msg.payload`, or the complete `msg` object to the
|
||||
selected channel, or you can select to use `msg.topic` to send the
|
||||
`msg.payload` to a specific user (private message) or channel.
|
||||
|
||||
If multiple output channels are listed (eg. #chan1,#chan2), then the message
|
||||
will be sent to all of them.
|
||||
|
|
@ -65,7 +65,7 @@ will be sent to all of them.
|
|||
**Note:** you can only send to channels you have previously joined so they
|
||||
MUST be specified in the node - even if you then decide to use a subset of them in msg.topic
|
||||
|
||||
You may send RAW commands using **msg.raw** - This must contain an array of
|
||||
You may send RAW commands using `msg.raw` - This must contain an array of
|
||||
parameters - eg.
|
||||
|
||||
["privmsg","#nodered","Hello world"]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-irc",
|
||||
"version" : "0.0.5",
|
||||
"version" : "0.0.7",
|
||||
"description" : "A Node-RED node to talk to an IRC server",
|
||||
"dependencies" : {
|
||||
"irc" : "~0.4.0"
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@
|
|||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="nma">
|
||||
<p>Uses NotifyMyAndroid (NMA) to push the <b>msg.payload</b> to an Android device that has NotifyMyAndroid app installed.</p>
|
||||
<p>Optionally uses <b>msg.topic</b> to set the title, if not already set in the properties.</p>
|
||||
<p>Uses NotifyMyAndroid (NMA) to push the <code>msg.payload</code> to an Android device that has NotifyMyAndroid app installed.</p>
|
||||
<p>Optionally uses <code>msg.topic</code> to set the title, if not already set in the properties.</p>
|
||||
<p>The API-key is stored in a separate credentials file.</p>
|
||||
<p>Uses Notify-My-Android. See <i><a href="http://www.notifymyandroid.com/" target="_new">this link</a></i> for more details.</p>
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send alerts vi
|
|||
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-nma
|
||||
|
||||
|
|
@ -14,9 +14,9 @@ Run the following command in the root directory of your Node-RED install
|
|||
Usage
|
||||
-----
|
||||
|
||||
Uses Notify-My-Android (NMA) to push the **msg.payload** to an Android device that has Notify-My-Android app installed.
|
||||
Uses Notify-My-Android (NMA) to push the `msg.payload` to an Android device that has Notify-My-Android app installed.
|
||||
|
||||
Optionally uses **msg.topic** to set the title, if not already set in the properties.
|
||||
Optionally uses `msg.topic` to set the title, if not already set in the properties.
|
||||
|
||||
The API-key is stored in a separate credentials file.
|
||||
|
||||
|
|
|
|||
|
|
@ -26,8 +26,8 @@
|
|||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="notify">
|
||||
<p>Uses Growl to provide a desktop popup containing the <b>msg.payload</b>. Only useful on the local machine.</p>
|
||||
<p>Optionally uses <b>msg.topic</b> as the title.</p>
|
||||
<p>Uses Growl to provide a desktop popup containing the <code>msg.payload</code>. Only useful on the local machine.</p>
|
||||
<p>Optionally uses <code>msg.topic</code> as the title.</p>
|
||||
<p>Uses Growl so should work cross platform but will need pre-reqs installed... see <i><a href="https://npmjs.org/package/growl" target="_new">this link.</a></i></p>
|
||||
<p>If installing on Windows you MUST read the install instructions ... especially the bit about adding growlnotify to your path... or it WILL NOT work.</p>
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Uses [Growl](http://growl.info//)
|
|||
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-notify
|
||||
|
||||
|
|
@ -21,6 +21,6 @@ If installing on Windows you MUST read the install instructions ... especially t
|
|||
Usage
|
||||
-----
|
||||
|
||||
Uses Growl to push the **msg.payload** to the local desktop.
|
||||
Uses Growl to push the `msg.payload` to the local desktop.
|
||||
|
||||
The title can be set by **msg.topic**.
|
||||
The title can be set by `msg.topic`.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-notify",
|
||||
"version" : "0.0.2",
|
||||
"version" : "0.0.3",
|
||||
"description" : "A Node-RED node to send local popup Notify alerts",
|
||||
"dependencies" : {
|
||||
"growl" : "1.8.1"
|
||||
|
|
|
|||
|
|
@ -39,9 +39,9 @@
|
|||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="prowl">
|
||||
<p>Uses Prowl to push the <b>msg.payload</b> to an Apple device that has the prowl app installed.</p>
|
||||
<p>Optionally uses <b>msg.topic</b> to set the title. You can also set <b>msg.priority</b> to confgure the urgency from -2 (low), through 0 (normal) to 2 (urgent).</p>
|
||||
<p>You may use <b>msg.url</b> to set a url to redirect the user to on receipt of the message.</p>
|
||||
<p>Uses Prowl to push the <code>msg.payload</code> to an Apple device that has the prowl app installed.</p>
|
||||
<p>Optionally uses <code>msg.topic</code> to set the title. You can also set <code>msg.priority</code> to confgure the urgency from -2 (low), through 0 (normal) to 2 (urgent).</p>
|
||||
<p>You may use <code>msg.url</code> to set a url to redirect the user to on receipt of the message.</p>
|
||||
<p>Uses Prowl. See <i><a href="https://www.prowlapp.com" target="_new">this link</a></i> for more details.</p>
|
||||
</script>
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send alerts vi
|
|||
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-prowl
|
||||
|
||||
|
|
@ -14,10 +14,10 @@ Run the following command in the root directory of your Node-RED install
|
|||
Usage
|
||||
-----
|
||||
|
||||
Uses Prowl to push the **msg.payload** to an Apple device that has the prowl app installed.
|
||||
Uses Prowl to push the `msg.payload` to an Apple device that has the prowl app installed.
|
||||
|
||||
Optionally uses **msg.topic** to set the title. You can also set **msg.priority** to confgure the urgency from -2 (low), through 0 (normal) to 2 (urgent).
|
||||
Optionally uses `msg.topic` to set the title. You can also set `msg.priority` to configure the urgency from -2 (low), through 0 (normal) to 2 (urgent).
|
||||
|
||||
You may use **msg.url** to set a url to redirect the user to on receipt of the message if you don't set one in the edit dialogue.
|
||||
You may use `msg.url` to set a url to redirect the user to on receipt of the message if you don't set one in the edit dialogue.
|
||||
|
||||
Uses Prowl. See <a href="https://www.prowlapp.com" target="_new">this link</a> for more details.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-prowl",
|
||||
"version" : "0.0.6",
|
||||
"version" : "0.0.7",
|
||||
"description" : "A Node-RED node to send alerts via Prowl",
|
||||
"dependencies" : {
|
||||
"node-prowl" : "0.1.7"
|
||||
|
|
|
|||
|
|
@ -6,30 +6,33 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send alerts vi
|
|||
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-pushbullet
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
### Pushbullet output node
|
||||
Uses PushBullet to push <code>msg.payload</code> to a device that has the PushBullet app installed.
|
||||
* Optionally uses <code>msg.topic</code> to set the title, if not already set in the properties.
|
||||
* Optionally uses <code>msg.pushtype</code> to set the type of the push, if not already set in the properties.
|
||||
* Optionally uses <code>msg.deviceid</code> to set the device ID, if not already set in the properties.
|
||||
|
||||
You can also push to any channels that you own either configured or via <code>msg.channel</code>.
|
||||
Uses PushBullet to push `msg.payload` to a device that has the PushBullet app installed.
|
||||
* Optionally uses `msg.topic` to set the title, if not already set in the properties.
|
||||
* Optionally uses `msg.pushtype` to set the type of the push, if not already set in the properties.
|
||||
* Optionally uses `msg.deviceid` to set the device ID, if not already set in the properties.
|
||||
|
||||
The node can also *dismiss* and *delete* any push and *update* items in a pushed list. In this case <code>msg.data.iden</code> must be set to a valid push id, if <code>msg</code> originates from the Pushbullet input node this value is already set.
|
||||
You can also push to any channels that you own either configured or via `msg.channel`.
|
||||
|
||||
The node can also *dismiss* and *delete* any push and *update* items in a pushed list. In this case `msg.data.iden` must be set to a valid push id, if `msg` originates from the Pushbullet input node this value is already set.
|
||||
|
||||
### Pushbullet input node
|
||||
Receives Pushbullets from all devices. Messages contain the following data:
|
||||
* <code>msg.pushtype</code>: type of message
|
||||
* <code>msg.topic</code>: topic information from the push
|
||||
* <code>msg.payload</code>: main content of the push
|
||||
* <code>msg.data</code>: original object from the pushbullet API containing e.g. sender, receiver and message ids.
|
||||
|
||||
Pushes of type <i>link</i> and <i>file</i> will also have <code>msg.message</code> containing the message associated with the push.
|
||||
Receives Pushbullets from all devices. Messages contain the following data:
|
||||
* `msg.pushtype`: type of message
|
||||
* `msg.topic`: topic information from the push
|
||||
* `msg.payload`: main content of the push
|
||||
* `msg.data`: original object from the pushbullet API containing e.g. sender, receiver and message ids.
|
||||
|
||||
Pushes of type <i>link</i> and <i>file</i> will also have `msg.message` containing the message associated with the push.
|
||||
|
||||
For further details of see <a href="https://docs.pushbullet.com/stream/">Pushbullet Stream API</a> and <a href="https://docs.pushbullet.com/v2/pushes/">Pushbullet Push API</a>.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-pushbullet",
|
||||
"version" : "0.0.8",
|
||||
"version" : "0.0.9",
|
||||
"description" : "A Node-RED node to send alerts via Pushbullet",
|
||||
"dependencies" : {
|
||||
"pushbullet": "1.4.*",
|
||||
|
|
|
|||
|
|
@ -11,23 +11,23 @@ You need a valid Pusher App key, secret and id from [http://pusher.com](http://p
|
|||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install. this is usually ~/.node-red
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-pusher
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
###Input
|
||||
### Input
|
||||
|
||||
Pusher input mode. Use this node to subscribe to a Pusher channel/event.
|
||||
You need a valid Pusher App key.
|
||||
|
||||
The node will set **msg.payload** to the message that arrives, and **msg.topic** to the eventname.
|
||||
The node will set `msg.payload` to the message that arrives, and `msg.topic` to the eventname.
|
||||
|
||||
###Output
|
||||
### Output
|
||||
|
||||
Pusher output node for sending messages to a specific channel/event.
|
||||
You need an App key, secret and ID of a Pusher app.
|
||||
|
||||
The node will send the **msg.payload** of the incoming message.
|
||||
The node will send the `msg.payload` of the incoming message.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-pusher",
|
||||
"version" : "0.0.3",
|
||||
"version" : "0.0.4",
|
||||
"description" : "A Node-RED node to send and receive messages using Pusher.com",
|
||||
"dependencies" : {
|
||||
"pusher": "1.0.5",
|
||||
|
|
|
|||
|
|
@ -101,8 +101,8 @@
|
|||
<script type="text/x-red" data-help-name="pusher out">
|
||||
<p>Pusher output node for sending messages to a specific channel/event.</p>
|
||||
<p>You need an App key, secret and ID of a Pusher app.</p>
|
||||
<p>The node will send the <b>msg.payload</b> of the incoming message.</p>
|
||||
<p>If you leave the eventname blank you can set it using <b>msg.topic</b>.</p>
|
||||
<p>The node will send the <code>msg.payload</code> of the incoming message.</p>
|
||||
<p>If you leave the eventname blank you can set it using <code>msg.topic</code>.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
|
|||
|
|
@ -68,16 +68,16 @@
|
|||
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
|
||||
<input type="text" id="node-input-name" placeholder="Name">
|
||||
</div>
|
||||
<div class="form-tips" id="node-tip">Tip: Leave title blank to set using <b>msg.topic</b>.<br/>
|
||||
Leave device blank to send to all devices, or to set using <b>msg.device</b>.<br/>
|
||||
Leave priority blank to set using <b>msg.priority</b>. Supports priorities 2, 1, 0, -1, and -2.<br/>
|
||||
Leave sound blank to use the default, or set using <b>msg.sound</b>.</div>
|
||||
<div class="form-tips" id="node-tip">Tip: Leave title blank to set using <code>msg.topic</code>.<br/>
|
||||
Leave device blank to send to all devices, or to set using <code>msg.device</code>.<br/>
|
||||
Leave priority blank to set using <code>msg.priority</code>. Supports priorities 2, 1, 0, -1, and -2.<br/>
|
||||
Leave sound blank to use the default, or set using <code>msg.sound</code>.</div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="pushover">
|
||||
<p>Uses Pushover to push the <b>msg.payload</b> to a device that has the Pushover app installed.</p>
|
||||
<p>Optionally uses <b>msg.topic</b> to set the title, <b>msg.device</b> to set the device, <b>msg.priority</b>
|
||||
to set the priority, and <b>msg.sound</b> to set a named sound, if not already set in the properties.</p>
|
||||
<p>Uses Pushover to push the <code>msg.payload</code> to a device that has the Pushover app installed.</p>
|
||||
<p>Optionally uses <code>msg.topic</code> to set the title, <code>msg.device</code> to set the device, <code>msg.priority</code>
|
||||
to set the priority, and <code>msg.sound</code> to set a named sound, if not already set in the properties.</p>
|
||||
<p>The User-key and API-token are stored in a separate credentials file.</p>
|
||||
<p>Uses Pushover. See <i><a href="https://pushover.net" target="_new">this link</a></i> for more details.</p>
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send alerts vi
|
|||
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-pushover
|
||||
|
||||
|
|
@ -14,10 +14,10 @@ Run the following command in the root directory of your Node-RED install
|
|||
Usage
|
||||
-----
|
||||
|
||||
Uses Pushover to push the <b>msg.payload</b> to a device that has the Pushover app installed.
|
||||
Uses Pushover to push the `msg.payload` to a device that has the Pushover app installed.
|
||||
|
||||
Optionally uses **msg.topic** to set the title, **msg.device** to set the device
|
||||
and **msg.priority** to set the priority, if not already set in the properties.
|
||||
Optionally uses `msg.topic` to set the title, `msg.device` to set the device
|
||||
and `msg.priority` to set the priority, if not already set in the properties.
|
||||
|
||||
The User-key and API-token are stored in a separate credentials file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-pushover",
|
||||
"version" : "0.0.6",
|
||||
"version" : "0.0.7",
|
||||
"description" : "A Node-RED node to send alerts via Pushover",
|
||||
"dependencies" : {
|
||||
"pushover-notifications" : "0.2.2"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to send SMS messa
|
|||
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-twilio
|
||||
|
||||
|
|
@ -16,10 +16,12 @@ Usage
|
|||
|
||||
Sends an SMS message or make a voice call using the Twilio service.
|
||||
|
||||
The Twilio out node is configured to send SMS or make call, depending on the option selected you enter the phone number or phone number and a URL to create the TWiML response file.
|
||||
The Twilio out node is configured to send SMS or make call, depending on the option selected you
|
||||
enter the phone number or phone number and a URL to create the TWiML response file.
|
||||
|
||||
<b>msg.payload</b> is used as the body of the message. The node can be configured with the number
|
||||
to send the message to. Alternatively, if the number is left blank, it can be set using <b>msg.topic</b>. The payload can also be the URL to create the TWiML response file.
|
||||
`msg.payload` is used as the body of the message. The node can be configured with the number
|
||||
to send the message to. Alternatively, if the number is left blank, it can be set using `msg.topic`.
|
||||
The payload can also be the URL to create the TWiML response file.
|
||||
|
||||
You must have an account with Twilio to use this node. You can register for one <a href="https://www.twilio.com/">here</a>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-twilio",
|
||||
"version" : "0.0.9",
|
||||
"version" : "0.0.10",
|
||||
"description" : "A Node-RED node to send SMS messages via the Twilio service.",
|
||||
"dependencies" : {
|
||||
"twilio" : "1.6.0"
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@
|
|||
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
|
||||
<input type="text" id="node-input-name" placeholder="Name">
|
||||
</div>
|
||||
<div class="form-tips">The <b>To</b> field is optional. If not set uses the <b>msg.topic</b> property of the message.</div>
|
||||
<div class="form-tips">The <b>To</b> field is optional. If not set uses the <code>msg.topic</code> property of the message.</div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="xmpp out">
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to talk to an XMP
|
|||
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-xmpp
|
||||
|
||||
|
|
@ -16,29 +16,30 @@ Usage
|
|||
|
||||
Provides two nodes - one to send messages, and one to receive.
|
||||
|
||||
###Receive
|
||||
### Receive
|
||||
|
||||
Connects to an XMPP server to receive messages.</p>
|
||||
|
||||
The <b>Buddy</b> field is the id of the buddy or room you want to receive messages from.
|
||||
The **Buddy** field is the id of the buddy or room you want to receive messages from.
|
||||
|
||||
Incoming messages will appear as <b>msg.payload</b> on the first output, while <b>msg.topic</b> will contain who it is from.
|
||||
Incoming messages will appear as `msg.payload` on the first output, while `msg.topic` will contain who it is from.
|
||||
|
||||
The second output will show the presence and status of a user in <b>msg.payload</b>. Again <b>msg.topic</b> will hold the user.
|
||||
The second output will show the presence and status of a user in `msg.payload`.
|
||||
Again `msg.topic` will hold the user.
|
||||
|
||||
###Send
|
||||
### Send
|
||||
|
||||
Connects to an XMPP server to send messages.
|
||||
|
||||
The <b>To</b> field is optional. If not set the <b>msg.topic</b> property of the message is used to set that value.
|
||||
The **To** field is optional. If not set the `msg.topic` property of the message is used to set that value.
|
||||
|
||||
If you are joining a chat room then the <b>To</b> field must be filled in with the room name.
|
||||
If you are joining a chat room then the **To** field must be filled in with the room name.
|
||||
|
||||
You may also send a msg with <b>msg.presence</b> to set your presence to one of
|
||||
You may also send a msg with `msg.presence` to set your presence to one of
|
||||
|
||||
1. chat
|
||||
2. away
|
||||
3. dnd
|
||||
4. xa
|
||||
|
||||
If you do so then the <b>msg.payload</b> is used to set your status message.</p>
|
||||
If you do this then the `msg.payload` is used to set your status message.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name" : "node-red-node-xmpp",
|
||||
"version" : "0.1.4",
|
||||
"version" : "0.1.5",
|
||||
"description" : "A Node-RED node to talk to an XMPP server",
|
||||
"dependencies" : {
|
||||
"simple-xmpp" : "1.3.*"
|
||||
|
|
|
|||
Loading…
Reference in New Issue