qz-tray

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Namespace: serial</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Namespace: serial</h1> <section> <header> <h2> <span class="ancestors"><a href="qz.html">qz</a>.</span>serial</h2> </header> <article> <div class="container-overview"> <div class="description">Calls related to interaction with serial ports.</div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1784">line 1784</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".closePort"><span class="type-signature">(static) </span>closePort<span class="signature">(port)</span><span class="type-signature"> → {Promise.<(null|Error)>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Name of port to close.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1899">line 1899</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(null|Error)></span> </dd> </dl> <h4 class="name" id=".findPorts"><span class="type-signature">(static) </span>findPorts<span class="signature">()</span><span class="type-signature"> → {Promise.<(Array.<string>|Error)>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1794">line 1794</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Communication (RS232, COM, TTY) ports available on connected system. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(Array.<string>|Error)></span> </dd> </dl> <h4 class="name" id=".openPort"><span class="type-signature">(static) </span>openPort<span class="signature">(port, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(null|Error)>}</span></h4> <div class="description"> Opens a serial port for sending and receiving data </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">Name of serial port to open.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Serial port configurations. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>baudRate</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 9600 </td> <td class="description last">Serial port speed. Set to 0 for auto negotiation.</td> </tr> <tr> <td class="name"><code>dataBits</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 8 </td> <td class="description last">Serial port data bits. Set to 0 for auto negotiation.</td> </tr> <tr> <td class="name"><code>stopBits</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 1 </td> <td class="description last">Serial port stop bits. Set to 0 for auto negotiation.</td> </tr> <tr> <td class="name"><code>parity</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'NONE' </td> <td class="description last">Serial port parity. Set to AUTO for auto negotiation. Valid values <code>[NONE | EVEN | ODD | MARK | SPACE | AUTO]</code></td> </tr> <tr> <td class="name"><code>flowControl</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'NONE' </td> <td class="description last">Serial port flow control. Set to AUTO for auto negotiation. Valid values <code>[NONE | XONXOFF | XONXOFF_OUT | XONXOFF_IN | RTSCTS | RTSCTS_OUT | RTSCTS_IN | AUTO]</code></td> </tr> <tr> <td class="name"><code>encoding</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'UTF-8' </td> <td class="description last">Character set for communications.</td> </tr> <tr> <td class="name"><code>start</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0x0002 </td> <td class="description last">DEPRECATED: Legacy character denoting start of serial response. Use <code>options.rx.start</code> instead.</td> </tr> <tr> <td class="name"><code>end</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0x000D </td> <td class="description last">DEPRECATED: Legacy character denoting end of serial response. Use <code>options.rx.end</code> instead.</td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">DEPRECATED: Legacy use for fixed-width response serial communication. Use <code>options.rx.width</code> instead.</td> </tr> <tr> <td class="name"><code>rx</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Serial communications response definitions. If an object is passed but no options are defined, all response data will be sent back as it is received unprocessed. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>start</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Character(s) denoting start of response bytes. Used in conjunction with `end`, `width`, or `lengthbit` property.</td> </tr> <tr> <td class="name"><code>end</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Character denoting end of response bytes. Used in conjunction with `start` property.</td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Fixed width size of response bytes (not including header if `start` is set). Used alone or in conjunction with `start` property.</td> </tr> <tr> <td class="name"><code>untilNewline</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Returns data between newline characters (`\n` or `\r`) Truncates empty responses. Overrides `start`, `end`, `width`.</td> </tr> <tr> <td class="name"><code>lengthBytes</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">If a number is passed it is treated as the length index. Other values are left as their defaults. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Position of the response byte (not including response `start` bytes) used to denote the length of the remaining response data.</td> </tr> <tr> <td class="name"><code>length</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 1 </td> <td class="description last">Length of response length bytes after response header.</td> </tr> <tr> <td class="name"><code>endian</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'BIG' </td> <td class="description last">Byte endian for multi-byte length values. Valid values <code>[BIG | LITTLE]</code></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>crcBytes</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">If a number is passed it is treated as the crc length. Other values are left as their defaults. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Position after the response data (not including length or data bytes) used to denote the crc.</td> </tr> <tr> <td class="name"><code>length</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 1 </td> <td class="description last">Length of response crc bytes after the response data length.</td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>includeHeader</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">Whether any of the header bytes (`start` bytes and any length bytes) should be included in the processed response.</td> </tr> <tr> <td class="name"><code>encoding</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Override the encoding used for response data. Uses the same value as <code>options.encoding</code> otherwise.</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1845">line 1845</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(null|Error)></span> </dd> </dl> <h4 class="name" id=".sendData"><span class="type-signature">(static) </span>sendData<span class="signature">(port, data, options)</span><span class="type-signature"> → {Promise.<(null|Error)>}</span></h4> <div class="description"> Send commands over a serial port. Any responses from the device will be sent to serial callback functions. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">An open serial port to send data.</td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> | <span class="param-type">Object</span> </td> <td class="description last">Data to be sent to the serial device. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'PLAIN' </td> <td class="description last">Valid values <code>[FILE | PLAIN | HEX | BASE64]</code></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Data to be sent to the serial device.</td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Serial port configuration updates. See <code>qz.serial.openPort</code> `options` docs for available values. For best performance, it is recommended to only set these values on the port open call.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1870">line 1870</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="qz.serial.html#.setSerialCallbacks">qz.serial.setSerialCallbacks</a></li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(null|Error)></span> </dd> </dl> <h4 class="name" id=".setSerialCallbacks"><span class="type-signature">(static) </span>setSerialCallbacks<span class="signature">(calls)</span><span class="type-signature"></span></h4> <div class="description"> List of functions called for any response from open serial ports. Event data will contain <code>{string} portName</code> for all types. For RECEIVE types, <code>{string} output</code>. For ERROR types, <code>{string} exception</code>. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>calls</code></td> <td class="type"> <span class="param-type">function</span> | <span class="param-type">Array.<function()></span> </td> <td class="description last">Single or array of <code>Function({object} streamEvent)</code> calls.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="qz-tray.js.html">qz-tray.js</a>, <a href="qz-tray.js.html#line1808">line 1808</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="qz.html">qz</a></li><li><a href="qz.api.html">api</a></li><li><a href="qz.configs.html">configs</a></li><li><a href="qz.file.html">file</a></li><li><a href="qz.hid.html">hid</a></li><li><a href="qz.networking.html">networking</a></li><li><a href="qz.printers.html">printers</a></li><li><a href="qz.security.html">security</a></li><li><a href="qz.serial.html">serial</a></li><li><a href="qz.socket.html">socket</a></li><li><a href="qz.usb.html">usb</a></li><li><a href="qz.websocket.html">websocket</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Apr 02 2026 13:01:02 GMT-0400 (Eastern Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>