thermal-print 0.2.0

An almost fully featured, no-std-compatible embedded-hal driver for the CSN-A2 thermal printer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# `thermal-print`
![Crates.io](https://img.shields.io/crates/v/thermal-print?style=flat-square)
![Crates.io](https://img.shields.io/crates/l/thermal-print?style=flat-square)

## Summary
`thermal-print` provides a serial interface driver for the ESC/POS implementation of the CSN-A2 thermal printer sold by [Adafruit](https://www.adafruit.com/product/597) and others. The crate should be supported on all platforms targeted by `embedded-hal` which possess a dynamic allocator, and it is `#![no_std]`-compatible.

## Functionality
`thermal-print` still lacks some minor functionality, but already supports

 - [x] text formatting (such as justification, selecting a print mode, and choosing fonts),
 - [x] printing barcodes,
 - [x] bitmap printing (via the `tinybmp` crate).

## Usage
Just depend on the crate in your Cargo manifest:
```
[dependencies]
thermal-print = "0.2"
```

Now you can bring the crate into scope:
```
use thermal_print::*
```

Bitmap printing depends on the [TinyBMP](https://crates.io/crates/tinybmp) crate. See the example on printing bitmaps below.

## Examples
### Setup, Formatting, and Printing Text
This example initializes the printer, configures font `B`, sets the justification to center and prints `Hello, world!` onto the paper.

```
  // Configure the serial interface for your platform
  let config = serial::config::Config::default()
      .baudrate(Hertz(19_200));
  let mut serial: serial::Serial<serial::UART1, _, _> = serial::Serial::new(
      peripherals.uart1,
      serial::Pins {
          tx: peripherals.pins.gpio21,
          rx: peripherals.pins.gpio19,
          cts: None,
          rts: None,
      },
      config
    ).expect("Error while configuring UART!");

  // Construct a new `Printer` with the serial interface and a `delay` implementation for 
  // blocking while the printer prints
  let mut printer = Printer::new(serial, delay::FreeRtos);
  printer.init();
  
  printer.set_print_mode(
    PrintModeBuilder::default()
      .font(Font::FontB)
      .build()
      .unwrap()
    );
  printer.set_justification(Justification::Center);

  writeln!(printer, "Hello, world!");
```

### Printing Bitmaps
This example prints a bitmap embedded via the `include_bytes!` macro. It assumes you have added `tinybmp` as a dependency to your manifest, and that a suitable bitmap file `./resources/ferris.bmp` is present in your project. See the documentation on further information on bitmap printing.

```
use tinybmp::RawBmp;

printer.print_bitmap(
  RawBmp::from_slice(
    include_bytes!("../resources/ferris.bmp")
  ).unwrap(),
  RasterBitImageMode::Normal
);
```

## Feature Flags
 - `std`: This enables linking against the Rust standard library. It is _disabled_ by default.
 - `embedded-hal-nb`: Use embedded-hal-nb traits for UART
 - `embedded-io`: Use embedded-io traits for UART

## Bug Reports and Feature Requests
Contributions to this project are welcome. You can find the [issue tracker](https://todo.sr.ht/~doesnotcompete/thermal-print) and the [code repository](https://git.sr.ht/~doesnotcompete/thermal-print) at sourcehut. You may also submit bug reports or feature requests via email to [~doesnotcompete/thermal-print@todo.sr.ht](mailto:~doesnotcompete/thermal-print@todo.sr.ht).