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

Info/Doc style updates to core/pi nodes

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:18:24 +00:00
parent 741c57e627
commit eff8327971
25 changed files with 78 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
social/email/README.md
View File

@@ -14,25 +14,24 @@ You will need valid email credentials for your email server.
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-email
npm i node-red-node-email
Usage
-----
Nodes to send and receive simple emails.
###Input
### Input
Repeatedly gets a **single email** from an IMAP server and forwards on as a msg if not already seen.
The subject is loaded into **msg.topic** and **msg.payload** is the plain text body.
If there is text/html then that is returned in **msg.html**. **msg.from** and
**msg.date** are also set if you need them.
The subject is loaded into `msg.topic` and `msg.payload` is the plain text body.
If there is text/html then that is returned in `msg.html`. `msg.from` and
`msg.date` are also set if you need them.
Additionally **msg.header** contains the complete header object including
Additionally `msg.header` contains the complete header object including
**to**, **cc** and other potentially useful properties.
**Note:** this node *only* gets the most recent single email from the inbox,
@@ -40,21 +39,21 @@ so set the repeat (polling) time appropriately.
Uses the *imap* npm module.
###Output
### Output
Sends the **msg.payload** as an email, with a subject of **msg.topic**.
Sends the `msg.payload` as an email, with a subject of `msg.topic`.
The default message recipient can be configured in the node, if it is left
blank it should be set using the **msg.to** property of the incoming message.
blank it should be set using the `msg.to` property of the incoming message.
The payload can be html format.
If the payload is a binary buffer then it will be converted to an attachment.
The filename should be set using **msg.filename**. Optionally
**msg.description** can be added for the body text.
The filename should be set using `msg.filename`. Optionally
`msg.description` can be added for the body text.
Alternatively you may provide **msg.attachments** which should contain an array of one or
Alternatively you may provide `msg.attachments` which should contain an array of one or
more attachments in <a href="https://www.npmjs.com/package/nodemailer#attachments" target="_new">nodemailer</a> format.
Uses the *nodemailer* npm module.

2
social/email/package.json
View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-email",
"version" : "0.1.2",
"version" : "0.1.3",
"description" : "Node-RED nodes to send and receive simple emails",
"dependencies" : {
"nodemailer" : "1.3.4",

10
social/feedparser/README.md
View File

@@ -3,23 +3,17 @@ node-red-node-feedparser
A <a href="http://nodered.org" target="_new">Node-RED</a> node to read RSS and Atom feeds.
**Note** : This is the same node as was in the core of Node-RED.
As of v0.10.8 it will be installed from here instead.
Install
-------
Run the following command in the user directory of your Node-RED install.
By default this is `.node-red`
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-feedparser
Usage
-----
Provides two nodes - one to receive messages, and one to send.
###Input
### Input
Monitors an RSS/atom feed for new entries.

2
social/feedparser/package.json
View File

@@ -1,6 +1,6 @@
{
"name": "node-red-node-feedparser",
"version": "0.1.4",
"version": "0.1.5",
"description": "A Node-RED node to get RSS Atom feeds.",
"dependencies": {
"feedparser": "1.1.3",

22
social/twitter/README.md
View File

@@ -7,14 +7,10 @@ The Twitter API will **NOT** deliver 100% of all tweets. This does **NOT** give
Tweets of who you follow will include their retweets and favourites.
**Note** : This is the same node as was in the core of Node-RED.
As of v0.10.8 it will be installed from here instead.
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-twitter
@@ -23,7 +19,7 @@ Usage
Provides two nodes - one to receive messages, and one to send.
###Input
### Input
Twitter input node. Can be used to search either:
@@ -33,11 +29,11 @@ Twitter input node. Can be used to search either:
Use **space** for *and*, and **comma** , for *or* when searching for multiple terms.
Sets the **msg.topic** to *tweets/* and then appends the senders screen name.
Sets the `msg.topic` to *tweets/* and then appends the senders screen name.
Sets **msg.location** to the tweeters location if known.
Sets `msg.location` to the tweeters location if known.
Sets **msg.tweet** to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
Sets `msg.tweet` to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
**Note:** when set to a specific user's tweets, or your direct messages, the node is subject to
Twitter's API rate limiting. If you deploy the flows multiple times within a 15 minute window, you may
@@ -45,14 +41,14 @@ exceed the limit and will see errors from the node. These errors will clear when
passes.
###Output
### Output
Tweets the **msg.payload**.
Tweets the `msg.payload`.
To send a Direct Message (DM) - use a payload like.
D {username} {message}
If **msg.media** exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
If `msg.media` exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
If **msg.params** exists and is an object of name:value pairs, this node will treat it as parameters for the update request.
If `msg.params` exists and is an object of name:value pairs, this node will treat it as parameters for the update request.

2
social/twitter/package.json
View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-twitter",
"version" : "0.1.5",
"version" : "0.1.6",
"description" : "A Node-RED node to talk to Twitter",
"dependencies" : {
"twitter-ng": "0.6.2",