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 social nodes info style

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:26:53 +00:00
parent 0880ad3987
commit b6116abce3
25 changed files with 104 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
social/pushbullet/README.md
View File

@@ -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>.