Add help info

This commit is contained in:
Dave Conway-Jones 2023-11-01 12:33:57 +00:00
parent bfe5a8a986
commit 32e8f4eac6
No known key found for this signature in database
GPG Key ID: 1DDB0E91A28C2643

View File

@ -40,6 +40,8 @@
returned characters into a fixed buffer, match a specified character before returning,
wait a fixed timeout from first reply and then return, sit and wait for data, or send then close the connection
immediately, without waiting for a reply.</p>
<p>If in sit and wait mode (remain connected) you can send <code>msg.reset = true;</code> to force a break in
the connection and an automatic reconnection.</p>
<p>The response will be output in <code>msg.payload</code> as a buffer, so you may want to .toString() it.</p>
<p>If you leave tcp host or port blank they must be set by using the <code>msg.host</code> and <code>msg.port</code> properties in every message sent to the node.</p>
</script>