arduino-serial-api v0.0.4

Arduino-serial-api

Simple nodejs module to communicate with arduino using serial port.

Install

run fr.thomas-maugin.arduino-1.0-SNAPSHOT.jar :

java -Xmx20m -jar fr.thomas-maugin.arduino-1.0-SNAPSHOT.jar

Then install the module :

npm install arduino-serial-api --save

Usage

var arduinoSerialAPI = require('arduino-serial-api');         // call arduino-api
var API = arduinoSerialAPI();                                 // create our API
API.connect(115200,'http://127.0.0.1:8080',function(rep){     // connect to Arduino with baud rate at 115200
    console.log(rep.status);                                  // get status : ["OPEN", "CLOSED"]
    if(rep.status === "OPEN")
    {
        API.send({
                led : {
                    "r" : 0,
                    "g" : 0,
                    "b" : 255
                }
            },function(resp){
          console.log(resp);                                   // log response
        });
    }
});

Methods

connect (baudrate, callback)

Connect to the first arduino with the specified baudrate.

baudrate

The baudrate speed of the serial port to open. For example, 9600 or 115200. Defaults to 9600. Should be one of: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200.

callback

Callback function returning a string corresponding to the connection status. For example "CLOSED" or "OPEN".

send (data, callback)

Send the data object to the arduino. For example {led : "on"}.

callback

Callback function returning an object corresponding to the parsed json string of the arduino. For example {status : "ok"}.

getState ()

Return an object corresponding to the conneciton status. For example {open: false, closed: true}.