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

35 lines
1.4 KiB
Markdown

node-red-node-pushover
======================
A <a href="http://nodered.org" target="_new">Node-RED</a> node to send alerts via <a href="http://www.pushover.net/" target="_new">Pushover</a>.
Install
-------
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-pushover
Usage
-----
Uses Pushover to push the `msg.payload` to a device that has the Pushover app installed.
Optionally uses `msg.topic` to set the configuration, if not already set in the properties:
- `msg.device`: to set the device
- `msg.priority`: to set the priority
- `msg.topic`: to set the title
- `msg.attachment`: to specify an image to attach to message (path as a string or Buffer containing image)
- `msg.url`: to add a web address
- `msg.url_title`: to add a url title
- `msg.html`: set to true or 1 if message is HTML formatted, see the [supported tags](https://pushover.net/api#html)
- `msg.sound`: to set the alert sound, see the [available options](https://pushover.net/api#sounds)
- `msg.retry`: to set retry interval for Emergency priority (2) messages, see [priority](https://pushover.net/api#priority)
- `msg.expire`: to set retry duration for Emergency priority (2) messages, see [priority](https://pushover.net/api#priority)
The User-key and API-token are stored in a separate credentials file.
Uses Pushover. See <a href="https://pushover.net" target="_new">Pushover.net</a> for more details.