@code-dot-org/johnny-five

v2.1.0-cdo.3

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 For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

51 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.1.0-cdo.3	\|	12/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (577)

GitHub Stars: 1
Forks: 3
Contributors: 130

Direct Usage Popularity

The npm package @code-dot-org/johnny-five receives a total of 577 downloads a week. As such, we scored @code-dot-org/johnny-five popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @code-dot-org/johnny-five, we found that it has been starred 1 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 130
Funding: No

A good and healthy external contribution signal for @code-dot-org/johnny-five project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of @code-dot-org/johnny-five based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @code-dot-org/johnny-five is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 9 Direct
Versions: 12
Install Size: 672 kB
Dist-tags: 1
# of Files: 57
Maintainers: 15
TS Typings: No

@code-dot-org/johnny-five has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Johnny-Five

The JavaScript Robotics Programming Framework

Artwork by Mike Sgier

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

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 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:

Popular application libraries such as Express.js and Socket.io.
Fellow hardware projects like ar-drone, Aerogel and Spheron
Bluetooth game controllers like XBox Controller and DualShock
IoT frameworks, such as Octoblu

...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", () =&gt; {
  // 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 &amp;&amp; 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

Piezo

IMU/Multi

Sensors

Expander

Photon Weather Shield

Photon Weather Shield: Moisture

Lego EVShield

Intel Edison + Grove IoT Kit

Grove IoT Kit (Seeed Studio)

Micro Magician V2

TinkerKit

Wii

Complete Bots / Projects

Component Plugin Template

Example plugin

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

@code-dot-org/johnny-five dependencies

chalk firmata temporal nanotimer serialport color-convert lodash.debounce lodash.clonedeep browser-serialport

@code-dot-org/johnny-five development dependencies

nyc async grunt sinon keypress optimist coveralls grunt-cli copy-paste grunt-jscs common-tags mock-firmata grunt-jsbeautifier grunt-contrib-watch grunt-contrib-jshint grunt-contrib-nodeunit

FAQs

What is @code-dot-org/johnny-five?

Code.org fork of rwaldron/johnny-five: The JavaScript Robotics and Hardware Programming Framework. Use with: Arduino (a... Visit Snyk Advisor to see a full health score report for @code-dot-org/johnny-five, including popularity, security, maintenance & community analysis.

Is @code-dot-org/johnny-five popular?

The npm package @code-dot-org/johnny-five receives a total of 577 weekly downloads. As such, @code-dot-org/johnny-five popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @code-dot-org/johnny-five well maintained?

We found indications that @code-dot-org/johnny-five is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @code-dot-org/johnny-five safe to use?

While scanning the latest version of @code-dot-org/johnny-five, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 November-2024, at 22:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (577)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Johnny-Five

The JavaScript Robotics Programming Framework

Source Code:

Building and testing with apps

Testing

Updating README

Hello Johnny

Supported Hardware

Documentation

Guidance

Setup and Assemble Arduino

Hey you, here's Johnny!

Source Code:

npm package:

Example Programs

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.

Make: JavaScript Robotics

Contributing

License

@code-dot-org/johnny-five dependencies

@code-dot-org/johnny-five development dependencies

FAQs

What is @code-dot-org/johnny-five?

Is @code-dot-org/johnny-five popular?

Is @code-dot-org/johnny-five well maintained?

Is @code-dot-org/johnny-five safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config