# speeduino-comm

> Communicate with Speeduino over a serial port

Latest version **1.0.0** (published 2021-08-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install speeduino-comm
pnpm add speeduino-comm
yarn add speeduino-comm
bun add speeduino-comm
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-08-20 |
| First published | 2021-08-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 34 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | rob-deutsch |

## Links

- npm: https://www.npmjs.com/package/speeduino-comm
- npm.io page: https://npm.io/package/speeduino-comm

## Dependencies (2)

- [prompt](https://npm.io/package/prompt.md) ^1.1.0
- [serialport](https://npm.io/package/serialport.md) ^9.2.0

## Recent versions

- 1.0.0 (latest) — 2021-08-20

## README

# js-speeduino-comm

This Node library communicates with a Speeduino over a serial port.

It is very much a work-in-progress.

commands.csv shows all the commands supported by the current Speeduino firmware (202108) and how they map to js-speeduino-comm

## Installation

```
yard add speeduino-comm
```

## Sample code
Typescript:
```typescript
#!/usr/bin/env node

import { SpeeduinoComm } from '../SpeeduinoComm'
const speedy = new SpeeduinoComm({path: '/dev/tty.USB0'})

speedy.open((err) => {
    if (err) { throw err }

    speedy.signature().then(response => console.log("Signature:", response))
    speedy.versionInfo().then(response => console.log("Version info:", response))
    speedy.loopsPerSecond().then(response => console.log("Loops per second:", response))
})
```

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