node-movehub

KO | EN

gitlite — search

#python #react #typescript #llm #golang #machine-learning #rust #macos #nodejs #java #pytorch #security #mcp #open-source

(★ 61)

Node.js interface for the Lego Boost Move Hub :robot: :cat: :guitar: :truck:

File Explorer

Download Latest Version (.zip)

- README.footer.md
- README.header.md
.gitignore
.travis.yml
Gulpfile.js
index.js
LICENSE
movehub.js
package.json
README.md
test.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# movehub

[![NPM version](https://badge.fury.io/js/movehub.svg)](http://badge.fury.io/js/movehub)
[![dependencies Status](https://david-dm.org/hobbyquaker/node-movehub/status.svg)](https://david-dm.org/hobbyquaker/node-movehub)
[![Build Status](https://travis-ci.org/hobbyquaker/node-movehub.svg?branch=master)](https://travis-ci.org/hobbyquaker/node-movehub)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![License][mit-badge]][mit-url]

> Node.js interface for the Lego Boost Move Hub 🤖 🐱 🎸 🚚

## Install

```
$ npm install movehub
```

If you want to utilize the new async/await syntax see https://github.com/ttu/node-movehub-async which is based
on this module.

## Usage example

See [test.js](test.js).

## API

## Classes

<dl>
<dt><a href="#Boost">Boost</a></dt>
<dd></dd>
<dt><a href="#Hub">Hub</a></dt>
<dd></dd>
</dl>

## Boost
**Kind**: global class

* [Boost](#Boost)
    * [.connect(address, callback)](#Boost+connect)
    * ["ble-ready" (bleReady)](#Boost+event_ble-ready)
    * ["hub-found" (hub)](#Boost+event_hub-found)
    * [.connectCallback](#Boost+connectCallback) : <code>function</code>

### boost.connect(address, callback)
**Kind**: instance method of [<code>Boost</code>](#Boost)

| Param | Type | Description |
| --- | --- | --- |
| address | <code>string</code> | MAC Address of the Hub |
| callback | [<code>connectCallback</code>](#Boost+connectCallback) |  |

### "ble-ready" (bleReady)
**Kind**: event emitted by [<code>Boost</code>](#Boost)

| Param | Type | Description |
| --- | --- | --- |
| bleReady | <code>boolean</code> | reports `true`/`false` when BLE is active |

### "hub-found" (hub)
Fires when a Move Hub is found

**Kind**: event emitted by [<code>Boost</code>](#Boost)

| Param | Type |
| --- | --- |
| hub | <code>object</code> | 
| hub.uuid | <code>string</code> | 
| hub.address | <code>string</code> | 
| hub.localName | <code>string</code> |

### boost.connectCallback : <code>function</code>
**Kind**: instance typedef of [<code>Boost</code>](#Boost)

| Param | Type | Description |
| --- | --- | --- |
| error | <code>null</code> \| <code>error</code> |  |
| hub | [<code>Hub</code>](#Hub) | instance of the Hub Class |

## Hub
**Kind**: global class

* [Hub](#Hub)
    * [.disconnect()](#Hub+disconnect)
    * [.motorTime(port, seconds, [dutyCycle], [callback])](#Hub+motorTime)
    * [.motorTimeMulti(seconds, dutyCycleA, dutyCycleB, callback)](#Hub+motorTimeMulti)
    * [.motorAngle(port, angle, [dutyCycle], [callback])](#Hub+motorAngle)
    * [.motorAngleMulti(angle, dutyCycleA, dutyCycleB, callback)](#Hub+motorAngleMulti)
    * [.led(color, [callback])](#Hub+led)
    * [.subscribe(port, [option], [callback])](#Hub+subscribe)
    * [.unsubscribe(port, [option], [callback])](#Hub+unsubscribe)
    * [.write(data, callback)](#Hub+write)
    * ["rssi" (rssi)](#Hub+event_rssi)
    * ["disconnect"](#Hub+event_disconnect)
    * ["connect"](#Hub+event_connect)
    * ["port" (port)](#Hub+event_port)
    * ["color" (color)](#Hub+event_color)
    * ["distance" (distance)](#Hub+event_distance)
    * ["tilt" (tilt)](#Hub+event_tilt)
    * ["rotation" (rotation)](#Hub+event_rotation)

### hub.disconnect()
Disconnect from Move Hub

**Kind**: instance method of [<code>Hub</code>](#Hub)  
<a name="Hub+motorTime"></a>

### hub.motorTime(port, seconds, [dutyCycle], [callback])
Run a motor for specific time