diff --git a/social/dweetio/README.md b/social/dweetio/README.md index 657803a5..92a25e19 100644 --- a/social/dweetio/README.md +++ b/social/dweetio/README.md @@ -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 Dweet.io website -###Sample Flow +### Sample Flow Cut the text below - then in Node-RED use Ctrl-I (Import) - Ctrl-V (Paste) to insert into your workspace. diff --git a/social/dweetio/package.json b/social/dweetio/package.json index 96cd6e35..025fae7b 100644 --- a/social/dweetio/package.json +++ b/social/dweetio/package.json @@ -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" diff --git a/social/irc/README.md b/social/irc/README.md index c30ea484..c50969af 100644 --- a/social/irc/README.md +++ b/social/irc/README.md @@ -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.

@@ -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"] diff --git a/social/irc/package.json b/social/irc/package.json index b8d02b53..22a7ec97 100644 --- a/social/irc/package.json +++ b/social/irc/package.json @@ -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" diff --git a/social/nma/57-nma.html b/social/nma/57-nma.html index fd828cf6..d22b3693 100644 --- a/social/nma/57-nma.html +++ b/social/nma/57-nma.html @@ -31,8 +31,8 @@ diff --git a/social/nma/README.md b/social/nma/README.md index 2ae013cf..69ee9a3d 100644 --- a/social/nma/README.md +++ b/social/nma/README.md @@ -6,7 +6,7 @@ A Node-RED 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. diff --git a/social/notify/57-notify.html b/social/notify/57-notify.html index 96859100..d4766eeb 100644 --- a/social/notify/57-notify.html +++ b/social/notify/57-notify.html @@ -26,8 +26,8 @@ diff --git a/social/notify/README.md b/social/notify/README.md index dc41b9f3..400fe613 100644 --- a/social/notify/README.md +++ b/social/notify/README.md @@ -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`. diff --git a/social/notify/package.json b/social/notify/package.json index 6fd5229e..e15769cd 100644 --- a/social/notify/package.json +++ b/social/notify/package.json @@ -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" diff --git a/social/prowl/57-prowl.html b/social/prowl/57-prowl.html index 28b836bd..cd0d9f70 100644 --- a/social/prowl/57-prowl.html +++ b/social/prowl/57-prowl.html @@ -39,9 +39,9 @@ diff --git a/social/prowl/README.md b/social/prowl/README.md index 22136432..42d1e1bd 100644 --- a/social/prowl/README.md +++ b/social/prowl/README.md @@ -6,7 +6,7 @@ A Node-RED 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 this link for more details. diff --git a/social/prowl/package.json b/social/prowl/package.json index 1726a9c0..0fd1a655 100644 --- a/social/prowl/package.json +++ b/social/prowl/package.json @@ -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" diff --git a/social/pushbullet/README.md b/social/pushbullet/README.md index 481dd66e..83e60c28 100644 --- a/social/pushbullet/README.md +++ b/social/pushbullet/README.md @@ -6,30 +6,33 @@ A Node-RED 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 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. -You can also push to any channels that you own either configured or via msg.channel. +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 msg.data.iden must be set to a valid push id, if msg 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: -* 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 link and file will also have msg.message 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 link and file will also have `msg.message` containing the message associated with the push. For further details of see Pushbullet Stream API and Pushbullet Push API. diff --git a/social/pushbullet/package.json b/social/pushbullet/package.json index fcbc504d..90b280f6 100644 --- a/social/pushbullet/package.json +++ b/social/pushbullet/package.json @@ -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.*", diff --git a/social/pusher/README.md b/social/pusher/README.md index b413511c..507fb84b 100644 --- a/social/pusher/README.md +++ b/social/pusher/README.md @@ -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. diff --git a/social/pusher/package.json b/social/pusher/package.json index 529cfd20..9e1418b2 100644 --- a/social/pusher/package.json +++ b/social/pusher/package.json @@ -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", diff --git a/social/pusher/pusher.html b/social/pusher/pusher.html index 280ac9ea..032e9f1d 100644 --- a/social/pusher/pusher.html +++ b/social/pusher/pusher.html @@ -101,8 +101,8 @@ diff --git a/social/pushover/README.md b/social/pushover/README.md index b8b6cd94..837901e5 100644 --- a/social/pushover/README.md +++ b/social/pushover/README.md @@ -6,7 +6,7 @@ A Node-RED 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 msg.payload 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. diff --git a/social/pushover/package.json b/social/pushover/package.json index 0ea45021..77b24c6d 100644 --- a/social/pushover/package.json +++ b/social/pushover/package.json @@ -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" diff --git a/social/twilio/README.md b/social/twilio/README.md index 3e7b315a..8d66d85e 100644 --- a/social/twilio/README.md +++ b/social/twilio/README.md @@ -6,7 +6,7 @@ A Node-RED 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. -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. +`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 here. diff --git a/social/twilio/package.json b/social/twilio/package.json index 6cb20172..07125b90 100644 --- a/social/twilio/package.json +++ b/social/twilio/package.json @@ -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" diff --git a/social/xmpp/92-xmpp.html b/social/xmpp/92-xmpp.html index 2c5e5e84..88d9d319 100644 --- a/social/xmpp/92-xmpp.html +++ b/social/xmpp/92-xmpp.html @@ -86,7 +86,7 @@ -
The To field is optional. If not set uses the msg.topic property of the message.
+
The To field is optional. If not set uses the msg.topic property of the message.