frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
Code Issues Releases Wiki Activity

clarify serial port timeout doc info

Browse Source
This commit is contained in:
Dave Conway-Jones 2018-02-19 19:21:52 +00:00
parent c1d835c1ca
commit 127fb6ac0c
No known key found for this signature in database
GPG Key ID: 9E7F9C73F5168CD4
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
io/serialport/25-serial.html
View File

@ -13,7 +13,7 @@
<script type="text/x-red" data-help-name="serial in"> <script type="text/x-red" data-help-name="serial in">
<p>Reads data from a local serial port.</p> <p>Reads data from a local serial port.</p>
<p>Can either <ul><li>wait for a "split" character (default \n). Also accepts hex notation (0x0d).</li> <p>Can either <ul><li>wait for a "split" character (default \n). Also accepts hex notation (0x0d).</li>
<li>Wait for a timeout in milliseconds for the first character received</li> <li>Wait for a timeout in milliseconds from the first character received</li>
<li>Wait to fill a fixed sized buffer</li></ul></p> <li>Wait to fill a fixed sized buffer</li></ul></p>
<p>It then outputs <code>msg.payload</code> as either a UTF8 ascii string or a binary Buffer object.</p> <p>It then outputs <code>msg.payload</code> as either a UTF8 ascii string or a binary Buffer object.</p>
<p>If no split character is specified, or a timeout or buffer size of 0, then a stream of single characters <p>If no split character is specified, or a timeout or buffer size of 0, then a stream of single characters

2
io/serialport/README.md
View File

@ -45,7 +45,7 @@ the device, however you many need to manually specify it. COM1, /dev/ttyUSB0, et
It can either It can either
- wait for a "split" character (default \n). Also accepts hex notation (0x0a). - wait for a "split" character (default \n). Also accepts hex notation (0x0a).
- wait for a timeout in milliseconds for the first character received - wait for a timeout in milliseconds from the first character received
- wait to fill a fixed sized buffer - wait to fill a fixed sized buffer
It then outputs `msg.payload` as either a UTF8 ascii string or a binary Buffer object. It then outputs `msg.payload` as either a UTF8 ascii string or a binary Buffer object.

4
io/serialport/package.json
View File

@ -1,9 +1,9 @@
{ {
"name" : "node-red-node-serialport", "name" : "node-red-node-serialport",
"version" : "0.6.3", "version" : "0.6.4",
"description" : "Node-RED nodes to talk to serial ports", "description" : "Node-RED nodes to talk to serial ports",
"dependencies" : { "dependencies" : {
"serialport" : "^6.0.4" "serialport" : "^6.0.5"
}, },
"repository" : { "repository" : {
"type":"git", "type":"git",