https://github.com/darnfish/escpos-image-processor

Image processing for escpos-compatable printers
https://github.com/darnfish/escpos-image-processor

canny-edge-detection escpos escpos-image escpos-printable-image

Last synced: 15 days ago
JSON representation

Image processing for escpos-compatable printers

• Host: GitHub
• URL: https://github.com/darnfish/escpos-image-processor
• Owner: darnfish
• License: mit
• Created: 2018-10-25T14:43:59.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T23:02:34.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T09:06:41.407Z (about 1 month ago)
• Topics: canny-edge-detection, escpos, escpos-image, escpos-printable-image
• Language: TypeScript
• Homepage:
• Size: 9.55 MB
• Stars: 8
• Watchers: 0
• Forks: 2
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @printurmessages/escpos-image-processor

A library that converts an image into an escpos-printable image

## Installation

This library is available on the [NPM registry](https://www.npmjs.com/package/@printurmessages/escpos-image-processor). To install, run

```

npm install @printurmessages/escpos-image-processor --save

```

If you're using [Yarn](https://yarnpkg.com), run

```

yarn add @printurmessages/escpos-image-processor

```

## Usage

```javascript

// Import the package

import ESCPOSImageProcessor from '@printurmessages/escpos-image-processor'

// Create an instance of the class

const processor = new ESCPOSImageProcessor({

    width: 185, /* optional, defaults to 185 (default 40mm printer roll width in px) */

    quality: 'best' /* optional, defaults to 'best' (slowest). another option is 'good', which is faster but produces worse results */

})

// Put the path to your image in the first parameter ('.in.png') and put the location where the image should be saved in the second parameter ('./processed.png').

processor.convert('./in.png', './processed.png').then(path => {

    // The callback will return the path if all went well, if there was an error it will return 'false'.

    if(path)

        console.log(`Processed image saved to ${path}`)

    else

        console.log('An Error Occurred')

}).catch(error => console.error(error))

```

## Usage with `escpos`

If you wish to use `escpos-image-processor` with the `escpos` module, look at the example below:

```javascript

import escpos from 'escpos'

import ESCPOSImageProcessor from '@printurmessages/escpos-image-processor'

const device  = new escpos.USB()

const printer = new escpos.Printer(device)

const processor = new ESCPOSImageProcessor({

    width: 185,

    quality: 'best'

})

processor.convert('./in.png', './processed.png').then(path => {

    if(path) {

        console.log(`Processed image saved to ${path}, printing...`)

        processor.print(device, printer)

    } else

        console.log('An Error Occurred')

}).catch(error => console.error(error))

```

## License

`escpos-image-processor` is licensed under the MIT License.