niimbluelib/README.md

## NiimBlueLib [![NPM](https://img.shields.io/npm/v/@mmote/niimbluelib)](https://npmjs.com/package/@mmote/niimbluelib)

> [!WARNING]
>
> This project is intended for informational and educational purposes only.
> The project is not affiliated with or endorsed by the original software or hardware vendor,
> and is not intended to be used for commercial purposes without the consent of the vendor.

[Documentation](https://multimote.github.io/niimbluelib/)

NiimBlueLib is a library for the communication with NIIMBOT printers.
Used in [NiimBlue](https://github.com/MultiMote/niimblue) project.

NiimBlueLib provides the most accurate open source implementation of the NIIMBOT printers protocol.

This project is in Alpha state. Use only exact version when you add it to your project. API can be changed anytime.

Check out the experimental [niimbluelib-headless](https://github.com/MultiMote/niimbluelib-headless) for CLI use cases.

### Installation

Yarn:

```bash
yarn add @mmote/niimbluelib --exact
```

### Usage example

See [example/main.js](example/main.js)

### Misc

Eslint not included. Install it with:

```
npm install --no-save --no-package-lock eslint@9.x globals @eslint/js typescript-eslint
```