/johnny-five

Firmata based Arduino Framework

Primary LanguageJavaScriptMIT LicenseMIT

Node-isassemble Johnny-Five

Build Status

Johnny-Five is an Open Source, JavaScript Arduino programming framework, developed at Bocoup.

Johnny-Five artwork by Mike Sgier

IO Plugins

For non-Arduino based projects, the following platform IO Plugins are available:

Documentation

Documentation for the Johnny-Five API can be found here

Guidance

For step-by-step examples, including an electronics primer, check out Arduino Experimenter's Guide for NodeJS by @AnnaGerber

Here is a list of prerequites for Linux, OSX or Windows.

Check out the bluetooth guide if you want to remotely controll your robot.

Setup and Assemble Arduino

  • Recommended Starting Kit: Sparkfun Inventor's Kit
  • Download Arduino IDE
  • Plug in your Arduino or Arduino compatible microcontroller via USB
  • Open the Arduino IDE, select: File > Examples > Firmata > StandardFirmata
  • Click the "Upload" button.

If the upload was successful, the board is now prepared and you can close the Arduino IDE.

Hey you, here's Johnny!

Source Code:

git clone git://github.com/rwldrn/johnny-five.git && cd johnny-five

npm install

npm package:

Install the module with:

npm install johnny-five

Johnny-Five is...

var five = require("johnny-five"),
    // or "./lib/johnny-five" when running from the source
    board = new five.Board();

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

  // Create an Led on pin 13 and strobe it on/off
  // Optionally set the speed; defaults to 100ms
  (new five.Led(13)).strobe();

});

Watch it here!

Note: Node will crash if you try to run johnny-five in the node REPL, but board instances will create their own contextual REPL. Put your script in a file.

Many fragments. Some large, some small.

Example Programs

Board

JSConf

Nodebots

Servo

Motor

Stepper

ESC & Brushless Motor

Sonar/Ultrasonic

Button

Relay

Claw

Gripper

Infrared

Joystick

LCD

LED

Magnetometer (Compass)

NodeConf Demos

Sound

Kinect

Wii

Sensors

TinkerKit

Spark

Contributing

All contributions must adhere to the Idiomatic.js Style Guide, by maintaining the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

License

Copyright (c) 2012, 2013, 2014 Rick Waldron waldron.rick@gmail.com Licensed under the MIT license. Copyright (c) 2014 The Johnny-Five Contributors Licensed under the MIT license.