Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
JavaScript Robotics and IoT programming framework, developed at Bocoup. Based on Arduino Firmata Protocol
JavaScript

Merge pull request #673 from rwaldron/647

ESC: Update to controller model. Adds PCA9685. Closes gh-647
latest commit 8493db5522
@rwaldron authored

README.md

Node-isassemble Johnny-Five

Artwork by Mike Sgier

Build Status Gitter

Johnny-Five is an Open Source, Firmata Protocol based, IoT and Robotics programming framework, developed at Bocoup. Johnny-Five programs can be written for Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Spark Core, TI Launchpad and more!

Johnny-Five does not attempt to provide "all the things", but instead focuses on delivering robust, reality tested, highly composable APIs that behave consistently across all supported hardware platforms. Johnny-Five wants to be a baseline control kit for hardware projects, allowing you the freedom to build, grow and experiment with diverse JavaScript libraries of your own choice. Johnny-Five couples comfortably with:

...And that's only a few of the many explorable possibilities. Check out these exciting projects: node-pulsesensor, footballbot-workshop-ui, nodebotui, dublin-disco, node-slot-car-bot, servo-calibrator, node-ardx, nodebot-workshop, phone-home, purple-unicorn, webduino, leapduino, lasercat-workshop, simplesense, five-redbot, robotnik, the-blender

Why JavaScript? NodeBots: The Rise of JavaScript Robotics

Supported Hardware

Johnny-Five has been tested on a variety of Arduino-compatible Boards.

For non-Arduino based projects, a number of platform-specific IO Plugins are available. IO Plugins allow Johnny-Five code to communicate with any non-Arduino based hardware in whatever language that platforms speaks!

Documentation

Documentation for the Johnny-Five API can be found here and example programs here.

Guidance

Need help? Ask a question on the NodeBots Community Forum. If you just have a quick question or are interested in ongoing design discussions, join us in the Johnny-Five Gitter Chat.

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

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

Check out the bluetooth guide if you want to remotely control 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.

For non-Arduino projects, each IO Plugin's repo will provide its own platform specific setup instructions.

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.

Wireless Nodebot NEW!

Kinect Controlled Robot Arm NEW!

Biped Nodebot

LCD Running Man

Slider Controlled Panning Servo

Joystick Controlled Laser (pan/tilt) 1

Joystick Controlled Laser (pan/tilt) 2

Joystick Controlled Claw

Robot Claw

Joystick, Motor & Led

Example Programs

Board

LED

Servo

Servo Animation

Motor

Stepper Motor

ESC & Brushless Motor

Sonar/Ultrasonic

Button

Relay

Shift Register

Infrared (Proximity, Motion, Reflectance)

Joystick

LCD

Compass/Magnetometer

Piezo

IMU

Sensors

Plugin Template

Grove IoT Kit (Seeed Studio)

TinkerKit

Wii

Make: JavaScript Robotics

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, 2015 The Johnny-Five Contributors Licensed under the MIT license.

Something went wrong with that request. Please try again.