@signageos/front-applet 6.5.1 → 6.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|
|
11
11
|
## [6.5.0] - 2024-03-20
|
|
12
12
|
### Added
|
|
13
13
|
- Add support for sending MDC commands on Tizen
|
|
14
|
+
- Support for the `rtscts` option for the serial port configuration. This option is used when opening a serial port and determines whether to enable or disable RTS/CTS handshaking.
|
|
14
15
|
|
|
15
16
|
## [6.4.2] - 2024-01-26
|
|
16
17
|
### Fixed
|
|
@@ -30,7 +30,7 @@ Such hardware could be, for example, printers, payment terminals or sensors.
|
|
|
30
30
|
|
|
31
31
|
| Method | Description | Supported since |
|
|
32
32
|
| ------------------ | ---------------------- | :-------------: |
|
|
33
|
-
| `openSerialPort()` | Open a new serial port | 4.4.0
|
|
33
|
+
| `openSerialPort()` | Open a new serial port | 4.4.0
|
|
34
34
|
|
|
35
35
|
## openSerialPort()
|
|
36
36
|
|
|
@@ -39,10 +39,20 @@ Creates a new instance of serial port. You can then use that instance to handle
|
|
|
39
39
|
|
|
40
40
|
| Param | Type | Required | Description |
|
|
41
41
|
| --------- | ------ | :------------------------: | -------------------------------------------------- |
|
|
42
|
-
| `options` | Object | <div class="red">Yes</div> | Object containing configuration of the serial port
|
|
42
|
+
| `options` | Object | <div class="red">Yes</div> | Object containing configuration of the serial port
|
|
43
43
|
|
|
44
44
|
### Options
|
|
45
45
|
|
|
46
|
+
| Property | Type | Required | Description |
|
|
47
|
+
| -------- | ------ | -------- | -------- |
|
|
48
|
+
| `device` | String | No | Specifies the device address |
|
|
49
|
+
| `baudRate` | Number | Yes | Specifies the data transmission speed in bits per second |
|
|
50
|
+
| `parity` | **none**, **even**, **mark** or **space** | No | Specifies the form of error checking, whether (or what) extra bits are added to a byte |
|
|
51
|
+
| `databits` | Number | No | Specifies the number of bits in a byte |
|
|
52
|
+
| `stopbits` | Number | No | Specifies the number of bits used to signal the end of a communication packet |
|
|
53
|
+
| `rtscts` | Boolean | No | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign |
|
|
54
|
+
:::
|
|
55
|
+
|
|
46
56
|
Here is the options object defined as Typescript interface:
|
|
47
57
|
|
|
48
58
|
```typescript
|
|
@@ -52,6 +62,7 @@ interface ISerialPortOptions {
|
|
|
52
62
|
parity?: 'none' | 'even' | 'mark' | 'odd' | 'space';
|
|
53
63
|
databits?: number;
|
|
54
64
|
stopbits?: number;
|
|
65
|
+
rtscts?: boolean;
|
|
55
66
|
}
|
|
56
67
|
```
|
|
57
68
|
|
|
@@ -78,7 +89,7 @@ Device address is different per platform (at least for now). Kindly find the res
|
|
|
78
89
|
| Windows | `COM3` | `COM3` (typically, but check your Win machine if this does not work) |
|
|
79
90
|
| Samsung Kiosk | `PORT1` |`PORT1`, `PORT2`, `PORT3` |
|
|
80
91
|
| Android | `/dev/ttyusb0` | `/dev/ttyusb0` |
|
|
81
|
-
| BrightSign | `0` | `0`, `1`, `USB:A/0`
|
|
92
|
+
| BrightSign | `0` | `0`, `1`, `USB:A/0`
|
|
82
93
|
|
|
83
94
|
## Serial port methods
|
|
84
95
|
|
|
@@ -90,7 +101,7 @@ you can call following methods on it.
|
|
|
90
101
|
| ---------- | ----------------------------------------------------------- | :-------------: |
|
|
91
102
|
| `onData()` | Call a listener callback anytime the opened serial port receiving data. | 4.4.0 |
|
|
92
103
|
| `write()` | Write data to the serial port | 4.4.0 |
|
|
93
|
-
| `close()` | Close serial port | 4.4.0
|
|
104
|
+
| `close()` | Close serial port | 4.4.0
|
|
94
105
|
|
|
95
106
|
## onData()
|
|
96
107
|
|
|
@@ -151,4 +162,4 @@ Following errors may occur when working with the serial ports. However they don'
|
|
|
151
162
|
| 50603 | InternalHardwareError | Closing serial port that isn't open |
|
|
152
163
|
| 50603 | InternalHardwareError | Failed to close serial port |
|
|
153
164
|
| 50604 | InternalHardwareError | Writing to a serial port that isn't open |
|
|
154
|
-
| 50604 | InternalHardwareError | Failed to write to serial port
|
|
165
|
+
| 50604 | InternalHardwareError | Failed to write to serial port
|