npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@code-dot-org/johnny-five

v2.1.0-cdo.3

Published

Code.org fork of rwaldron/johnny-five: The JavaScript Robotics and Hardware Programming Framework. Use with: Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Particle/Spark Core & Photo

Downloads

2,377

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bpcbbpcbsnickellsnickellstephenliangcodeorgstephenliangcodeorgsanchit.malhotra126sanchit.malhotra126mikeharvmikeharvmgc1194mgc1194alice-fisheralice-fisherdev-code-orgdev-code-orghammshammsdaynewdaynewjessicakulwikjessicakulwikbethanycodeorgbethanycodeorgbrevillebrevillemoenmmoenmhannah.bergamhannah.bergam

Keywords

0A020A2116x2 LCD20x4 LCD2D120X2Y0A022Y0A2174HC595ADXL335ADXL345ALS-PT19ALSPT19ANALOGarduinoArdumotoAT42QT1070BLINKMBMP180Continuous RotationDEFAULTDiffused LEDDS18B20Edison Arduino BlockEdison GPIO BlockEdison I2C BlockEdison PWM BlockedisonESPLORAEV3firmatagalileo-iogalileoGP2D120XJ00FGP2Y0A02YK0FGP2Y0A21YKGP2Y0A41SK0FGY-521GY521HD44780High TorqueHitec HS-35HDHitec HS-422Hitec HS-425BBHitec HS-625MGHitec HS-646WPHitec HS-755HBHitec HS-805BBHitec HS-85MGHMC5883LHMC6352Hobby MotorHRLV-MaxSonar-EZ0HT16K33HTU21Di2cInfrared Proximity SensorInfrared Sensorintel edisonintel galileoISL29125JHD1313M1JoystickJoystickLCD1602LCD2004LCM1602LEDLIDAR-Lite v2Ludus Protoshield WirelessLudus ProtoshieldLV-MaxSonar-EZ0LV-MaxSonar-EZ3MCP23008MCP23017MCP9808Metal GearMJKDZMMA7361MMA7660MMA8462QMPL115A2MPL3115A2MPR121MPR121QR2MPU-6050MPU6050MUXSHIELD2NXTOA41SKPARALLELparticlePCA9685pcduinoPCF8574PCF8574APCF8574ATPCF8574TPCF8575PCF8591photonPIR Motion SensorQTOUCHraspberry piraspberry piraspberrypiraspi-ioRedBoardRGB LEDrobotroboticsrpiserialserialportServoShift Register 8-Bit SN74HC595Shift RegisterSI7020spark corespark-iosparkSparkFun Essential Sensor KitSparkFun Sensor KitSpeed controllerTemperaturetessel 2Thumb JoystickTINKERKITTMP36TSL2561Ultrasonic Range FinderusbVKEYWeather Shield ArduinoWeather Shield Photon

Readme

Johnny-Five

The JavaScript Robotics Programming Framework

Artwork by Mike Sgier

Travis Build Status

This is the Code.org fork of johnny-five. Please check out the main project here!

This project was forked in 2017 to provide better support for the Adafruit Circuit Playground which is used in the Code.org curriculum. The project was updated to the latest release of its upstream in September 2022, and Code.org customizations were then re-implemented.

Source Code:

git clone https://github.com/code-dot-org/johnny-five

cd johnny-five

npm install

Building and testing with apps

This is the most typical use case for @code-dot-org/johnny-five fork development.

Apps (aka Code Studio) is a set of apps which installs and references this package. You can run the dashboard locally from the apps directory using bin/dashboard-server (setup reference)

You can use yarn add for local development and testing.

cd {code-dot-org repo directory}/apps
yarn add <file-path-to-local-folder>

When you are finished testing locally, you can run yarn @code-dot-org/johnny-five to install the npm package instead of the local package.

Note that a copy of the local johnny-five package was added to your node_modules directory so that changes in @code-dot-org/johnny-five are not automatically transferred to @code-dot-org/code-dot-org/apps/node_modules. Thus, you must run yarn add <file-path-to-local-folder> again after any changes in the local johnny-five package.

In addition, there are changes to your package.json and yarn.lock locally that you do not want to commit.

Testing

You can lint and test your code (unit tests included in test/) using the grunt command. Remember to add or update unit tests for any new or changed functionality.

There are additional tests in Apps within apps/test/unit/lib/kits/boards/circuitPlayground and apps/test/unit/lib/kits/boards that you can run locally to test any new updates within johnny-five. Refer to testing.md.

Updating README

If you'd like to make changes to the readme contents, please make them in the tpl/.readme.md file. Then generated the markdown with: grunt examples.

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

Johnny-Five has grown from a passion project into a tool for inspiring learning and creativity for people of all ages, backgrounds, and from all across the world.

Just interested in learning and building awesome things? You might want to start with the official Johnny-Five website.

  • If you want to find the API documentation, that’s right here.
  • Need to figure out what platform to use for a project? We put that stuff here.
  • Need inspiration for your next NodeBot? Check out the examples.
  • Want to stay up-to-date with projects in the community? Check this out.
  • Need NodeBots community or Johnny-Five project updates and announcements? This is what you’re looking for.

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

Hello Johnny

The ubiquitous "Hello World" program of the microcontroller and SoC world is "blink an LED". The following code demonstrates how this is done using the Johnny-Five framework.

const { Board, Led } = require("johnny-five");
const board = new Board();

board.on("ready", () => {
  // Create an Led on pin 13
  const led = new Led(13);
  // Blink every half second
  led.blink(500);
});

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.

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 > StandardFirmataPlus
    • StandardFirmataPlus is available in Firmata v2.5.0 or greater
  • 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/rwaldron/johnny-five.git && cd johnny-five

npm install

npm package:

Install the module with:

npm install johnny-five

Example Programs

To get you up and running quickly, we provide a variety of examples for using each Johnny-Five component. One thing we’re especially excited about is the extensive collection of Fritzing diagrams you’ll find throughout the site. A huge part of doing any Johnny-Five project is handling the actual hardware, and we’ve included these as part of the documentation because we realised that instructions on how to write code to control a servo are insufficient without instructions on how to connect a servo!

To interactively navigate the examples, visit the Johnny-Five examples page on the official website. If you want to link directly to the examples in this repo, you can use one of the following links.

There are presently 362 example programs with code and diagrams!

Board

LED

LED: RGB

LED: Digits & Matrix

Servo

GPS

Servo Animation

Color

Motor

Stepper Motor

ESC & Brushless Motor

Button / Switch

Keypad

Relay

Shift Register

Infrared Reflectance

Proximity

Motion

Joystick

LCD

Compass/Magnetometer

Piezo

IMU/Multi

Sensors

Expander

Photon Weather Shield

Lego EVShield

Intel Edison + Grove IoT Kit

Grove IoT Kit (Seeed Studio)

Micro Magician V2

TinkerKit

Wii

Complete Bots / Projects

Component Plugin Template

IO Plugins

Many fragments. Some large, some small.

Wireless Nodebot

Kinect Controlled Robot Arm

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

Build you own drone

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 [email protected] Licensed under the MIT license. Copyright (c) 2014, 2015 The Johnny-Five Contributors Licensed under the MIT license.