myo-ts/README.md

Typescript and Javascript bindings for Myo, refactored to provide a clean interface

# myo-ts

[![Build Status](https://travis-ci.org/ltetzlaff/myo-ts.svg?branch=master)](https://travis-ci.org/ltetzlaff/myo-ts)

<!--[![NPM](https://nodei.co/npm/myo.png)](https://nodei.co/npm/myo/)-->

Myo javascript bindings.

Myo.js allows you to interact with Thalmic Labs's [Myo Gesture Control Armband](http://myo.com) using websockets. Listen for IMU, EMG, and gesture events, as well as controlling vibration and locking.

Examples can be found here [myo-tests](https://github.com/ltetzlaff/myo-tests).

## Installation

Currently only intended for browser usage, will re-add node compatibility.

```bash
npm i myo-ts
```

<!---
On the browser, just include the `myo.js` file in your project. `Myo` will be global.

On node.js

```bash
npm install myo ws
```

--->

### Usage

You"ll need a [Myo](http://myo.com) and [Myo Connect](https://developer.thalmic.com/downloads)

```js
import myo from "myo"

myo.connect("com.stolksdorf.myAwesomeApp")

myo.on("fist", myo => {
	console.log("Hello Myo!")
	myo.vibrate()
})
```

## Myo Lifecycle

A myo can be **paired**, **connected**, and/or **synced**.

A myo is **paired** if it's ever been connected to your computer. You can see a list of paired myos in Myo Connect's armband manager. When `Myo.connect()` is called, Myo.js will create a myo instance for every paired Myo on your computer and store them in `Myo.myos` array.

A myo is **connected** if it's turned on and connected to your computer over bluetooth. It can send over IMU events at this point, vibrate, and EMG (if `myo.streamEMG(true)` is called) but not poses since it's not synced with the user.

A myo is **synced** when the user puts it on and does the sync gesture. At this point it will start sending over pose and lock/unlock events.

## Branding and Assets

You can use assets provided in Thalmic's [branding](https://developer.thalmic.com/branding/) and [UX](https://developer.thalmic.com/ux/) guidelines.

## Documentation

You can read the full documention in [docs.md](docs.md)

## Changelog

Releases are documented in [changelog.md](changelog.md), for recent minor changes just see commit log.

## License

The Myo.js project is licensed using the modified BSD license. For more details, please see [LICENSE.txt](LICENSE.txt).

## Contributors

Thanks to [stolksdorf](https://github.com/stolksdorf) for creating the original js wrappers.

This repo is maintained by [ltetzlaff](https://github.com/ltetzlaff).