|
| 1 | +export default class VueSerial extends EventTarget { |
| 2 | + #private; |
| 3 | + /** |
| 4 | + * Event which is triggered when data is received from the open device port. |
| 5 | + * Call `serial.addEventListener("read", ({ value }) => { ... })` to read incoming data. |
| 6 | + * @event |
| 7 | + */ |
| 8 | + static read: string; |
| 9 | + /** |
| 10 | + * VueSerial instance constructor |
| 11 | + */ |
| 12 | + constructor(); |
| 13 | + /** |
| 14 | + * Constant property indicating if the serial feature is available on the client navigator (Web Serial API is implemented and page is served using HTTPS) |
| 15 | + * @readonly |
| 16 | + */ |
| 17 | + get isAvailable(): boolean; |
| 18 | + set isAvailable(x: boolean); |
| 19 | + /** |
| 20 | + * Restore defaults settings |
| 21 | + */ |
| 22 | + restoreDefaults(): void; |
| 23 | + /** |
| 24 | + * Ask the user to select the serial port and open it |
| 25 | + * @param filters - A list of objects containing vendor and product IDs used to search for attached devices. |
| 26 | + */ |
| 27 | + connect(filters: SerialPortFilter[] | undefined): Promise<void>; |
| 28 | + /** |
| 29 | + * Close the current port if open |
| 30 | + */ |
| 31 | + close(): Promise<void>; |
| 32 | + /** |
| 33 | + * Send data to the open serial port |
| 34 | + * @param value - The content to send |
| 35 | + */ |
| 36 | + write(value: Iterable<number>): Promise<void>; |
| 37 | + /** |
| 38 | + * Get the DCD, CTS, RI and DSR signals (alternative to use built-in polling) |
| 39 | + * @returns Object containing "dataCarrierDetect", "clearToSend", "ringIndicator" and "dataSetReady" booleans |
| 40 | + * @note You can also get the same values in serial.dataCarrierDetect, serial.clearToSend, serial.ringIndicator and serial.dataSetReady |
| 41 | + */ |
| 42 | + getSignals(): Promise<SerialInputSignals>; |
| 43 | + /** |
| 44 | + * Set the DTR, RTS and break signals |
| 45 | + * @param signals - object containing either "dataTerminalReady", "requestToSend" and/or "break" booleans |
| 46 | + * @note You can also set the serial.dataTerminalReady, serial.requestToSend, and serial.break variables if you don't need asynchronous control |
| 47 | + */ |
| 48 | + setSignals(signals: SerialOutputSignals): Promise<void>; |
| 49 | + /** |
| 50 | + * Start listening for signals changes and update the corresponding variables |
| 51 | + * @param interval_ms - Polling interval in ms (100ms if not specified) |
| 52 | + */ |
| 53 | + startSignalsPolling(interval_ms: number | null): void; |
| 54 | + /** |
| 55 | + * Stop listening for signal changes |
| 56 | + */ |
| 57 | + stopSignalsPolling(): void; |
| 58 | + /** |
| 59 | + * Tracks the active state of the serial port |
| 60 | + * @readonly |
| 61 | + */ |
| 62 | + get isOpen(): boolean; |
| 63 | + set isOpen(x: boolean); |
| 64 | + /** |
| 65 | + * Becomes false if the open device has been disconnected |
| 66 | + * @readonly |
| 67 | + */ |
| 68 | + get isConnected(): boolean; |
| 69 | + set isConnected(x: boolean); |
| 70 | + /** |
| 71 | + * Becomes true when the device is currently closing (after the close() function has been called) |
| 72 | + * @readonly |
| 73 | + */ |
| 74 | + get isClosing(): boolean; |
| 75 | + set isClosing(x: boolean); |
| 76 | + /** |
| 77 | + * Current port USB vendor ID |
| 78 | + * @readonly |
| 79 | + */ |
| 80 | + get usbVendorId(): number | undefined; |
| 81 | + set usbVendorId(x: number | undefined); |
| 82 | + /** |
| 83 | + * Current port USB product ID |
| 84 | + * @readonly |
| 85 | + */ |
| 86 | + get usbProductId(): number | undefined; |
| 87 | + set usbProductId(x: number | undefined); |
| 88 | + /** |
| 89 | + * A positive, non-zero value indicating the baud rate at which serial communication should be established |
| 90 | + */ |
| 91 | + get baudRate(): number; |
| 92 | + set baudRate(value: number); |
| 93 | + /** |
| 94 | + * The number of data bits per frame (either 7 or 8) |
| 95 | + */ |
| 96 | + get dataBits(): number; |
| 97 | + set dataBits(value: number); |
| 98 | + /** |
| 99 | + * The number of stop bits per frame (either 1 or 2) |
| 100 | + */ |
| 101 | + get stopBits(): number; |
| 102 | + set stopBits(value: number); |
| 103 | + /** |
| 104 | + * The parity mode (either "none", "even" or "odd") |
| 105 | + */ |
| 106 | + get parity(): ParityType; |
| 107 | + set parity(value: ParityType); |
| 108 | + /** |
| 109 | + * A positive, non-zero value indicating the size of the read and write buffers that should be created. |
| 110 | + */ |
| 111 | + get bufferSize(): number; |
| 112 | + set bufferSize(value: number); |
| 113 | + /** |
| 114 | + * The flow control mode (either "hardware" or "none") |
| 115 | + */ |
| 116 | + get flowControl(): FlowControlType; |
| 117 | + set flowControl(value: FlowControlType); |
| 118 | + /** |
| 119 | + * Data Carrier Detect (DCD) input signal value |
| 120 | + * @remarks This value must be refreshed manually by calling serial.getSignals() or automatically with serial.startSignalsPolling(...) |
| 121 | + * @readonly |
| 122 | + */ |
| 123 | + get dataCarrierDetect(): boolean; |
| 124 | + set dataCarrierDetect(x: boolean); |
| 125 | + /** |
| 126 | + * Clear To Send (CTS) input signal value |
| 127 | + * @remarks This value must be refreshed manually by calling serial.getSignals() or automatically with serial.startSignalsPolling(...) |
| 128 | + * @readonly |
| 129 | + */ |
| 130 | + get clearToSend(): boolean; |
| 131 | + set clearToSend(x: boolean); |
| 132 | + /** |
| 133 | + * Ring Indicator (RI) input signal value |
| 134 | + * @remarks This value must be refreshed manually by calling serial.getSignals() or automatically with serial.startSignalsPolling(...) |
| 135 | + * @readonly |
| 136 | + */ |
| 137 | + get ringIndicator(): boolean; |
| 138 | + set ringIndicator(x: boolean); |
| 139 | + /** |
| 140 | + * Data Set Ready (DSR) input signal value |
| 141 | + * @remarks This value must be refreshed manually by calling `serial.getSignals()` or automatically with serial.startSignalsPolling(...) |
| 142 | + * @readonly |
| 143 | + */ |
| 144 | + get dataSetReady(): boolean; |
| 145 | + set dataSetReady(x: boolean); |
| 146 | + /** |
| 147 | + * Data Terminal Ready (DTR) output signal value |
| 148 | + */ |
| 149 | + get dataTerminalReady(): boolean; |
| 150 | + /** |
| 151 | + * @remarks This will be set asynchronously. Prefer `await serial.setSignals({ dataTerminalReady: ... })` for precise asynchronous control |
| 152 | + */ |
| 153 | + set dataTerminalReady(value: boolean); |
| 154 | + /** |
| 155 | + * Request To Send (RTS) output signal value |
| 156 | + */ |
| 157 | + get requestToSend(): boolean; |
| 158 | + /** |
| 159 | + * @remarks This will be set asynchronously. Prefer `await serial.setSignals({ requestToSend: ... })` for precise asynchronous control |
| 160 | + */ |
| 161 | + set requestToSend(value: boolean); |
| 162 | + /** |
| 163 | + * Break output signal value |
| 164 | + */ |
| 165 | + get break(): boolean; |
| 166 | + /** |
| 167 | + * @remarks This will be set asynchronously. Prefer `await serial.setSignals({ break: ... })` for precise asynchronous control |
| 168 | + */ |
| 169 | + set break(value: boolean); |
| 170 | +} |
0 commit comments