@risleylima/escpos 1.0.0 → 1.0.1
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/README.md
CHANGED
|
@@ -70,6 +70,38 @@ await printer.flush();
|
|
|
70
70
|
await adapter.close();
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
+
### Serial Example
|
|
74
|
+
```javascript
|
|
75
|
+
import { Serial, Printer } from '@risleylima/escpos';
|
|
76
|
+
|
|
77
|
+
const adapter = new Serial();
|
|
78
|
+
// baudRate is optional; if omitted, 9600 is used when opening (node-serialport requires it).
|
|
79
|
+
// Port path: Linux/macOS → /dev/ttyUSB0, /dev/tty.usbmodem*; Windows → COM1, COM2, COM3, ...
|
|
80
|
+
await adapter.connect(process.platform === 'win32' ? 'COM3' : '/dev/tty.usbmodem112301', { baudRate: 115200 });
|
|
81
|
+
await adapter.open();
|
|
82
|
+
|
|
83
|
+
const printer = new Printer(adapter);
|
|
84
|
+
printer.textln('Serial Printing').cut();
|
|
85
|
+
|
|
86
|
+
await printer.flush();
|
|
87
|
+
await adapter.close();
|
|
88
|
+
```
|
|
89
|
+
**Windows:** Use the COM port shown in Device Manager (Ports COM & LPT), e.g. `COM3` or `COM4`. On Windows the path is always `COMn`.
|
|
90
|
+
|
|
91
|
+
Windows-only Serial example:
|
|
92
|
+
```javascript
|
|
93
|
+
import { Serial, Printer } from '@risleylima/escpos';
|
|
94
|
+
|
|
95
|
+
const adapter = new Serial();
|
|
96
|
+
await adapter.connect('COM3', { baudRate: 9600 }); // or 115200, depending on the printer
|
|
97
|
+
await adapter.open();
|
|
98
|
+
|
|
99
|
+
const printer = new Printer(adapter);
|
|
100
|
+
printer.textln('Windows print').cut();
|
|
101
|
+
await printer.flush();
|
|
102
|
+
await adapter.close();
|
|
103
|
+
```
|
|
104
|
+
|
|
73
105
|
### USB Example
|
|
74
106
|
```javascript
|
|
75
107
|
import { USB, Printer } from '@risleylima/escpos';
|
|
@@ -145,6 +177,7 @@ You can also register model profiles at runtime with `registerProfile(...)`, or
|
|
|
145
177
|
|
|
146
178
|
## ⚙️ Reliability and Safety Notes
|
|
147
179
|
|
|
180
|
+
- **Serial:** If you omit `baudRate` in `connect(port, options)`, the adapter uses 9600 when opening. Pass `baudRate` to match the printer (e.g. 115200 for Bematech MP-4200 TH).
|
|
148
181
|
- `flush()` is transactional: if adapter write fails, payload is preserved in buffer for retry/recovery.
|
|
149
182
|
- Printer I/O is serialized internally for `flush()`, `close()`, and `getStatus()` to reduce race conditions in concurrent flows.
|
|
150
183
|
- Passing an unknown profile id now fails fast with a descriptive error instead of silently falling back.
|
|
@@ -4,6 +4,10 @@ export declare class Serial extends Adapter {
|
|
|
4
4
|
private path;
|
|
5
5
|
private options;
|
|
6
6
|
static listSerial(): Promise<import("@serialport/bindings-interface").PortInfo[]>;
|
|
7
|
+
/**
|
|
8
|
+
* Configure the serial port. Options are passed to the underlying SerialPort (e.g. baudRate).
|
|
9
|
+
* If baudRate is omitted, open() will use 9600 by default (node-serialport requires baudRate).
|
|
10
|
+
*/
|
|
7
11
|
connect(port: string, options?: Record<string, unknown>): Promise<boolean>;
|
|
8
12
|
open(): Promise<boolean>;
|
|
9
13
|
write(data: Buffer): Promise<boolean>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serial-adapter/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serial-adapter/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAQrC,qBAAa,MAAO,SAAQ,OAAO;IACjC,OAAO,CAAC,IAAI,CAA2B;IACvC,OAAO,CAAC,IAAI,CAAuB;IACnC,OAAO,CAAC,OAAO,CAAwC;WAE1C,UAAU;IAIvB;;;OAGG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAU1E,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IA0DxB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB3C,OAAO,CAAC,UAAU;IAYZ,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAWvB,KAAK,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA4CvD,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;CAGrC"}
|
|
@@ -6,6 +6,7 @@ const adapter_1 = require("../adapter");
|
|
|
6
6
|
const debug = require('debug')('escpos:serial-adapter');
|
|
7
7
|
const NOT_CONNECTED_MSG = 'Not connected. Call connect(port[, options]) first.';
|
|
8
8
|
const CHUNK_SIZE = 4096; // 4KB chunks for RS232 stability
|
|
9
|
+
const DEFAULT_BAUD_RATE = 9600;
|
|
9
10
|
class Serial extends adapter_1.Adapter {
|
|
10
11
|
constructor() {
|
|
11
12
|
super(...arguments);
|
|
@@ -16,6 +17,10 @@ class Serial extends adapter_1.Adapter {
|
|
|
16
17
|
static async listSerial() {
|
|
17
18
|
return serialport_1.SerialPort.list();
|
|
18
19
|
}
|
|
20
|
+
/**
|
|
21
|
+
* Configure the serial port. Options are passed to the underlying SerialPort (e.g. baudRate).
|
|
22
|
+
* If baudRate is omitted, open() will use 9600 by default (node-serialport requires baudRate).
|
|
23
|
+
*/
|
|
19
24
|
async connect(port, options) {
|
|
20
25
|
return this.synchronized(async () => {
|
|
21
26
|
this.path = port;
|
|
@@ -39,8 +44,11 @@ class Serial extends adapter_1.Adapter {
|
|
|
39
44
|
this.state = 'DISCONNECTED';
|
|
40
45
|
return reject(new Error('The specified port does not exist!'));
|
|
41
46
|
}
|
|
47
|
+
const opts = this.options ?? {};
|
|
48
|
+
const baudRate = opts.baudRate ?? DEFAULT_BAUD_RATE;
|
|
42
49
|
this.port = new serialport_1.SerialPort({
|
|
43
|
-
...
|
|
50
|
+
...opts,
|
|
51
|
+
baudRate,
|
|
44
52
|
path: this.path,
|
|
45
53
|
autoOpen: false,
|
|
46
54
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serial-adapter/index.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,wCAAqC;AAErC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAA8C,CAAC;AAErG,MAAM,iBAAiB,GAAG,qDAAqD,CAAC;AAChF,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,iCAAiC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serial-adapter/index.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,wCAAqC;AAErC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAA8C,CAAC;AAErG,MAAM,iBAAiB,GAAG,qDAAqD,CAAC;AAChF,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,iCAAiC;AAC1D,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAE/B,MAAa,MAAO,SAAQ,iBAAO;IAAnC;;QACU,SAAI,GAAsB,IAAI,CAAC;QAC/B,SAAI,GAAkB,IAAI,CAAC;QAC3B,YAAO,GAAmC,IAAI,CAAC;IAuKzD,CAAC;IArKC,MAAM,CAAC,KAAK,CAAC,UAAU;QACrB,OAAO,uBAAU,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,OAAiC;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;YACzB,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,OAAO,IAAI,CAAC;YAE/C,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,IAAI,CAAC;oBACH,MAAM,KAAK,GAAG,MAAM,uBAAU,CAAC,IAAI,EAAE,CAAC;oBACtC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC7C,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;wBAC5B,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC,CAAC;oBACjE,CAAC;oBAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;oBAChC,MAAM,QAAQ,GAAI,IAAI,CAAC,QAA+B,IAAI,iBAAiB,CAAC;oBAC5E,IAAI,CAAC,IAAI,GAAG,IAAI,uBAAU,CAAC;wBACzB,GAAG,IAAI;wBACP,QAAQ;wBACR,IAAI,EAAE,IAAI,CAAC,IAAK;wBAChB,QAAQ,EAAE,KAAK;qBAC+B,CAAC,CAAC;oBAElD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;wBACnC,KAAK,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;wBACrC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;oBAC1B,CAAC,CAAC,CAAC;oBAEH,MAAM,SAAS,GAAG,GAAG,EAAE;wBACrB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;wBAC9C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;wBACjB,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;oBAC9B,CAAC,CAAC;oBAEF,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;oBAEjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;wBACrB,IAAI,GAAG,EAAE,CAAC;4BACR,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;4BAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;4BACjB,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;4BAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;wBACd,CAAC;6BAAM,CAAC;4BACN,KAAK,CAAC,4BAA4B,CAAC,CAAC;4BACpC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;4BACrB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;4BAChC,OAAO,CAAC,IAAI,CAAC,CAAC;wBAChB,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;oBAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAExE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;YAEpB,IAAI,CAAC;gBACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;oBACjD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC;oBAC/C,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,UAAU,CAAC,KAAa;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC9B,IAAI,GAAG;oBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC5B,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAC5B,IAAI,QAAQ;wBAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;;wBAC1B,OAAO,EAAE,CAAC;gBACjB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACxE,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBACrC,IAAI,CAAC,IAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;oBACvC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAA8B;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,MAAM,IAAI,GAAG,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC;YAEpC,IAAI,CAAC;gBACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;oBAClC,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;wBACvB,IAAI,GAAG;4BAAE,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;wBACrC,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;gBAEhE,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;oBAClC,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;wBACvB,IAAI,GAAG;4BAAE,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;wBACrC,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC1C,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;wBACvB,IAAI,GAAG;4BAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;4BAChB,OAAO,EAAE,CAAC;oBACjB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBACjB,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,KAAK,CAAC,8BAA8B,EAAE,CAAC,CAAC,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBACjB,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC;gBAC5B,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF;AA1KD,wBA0KC"}
|
package/package.json
CHANGED