frodovdr
/
node-red-nodes
mirror of https://github.com/node-red/node-red-nodes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Add serialport request node to readme (docs only)

This commit is contained in:
Dave Conway-Jones 2019-03-06 17:45:45 +00:00
parent 8f5c8c2ad8
commit b91f61d56f
No known key found for this signature in database
GPG Key ID: 9E7F9C73F5168CD4
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
io/serialport/README.md
View File

@ -2,13 +2,11 @@ node-red-node-serialport
========================
<a href="http://nodered.org" target="noderedinfo">Node-RED</a> nodes to talk to
hardware Serial ports.
hardware serial ports.
## Install
This node is sometimes installed by default in Node-RED so may not need to be installed manually.
Run the following command in your Node-RED user directory (typically `~/.node-red`):
To install the stable version use the `Menu - Manage palette` option and search for node-red-node-serialport, or run the following command in your Node-RED user directory, typically `~/.node-red`
npm i node-red-node-serialport
@ -20,7 +18,7 @@ you to install the full set of tools in order to compile the underlying package.
## Usage
Provides two nodes - one to receive messages, and one to send.
Provides three nodes - one to receive messages, and one to send, and a request node which can send then wait for a response.
### Input
@ -47,3 +45,13 @@ Provides a connection to an outbound serial port.
Only the `msg.payload` is sent.
Optionally the character used to split the input can be appended to every message sent out to the serial port.
### Request
Provides a connection to a request/response serial port.
This node behaves as a tightly coupled combination of serial in and serial out nodes, with which it shares the configuration.
Send the request message in `msg.payload` as you would do with a serial out node. The message will be forwarded to the serial port following a strict FIFO (First In, First Out) queue, waiting for a single response before transmitting the next request. Once a response is received (with the same logic of a serial in node), or after a timeout occurs, a message is produced on the output, with msg.payload containing the received response (or missing in case if timeout), msg.status containing relevant info, and all other fields preserved.
For consistency with the serial in node, msg.port is also set to the name of the port selected.

2
io/serialport/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-serialport",
"version" : "0.7.0",
"version" : "0.7.1",
"description" : "Node-RED nodes to talk to serial ports",
"dependencies" : {
"serialport" : "^7.1.4"