Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@beuluis/thermal-mqttastic

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@beuluis/thermal-mqttastic

Wrapper for my adafruit thermal printer api

  • 0.0.1-1688461072.99b4a5181c36d8bac3931a4e15f1e6c4db60dbe3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Contributors Forks Stargazers Issues


ThermalMqttastic

Control a Adafruit thermal printer over mqtt. This library is very WIP.

· Report Bug · Request Feature ·

About The Project

I wanted to talk to a thermal printer over an api. I experimented with a esp32 and quickly came to its limits.

After investigating the Adafruit library and many many failed other attempts, I concluded that I can extract the heavy lifting to TypeScript and only run a light mqtt to serial implementation on the esp32.

So now you can utilize the versatile package landscape of NPM to generate bitmaps, wrap it in REST APIs and and and.

Installation

npm i @beuluis/thermal-mqttastic

Unstable installation

The next dist-tag is kept in sync with the latest commit on main. So this contains always the latest changes but is highly unstable.

npm i @beuluis/thermal-mqttastic@next

Usage

:warning: You need the corresponding arduino MQTT client also listening: See WIP for more details.

const printer = new ThermalMqttastic({
    mqttUrl: 'mqtt://localhost:1883',
    mqttOptions: {
        password: '12345678',
    },
});

await printer.begin();

await printer.println('Hello World!');

MQTT connection

mqttOptions is the option interface of the MQTT package. Please refer to this documentation on how to establish the connection.

Functions

Parameters get validated using zod. Please refer to this documentation on how the parameters get validated.

setTimes(dotPrintTime: number, dotFeedTime: number)

This method sets the times (in microseconds) for the paper to advance one vertical 'dot' when printing and when feeding.

Parameter constrains:
  • z.number().int().nonnegative().parse(dotPrintTime);
  • z.number().int().nonnegative().parse(dotFeedTime);
Example
printer.setTimes(10, 15);

print(message: string)

Prints the message.

Example
await printer.print('Hello World!');

println(message: string)

Prints the message with a line break at the end.

Example
await printer.println('Hello World!');

begin(firmware = 268)

Initializes the printer and set default values. Needs to be called before performing any operations!

Parameter constrains:
  • z.number().int().nonnegative().parse(firmware);
Example
await printer.begin();

reset()

Resets the printer!

Example
await printer.begin();

setDefaults()

Resets all text formatting back to the defaults.

Example
await printer.setDefaults();

test()

Prints a test.

Example
await printer.test();

testPage()

Prints a test page.

Example
await printer.testPage();

setBarcodeHeight(barcodeHeight = 50)

Sets the printing height of the barcode.

Parameter constrains:
  • z.number().int().nonnegative().parse(barcodeHeight);
Example
await printer.setBarcodeHeight(60);

printBarcode(text: string, type: Barcode)

Prints a barcode.

Parameter constrains:
  • z.string().max(255).parse(text);
Example
await printer.printBarcode('ADAFRUT', Barcode.CODE39);

normal()

Sets print mode to normal.

Example
await printer.normal();

inverseOn()

Turn on inverse print mode.

Example
await printer.inverseOn();

inverseOff()

Turn off inverse print mode.

Example
await printer.inverseOff();

upsideDownOn()

Turn on upside down print mode.

Example
await printer.upsideDownOn();

upsideDownOff()

Turn off upside down print mode.

Example
await printer.upsideDownOff();

doubleHeightOn()

Turn on double height print mode.

Example
await printer.doubleHeightOn();

doubleHeightOff()

Turn off double height print mode.

Example
await printer.doubleHeightOff();

doubleWidthOn()

Turn on double width print mode.

Example
await printer.doubleWidthOn();

doubleWidthOff()

Turn off double width print mode.

Example
await printer.doubleWidthOff();

strikeOn()

Turn on strike print mode.

Example
await printer.strikeOn();

strikeOff()

Turn off strike print mode.

Example
await printer.strikeOff();

boldOn()

Turn on bold print mode.

Example
await printer.boldOn();

boldOff()

Turn off bold print mode.

Example
await printer.boldOff();

justify(value: 'C' | 'L' | 'R' = 'L')

Justifies the content.

Example
await printer.justify('C');

feed(lines = 1)

Feeds lines of paper.

Parameter constrains:
  • z.number().int().min(1).parse(lines);
Example
await printer.feed(2);

feedRows(rows = 1)

Feeds rows of paper.

Parameter constrains:
  • z.number().int().min(1).parse(rows);
Example
await printer.feedRows(2);

flush()

Flush the printer.

Example
await printer.flush(2);

setSize(value: 'L' | 'M' | 'S' = 'S')

Set the text size.

Example
await printer.setSize('L');

setPrintDensity(density = 10, breakTime = 2)

Sets the printer density.

Parameter constrains:
  • z.number().int().nonnegative().max(31).parse(density);
  • z.number().int().nonnegative().max(7).parse(breakTime);
Example
await printer.setPrintDensity(11, 3);

underlineOn()

Turn on underline.

Example
await printer.underlineOn();

underlineOff()

Turn off underline.

Example
await printer.underlineOff();

printBitmap(width: number, height: number, bitmap: number[])

:warning: WIP

Prints a bitmap.

Parameter constrains:
  • z.number().int().nonnegative().max(384).parse(width);
  • z.number().int().min(1).parse(height);
  • z.array(z.number().int().nonnegative().max(255)).parse(bitmap);
Example
await printer.printBitmap(2, 2, [0, 255, 255, 0]);

offline()

Take the printer offline. Print commands sent after this will be ignored until online is called.

Example
await printer.offline();

online()

Take the printer online.

Example
await printer.online();

sleep()

Put the printer into a low-energy state immediately.

Example
await printer.sleep();

sleepAfter(seconds: number)

Put the printer into a low-energy state after the given number of seconds.

Parameter constrains:
  • z.number().int().min(1).parse(seconds);
Example
await printer.sleepAfter(1);

wake()

Wake the printer from a low-energy state.

Example
await printer.wake();

setMaxChunkHeight(value = 256)

Set maximum chunk height for bitmap printing.

Parameter constrains:
  • z.number().int().min(1).parse(value);
Example
printer.setMaxChunkHeight(200);

setCharset(value = 0)

Set maximum chunk height for bitmap printing. May only work in recent firmware.

Parameter constrains:
  • z.number().int().nonnegative().max(15).parse(value);
Example
printer.setCharset(10);

setCodePage(value = 0)

Select alternate characters for upper ASCII. May only work in recent firmware.

Parameter constrains:
  • z.number().int().nonnegative().max(47).parse(value);
Example
await printer.setCodePage(12);

tab()

Print a tab. May only work in recent firmware.

Example
await printer.tab();

setFont(font: 'A' | 'B' = 'A')

Sets font type. May only work in recent firmware.

Example
await printer.setFont('B');

setCharSpacing(spacing = 0)

Set character spacing. May only work in recent firmware.

Parameter constrains:
  • z.number().int().nonnegative().parse(spacing);
Example
await printer.setCharSpacing(10);

Debugging

You can enable the debugging logger when you provide a logger to the constructor.

const printer = new ThermalMqttastic({
    mqttUrl: 'mqtt://localhost:1883',
    mqttOptions: {
        password: '12345678',
    },
    logger: console,
});

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Luis Beu - me@luisbeu.de

Keywords

FAQs

Package last updated on 04 Jul 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc