Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node-escpos/driver
๐จ๏ธ ESC/POS Printer driver for Node.js.
https://github.com/node-escpos/driver
bluetooth driver escpos escpos-printer hacktoberfest hardware network node-escpos node-printer nodejs printer serialport thermal-printing usb
Last synced: 3 months ago
JSON representation
๐จ๏ธ ESC/POS Printer driver for Node.js.
- Host: GitHub
- URL: https://github.com/node-escpos/driver
- Owner: node-escpos
- License: other
- Created: 2022-10-23T09:49:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T16:10:22.000Z (4 months ago)
- Last Synced: 2024-07-31T18:33:54.428Z (3 months ago)
- Topics: bluetooth, driver, escpos, escpos-printer, hacktoberfest, hardware, network, node-escpos, node-printer, nodejs, printer, serialport, thermal-printing, usb
- Language: TypeScript
- Homepage:
- Size: 18.9 MB
- Stars: 272
- Watchers: 8
- Forks: 25
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @node-escpos
๐จ๏ธ ESC/POS Printer driver for Node.js.
---
https://user-images.githubusercontent.com/32405058/208310580-25466637-2b3e-4928-b4e6-6ceb07735136.mp4
[๐ข RFC] Recently I'm working on a new workflow that prints the receipt. HTML+CSS will customize the content. Theoretically, we can print anything that we want. The workflow is like this:
1. ๐จ rendering
```tsx
Label/Receipt
```
2. ๐ธ capturing
```tsx
const screenshort = await capture(document.getElementByID("label-dom"))
```
3. ๐งพ printing
```tsx
const printer = await printer.image(screenshort, "s8")
printer.cut().close()
```
But my full-time job is very busy. So the progress is slow, And any sponsorship will encourage me to work more actively in the open-source community.
---
### Improvements
- ๐ TypeScript.
- ๐ฆ pnpm.
- ๐ข vitest.
- ๐ More stable maintenance.
- ๐ด Printing by HTML+CSS(WIP).
- ๐ก More ideas.
- ...
### Packages
- [@node-escpos/core](packages/core/README.md) [](https://www.npmjs.com/package/@node-escpos/core) [](https://www.npmjs.com/package/@node-escpos/core) [](https://www.npmjs.com/package/@node-escpos/core)
- [@node-escpos/adapter](packages/adapter/README.md) [](https://www.npmjs.com/package/@node-escpos/adapter) [](https://www.npmjs.com/package/@node-escpos/adapter) [](https://www.npmjs.com/package/@node-escpos/adapter)
- [@node-escpos/console](packages/console/README.md) [](https://www.npmjs.com/package/@node-escpos/console) [](https://www.npmjs.com/package/@node-escpos/console) [](https://www.npmjs.com/package/@node-escpos/console)
- [@node-escpos/screen](packages/screen/README.md) [](https://www.npmjs.com/package/@node-escpos/screen) [](https://www.npmjs.com/package/@node-escpos/screen) [](https://www.npmjs.com/package/@node-escpos/screen)
- [@node-escpos/server](packages/server/README.md) [](https://www.npmjs.com/package/@node-escpos/server) [](https://www.npmjs.com/package/@node-escpos/server) [](https://www.npmjs.com/package/@node-escpos/server)
- [@node-escpos/network-adapter](packages/network-adapter/README.md) [](https://www.npmjs.com/package/@node-escpos/network-adapter) [](https://www.npmjs.com/package/@node-escpos/network-adapter) [](https://www.npmjs.com/package/@node-escpos/network-adapter)
- [@node-escpos/usb-adapter](packages/usb-adapter/README.md) [](https://www.npmjs.com/package/@node-escpos/usb-adapter) [](https://www.npmjs.com/package/@node-escpos/usb-adapter) [](https://www.npmjs.com/package/@node-escpos/usb-adapter)
- [@node-escpos/serialport-adapter](packages/serialport-adapter/README.md) [](https://www.npmjs.com/package/@node-escpos/serialport-adapter) [](https://www.npmjs.com/package/@node-escpos/serialport-adapter) [](https://www.npmjs.com/package/@node-escpos/serialport-adapter)
- [@node-escpos/bluetooth-adapter](packages/bluetooth-adapter/README.md) [](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter) [](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter) [](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter)
## Example
````javascript
import { Printer, Image } from "@node-escpos/core";
// install escpos-usb adapter module manually
import USB from "@node-escpos/usb-adapter";
// Select the adapter based on your printer type
import { join } from "path";
const device = new USB();
device.open(async function(err){
if(err){
// handle error
return
}
// encoding is optional
const options = { encoding: "GB18030" /* default */ }
let printer = new Printer(device, options);
// Path to png image
const filePath = join("/PATH/TO/IMAGE");
const image = await Image.load(filePath);
printer
.font("a")
.align("ct")
.style("bu")
.size(1, 1)
.text("May the gold fill your pocket")
.text("ๆญๅๅ่ดข")
.barcode(112233445566, "EAN13", { width: 50, height: 50 })
.table(["One", "Two", "Three"])
.tableCustom(
[
{ text: "Left", align: "LEFT", width: 0.33, style: "B" },
{ text: "Center", align: "CENTER", width: 0.33 },
{ text: "Right", align: "RIGHT", width: 0.33 },
],
{ encoding: "cp857", size: [1, 1] }, // Optional
)
// inject qrimage to printer
printer = await printer.qrimage("https://github.com/node-escpos/driver")
// inject image to printer
printer = await printer.image(
image,
"s8" // changing with image
)
printer
.cut()
.close()
});
````
- See [`./examples/demo/test`](https://github.com/node-escpos/driver/tree/main/examples/demo/test) for more examples.
## Sponsors
## License
[MIT](./LICENSE) License ยฉ 2022 [Dohooo](https://github.com/dohooo)