# node-dymo

> Node.js wrapper for Dymo scales

Latest version **1.0.1** (published 2015-11-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-dymo
pnpm add node-dymo
yarn add node-dymo
bun add node-dymo
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-11-20 |
| First published | 2015-11-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Scott Miller |
| Maintainers | screwyscotty |

## Links

- npm: https://www.npmjs.com/package/node-dymo
- Repository: https://github.com/sjmiller85/node-dymo
- Issues: https://github.com/sjmiller85/node-dymo/issues
- npm.io page: https://npm.io/package/node-dymo

## Dependencies (2)

- [usb](https://npm.io/package/usb.md) ^1.0.6
- [async](https://npm.io/package/async.md) ^1.5.0

## Recent versions

- 1.0.1 (latest) — 2015-11-20
- 1.0.0 — 2015-11-17

## README

# node-dymo

node-dymo is a Node.js wrapper that reads from a Dymo brand USB scale.  The wrapper provides several events as well as methods to read measurements from the scale.

## Quick Examples

```js
dymo.on('online', function() {
  console.log('scale was connected/powered on'); // ## ounces(/grams);
});

dymo.on('weight-change', function(obj) {
  console.log(obj.value + ' ' + obj.system); // ## ounces(/grams);
});

console.log(dymo.getWeight()); // { value: 10, system: 'grams' }
```

## Methods

node-dymo provides three methods you can call at any time:

* `connect()` Connect to the driver, and if a scale isn't immediately online, establish listeners until it becomes online.  This method is required in order to gain access to the below methods and listeners
* `getWeight()` Get the current weight on the scale. Returns an object containing the properties `value`, and `system`, with the numerical weight and either `ounces` or `grams` respectively
* `getOverweightStatus()` In the event the scale is overweight, this method will return `true`, otherwise `false`
* `getStatus()` returns either `true` or `false` if a scale is available or not.

## Events

* `online` A Dymo scale was connected and powered on
* `offline` A Dymo scale was powered off/disconnected
* `weight-change` Fires when the weight on the scale changes.  Passes an object to the event listener containing a numerical `value` property and either `ounces` or `grams` for the `system` property.
* `overweight-change` Fires when the weight on the scale exceeds it's maximum capacity.  Passes a `true` or `false` boolean to the event listener depending on whether or not the scale is over or under weight respectively.
* `weight` Fires when either the weight changes, or when the scale becomes overweight or underweight (combination of both `weight-change` and `overweight-change` events)
* `end` Fires when the scale errors or is powered off

---
_Source: https://npm.io/package/node-dymo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._