Wondering what’s next for npm?Check out our public roadmap! »

tinker-io

2.0.0 • Public • Published

Tinker-io

Tinker-io is a Firmata-compatibility IO class for writing node programs that interact with Particle devices (formerly Spark). Tinker-io was built at IcedDev

Caveat

This is a very simplified IO class. It is meant to be used over the particle cloud using the default Tinker sketch that ships on the device.

For a full-featured IO class you should be using particle-io

Getting Started

In order to use the tinker-io library, you will need to use the default Tinker sketch.

The host computer (where you're running your Node.js or Web application) and the Particle do NOT have to be on the same local network.

Blink an Led

The "Hello World" of microcontroller programming:

var TinkerIO = require("tinker-io");
var board = new TinkerIO({
  token: YOUR_PARTICLE_TOKEN,
//  optional - you can use your username/password instead of token  
//  username: YOUR_PARTICLE_USERNAME_EMAIL,
//  password: YOUR_PARTICLE_PASSWORD,
  deviceName: YOUR_DEVICE_NAME
});
 
board.on("ready", function() {
  console.log("CONNECTED");
  this.pinMode("D7", this.MODES.OUTPUT);
 
  var byte = 0;
 
  // This will "blink" the on board led
  setInterval(function() {
    this.digitalWrite("D7", (byte ^= 1));
  }.bind(this), 500);
 
  this.pinMode("A1", five.Pin.ANALOG);
  this.analogRead("A1", function(voltage) {
    console.log("analog read", voltage);
  });
 
  this.pinMode("D1", five.Pin.INPUT);
  this.digitalRead("D1", function(value) {
    console.log('digital read', value);
  });
});

Johnny-Five IO Plugin

Tinker-IO can be used as an IO Plugin for Johnny-Five:

var five = require("johnny-five");
var TinkerIO = require("tinker-io");
var board = new five.Board({
  io: new TinkerIO({
    token: YOUR_PARTICLE_TOKEN,
    deviceId: YOUR_PARTICLE_DEVICE_ID
  })
});
 
board.on("ready", function() {
  var led = new five.Led("D7");
  led.blink();
 
  var sensor = new five.Sensor("A0");
 
  // When the sensor value changes, log the value
  sensor.on("change", function() {
    console.log(this.value);
  });
 
});

Install

npm i tinker-io

DownloadsWeekly Downloads

7

Version

2.0.0

License

ISC

Last publish

Collaborators

  • avatar