https://github.com/webduinoio/webduino-js

⚙️ The Webduino Javascript Core, for Browser and Node.js
https://github.com/webduinoio/webduino-js

arduino firmata javascript mqtt nodejs webduino

Last synced: 4 days ago
JSON representation

⚙️ The Webduino Javascript Core, for Browser and Node.js

• Host: GitHub
• URL: https://github.com/webduinoio/webduino-js
• Owner: webduinoio
• License: mit
• Created: 2015-06-10T09:27:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-16T14:52:37.000Z (over 1 year ago)
• Last Synced: 2024-10-15T00:33:17.474Z (2 months ago)
• Topics: arduino, firmata, javascript, mqtt, nodejs, webduino
• Language: JavaScript
• Homepage: https://webduino.io
• Size: 1.1 MB
• Stars: 71
• Watchers: 20
• Forks: 24
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# webduino-js

The Webduino Javascript Core, for Browser and Node.js

## Installation

#### Browser

Using [bower](http://bower.io):

```sh

$ bower install webduino-js#dist

```

Insert scripts:

```html

... (modules used)

```

Or all-in-one:

```html

```

#### Node.js

```sh

$ npm install webduino-js

```

## Usage

**webduino-js** provides isomorphic APIs:

```javascript

var webduino = require('webduino-js');

var board, led;

board = new webduino.WebArduino('device_id');

board.on('ready', function() {

  led = new webduino.module.Led(board, board.getDigitalPin(10));

  led.on();

});

```

## Transports

**webduino-js** talks to Webduino Dev Board via MQTT by default. However, since **webduino-js** speaks [Firmata](https://www.arduino.cc/en/Reference/Firmata), we can also _directly_ talk to standard Arduino or any dev board that understands firmata.

Currently we have transports supporting USB serial port and Bluetooth (HC-06 tested) communications: _(Note: you have to install Firmata library first)_

* [webduino-serial-transport](https://github.com/webduinoio/webduino-serial-transport)

* [webduino-bluetooth-transport](https://github.com/webduinoio/webduino-bluetooth-transport)

## See Also

* [Webduino Dev Board and Webduino Dev Kit](https://webduino.io)

* [The Firmata Protocol](https://github.com/firmata/protocol)

* [Arduino Firmata Installation](http://www.instructables.com/id/Arduino-Installing-Standard-Firmata)

## License

This project is licensed under MIT license, see [LICENSE](LICENSE) for more information.