BlueGit

timfa posprint

Files

posprint / README.md

README.md

README.md 4.4 KiB Download Raw

posprint

Cross-platform designer for POS (point-of-sale) receipt documents. Edit templates in a markdown-like syntax, preview output live, substitute runtime parameters, and print via raw ESC/POS (USB printer-class, Windows spooler, USB-serial, or Classic Bluetooth SPP after OS pairing).

Target platforms: Windows, Linux (x64), and macOS (Apple Silicon / Intel).

Status

v0.5.7 — Classic Bluetooth SPP after OS pairing (Windows COM / Linux rfcomm); BLE still out of scope.

Build and run

Requires Rust 1.88+ (rustup or pacman -S rust on Arch). See docs/BUILD.md for OS libraries and package scripts.

cargo test          # unit tests
cargo run           # launch the designer
cargo build --release

Scripts: scripts/build-windows.ps1, scripts/build-linux.sh, scripts/build-arch.sh, scripts/build-macos.sh (Interactive shells offer to install missing dependencies.)

Command-line printing

# List discovered printers (USB, spooler, serial, paired Bluetooth SPP)
posprint list

# Windows (serial, Bluetooth COM after pairing, or spooler queue name)
posprint print receipt.pos -p COM3 --set StoreName="Shop" --set DocumentNumber=42

# Linux / macOS (USB-direct, 'auto', USB-serial, or RFCOMM/Bluetooth SPP)
posprint print receipt.pos -p auto --set StoreName="Shop" --set DocumentNumber=42
posprint print receipt.pos -p /dev/ttyUSB0 --set StoreName="Shop" --set DocumentNumber=42

# Embedded CLI help for this OS
posprint cli-help

All ${Parameters} must be supplied via --set NAME=VALUE or the command fails.

Linux serial: add your user to the dialout group.

Releases (BlueGit CI)

PlatformArtifactInstall
Linux (Debian/Ubuntu).deb (amd64)sudo dpkg -i posprint_*_amd64.deb then sudo apt-get install -f
Linux (Arch).pkg.tar.zst (x86_64)sudo pacman -U posprint-*-x86_64.pkg.tar.zst or AUR posprint / posprint-bin
Windowsposprint.exeDownload from the BlueGit releases

Every master pipeline on BlueGit builds all packages. Start the manual release job to create the next tag (highest tag + 1 patch, or RELEASE_VERSION) with the packages as release assets; publish:aur then updates the posprint and posprint-bin AUR packages. See blue-ci-cd.yml. Releases up to 0.5.8 are on the old GitLab project.

Features

  • Markdown-like template editor with live preview (Design tab)
  • Page width (mm) and calibrated preview zoom
  • Save and load .pos files
  • Parameter tokens: ${Name} (text) and $[Name] (bool checkbox) via print dialog and CLI --set
  • Inline ASCII checkboxes ([] / [ ] / [x]) — CP437-safe on thermal printers
  • Nested bullet lists, headings, @date / @time, barcodes, QR, images
  • Print via USB-direct, Windows spooler, USB-serial, or paired Classic Bluetooth SPP (baud probed; BLE not supported)
  • In-app Help tab (from docs/HELP.md)

Documentation

DocumentDescription
HELP.mdUser reference (mirrored in-app Help tab)
ARCHITECTURE.mdSystem architecture and module breakdown
DSL-SPEC.mdDocument markup language (.pos body syntax)
FILE-FORMAT.md.pos file envelope (metadata + body)
PRINTING.mdPrinter discovery, transport, ESC/POS pipeline
POSPRINT-URL.mdposprint:// deep links and lib/ helpers
AUR.mdAUR package layout, secrets, and tag-driven publishing
BUILD.mdLocal build scripts and Linux package formats

Documentation must stay aligned with the codebase; see .cursor/rules/documentation.mdc.

Dependencies (minimal)

CrateWhy
eframe / eguiNative UI
serde / serde_json.pos file format
serialportSerial printer I/O
rusbUSB printer-class devices
imageLoad PNG/JPEG for @image
rfdNative open/save dialogs
barcodersRaster barcode rendering
qrcodeRaster QR rendering
clapCLI print / link / cli-help
flate2 / base64posprint:// URL payload
ureqDownload @image http(s)://…

ESC/POS encoding is implemented in-tree.

Source
1# posprint
2
3Cross-platform designer for POS (point-of-sale) receipt documents. Edit templates in a markdown-like syntax, preview output live, substitute runtime parameters, and print via raw ESC/POS (USB printer-class, Windows spooler, USB-serial, or Classic Bluetooth SPP after OS pairing).
4
5**Target platforms:** Windows, Linux (x64), and macOS (Apple Silicon / Intel).
6
7## Status
8
9**v0.5.7** — Classic Bluetooth SPP after OS pairing (Windows COM / Linux rfcomm); BLE still out of scope.
10
11## Build and run
12
13Requires **Rust 1.88+** ([rustup](https://rustup.rs/) or `pacman -S rust` on Arch). See [docs/BUILD.md](docs/BUILD.md) for OS libraries and package scripts.
14
15```bash
16cargo test # unit tests
17cargo run # launch the designer
18cargo build --release
19```
20
21**Scripts:** `scripts/build-windows.ps1`, `scripts/build-linux.sh`, `scripts/build-arch.sh`, `scripts/build-macos.sh`
22(Interactive shells offer to install missing dependencies.)
23
24### Command-line printing
25
26```bash
27# List discovered printers (USB, spooler, serial, paired Bluetooth SPP)
28posprint list
29
30# Windows (serial, Bluetooth COM after pairing, or spooler queue name)
31posprint print receipt.pos -p COM3 --set StoreName="Shop" --set DocumentNumber=42
32
33# Linux / macOS (USB-direct, 'auto', USB-serial, or RFCOMM/Bluetooth SPP)
34posprint print receipt.pos -p auto --set StoreName="Shop" --set DocumentNumber=42
35posprint print receipt.pos -p /dev/ttyUSB0 --set StoreName="Shop" --set DocumentNumber=42
36
37# Embedded CLI help for this OS
38posprint cli-help
39```
40
41All `${Parameters}` must be supplied via `--set NAME=VALUE` or the command fails.
42
43**Linux serial:** add your user to the `dialout` group.
44
45## Releases (BlueGit CI)
46
47| Platform | Artifact | Install |
48|----------|----------|---------|
49| Linux (Debian/Ubuntu) | `.deb` (amd64) | `sudo dpkg -i posprint_*_amd64.deb` then `sudo apt-get install -f` |
50| Linux (Arch) | `.pkg.tar.zst` (x86_64) | `sudo pacman -U posprint-*-x86_64.pkg.tar.zst` or AUR `posprint` / `posprint-bin` |
51| Windows | `posprint.exe` | Download from the [BlueGit releases](https://git.timfalken.com/timfa/posprint/-/releases) |
52
53Every master pipeline on [BlueGit](https://git.timfalken.com/timfa/posprint) builds all packages. Start the manual `release` job to create the next tag (highest tag + 1 patch, or `RELEASE_VERSION`) with the packages as release assets; `publish:aur` then updates the `posprint` and `posprint-bin` AUR packages. See `blue-ci-cd.yml`. Releases up to 0.5.8 are on the old [GitLab project](https://gitlab.com/Timfa/posprint/-/releases).
54
55## Features
56
57- Markdown-like template editor with live preview (Design tab)
58- Page width (mm) and calibrated preview zoom
59- Save and load `.pos` files
60- Parameter tokens: `${Name}` (text) and `$[Name]` (bool checkbox) via print dialog and CLI `--set`
61- Inline ASCII checkboxes (`[]` / `[ ]` / `[x]`) — CP437-safe on thermal printers
62- Nested bullet lists, headings, `@date` / `@time`, barcodes, QR, images
63- Print via USB-direct, Windows spooler, USB-serial, or paired Classic Bluetooth SPP (baud probed; BLE not supported)
64- In-app **Help** tab (from [docs/HELP.md](docs/HELP.md))
65
66## Documentation
67
68| Document | Description |
69|----------|-------------|
70| [HELP.md](docs/HELP.md) | **User reference** (mirrored in-app Help tab) |
71| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | System architecture and module breakdown |
72| [DSL-SPEC.md](docs/DSL-SPEC.md) | Document markup language (`.pos` body syntax) |
73| [FILE-FORMAT.md](docs/FILE-FORMAT.md) | `.pos` file envelope (metadata + body) |
74| [PRINTING.md](docs/PRINTING.md) | Printer discovery, transport, ESC/POS pipeline |
75| [POSPRINT-URL.md](docs/POSPRINT-URL.md) | `posprint://` deep links and `lib/` helpers |
76| [AUR.md](docs/AUR.md) | AUR package layout, secrets, and tag-driven publishing |
77| [BUILD.md](docs/BUILD.md) | Local build scripts and Linux package formats |
78
79Documentation must stay aligned with the codebase; see `.cursor/rules/documentation.mdc`.
80
81## Dependencies (minimal)
82
83| Crate | Why |
84|-------|-----|
85| `eframe` / `egui` | Native UI |
86| `serde` / `serde_json` | `.pos` file format |
87| `serialport` | Serial printer I/O |
88| `rusb` | USB printer-class devices |
89| `image` | Load PNG/JPEG for `@image` |
90| `rfd` | Native open/save dialogs |
91| `barcoders` | Raster barcode rendering |
92| `qrcode` | Raster QR rendering |
93| `clap` | CLI `print` / `link` / `cli-help` |
94| `flate2` / `base64` | `posprint://` URL payload |
95| `ureq` | Download `@image http(s)://…` |
96
97ESC/POS encoding is implemented in-tree.