https://github.com/ryankurte/rust-ptouch

Rust driver for Brother P-Touch label makers (USB)
https://github.com/ryankurte/rust-ptouch

brother driver ptouch rust usb

Last synced: 2 days ago
JSON representation

Rust driver for Brother P-Touch label makers (USB)

• Host: GitHub
• URL: https://github.com/ryankurte/rust-ptouch
• Owner: ryankurte
• Created: 2021-01-25T07:22:23.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-09T19:53:26.000Z (3 months ago)
• Last Synced: 2025-01-18T01:44:55.009Z (4 days ago)
• Topics: brother, driver, ptouch, rust, usb
• Language: Rust
• Homepage:
• Size: 101 KB
• Stars: 45
• Watchers: 4
• Forks: 15
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Brother P-Touch Raster Driver (and utility)

Brother P-Touch Label-Maker Raster Driver for `PT-E550W/P750W/P710BT` devices.

## Status

***Extremely alpha, tested only on the `PT-P710BT`, API subject to change***

[![GitHub tag](https://img.shields.io/github/tag/ryankurte/rust-ptouch.svg)](https://github.com/ryankurte/rust-ptouch)

![Build Status](https://github.com/ryankurte/rust-ptouch/workflows/Rust/badge.svg)

[![Crates.io](https://img.shields.io/crates/v/ptouch.svg)](https://crates.io/crates/ptouch)

[![Docs.rs](https://docs.rs/ptouch/badge.svg)](https://docs.rs/ptouch)

## Usage

### Utility

Install with `cargo install ptouch` or grab the latest release [here](https://github.com/ryankurte/rust-ptouch/releases/latest).

The utility supports a set of basic subcommands:

- `ptouch-util [SUBCOMMAND] --help` to show help options

- `ptouch-util [--media MEDIA] render --file=[OUTPUT] [OPTIONS]` to render to an `OUTPUT` image file

- `ptouch-util [--media MEDIA] preview [OPTIONS]` to render to a preview window (not available on all platforms)

- `ptouch-util print [OPTIONS]` to print

The `--media` argument sets the default media type when the printer is unavailable, otherwise this is loaded from the printer.

Each of `render`, `preview`, and `print` take a set of `[OPTIONS]` to configure the output, these options are:

- `text VALUE [--font=FONT]` to render text in the specified font, use `\n` for newlines

- `qr CODE` to render a QRCode with the provided value

- `qr-text CODE VALUE [--font=FONT]` to render a QRCode followed by text

- `image FILE` to render an image directly

- `template FILE` to load a `.toml` render template (see [example.toml](example.toml))

- `barcode CODE` to render a barcode (experimental, missing config options)

These CLI options are a subset of those available using the library intended to provide the basics. If you think there's something missing, feel free to open an issue / PR!

### API

This needs cleaning up before it's _reasonable_ to use... for usage see [src/util.rs](src/util.rs).

### Examples

```

ptouch-util --media tze24mm preview qr-text \

'https://github.com/ryankurte/rust-ptouch' \

'Rust PTouch Driver\n@ryankurte' --font=24x32`

```

![image](https://user-images.githubusercontent.com/860620/111896515-0c7e1000-8a7f-11eb-95e6-af5f7b18a1ae.png)

```

ptouch-util print qr-text \

"https://github.com/ryankurte/rust-ptouch" \

"Rust PTouch Driver\n@ryankurte" --font=24x32

```

![IMG_1840](https://user-images.githubusercontent.com/860620/111896577-9201c000-8a7f-11eb-9c5f-a5041dba9236.jpg)

## Resources

- [PT-P710BT Manual](https://support.brother.com/g/b/manualtop.aspx?c=eu_ot&lang=en&prod=p710bteuk)

- [Brother Raster Command Reference](https://download.brother.com/welcome/docp100064/cv_pte550wp750wp710bt_eng_raster_101.pdf)

- [Pytouch Cube python driver](https://github.com/piksel/pytouch-cube)