p71924506
/
cylon
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,103 Commits 3 Branches 0 Tags 0 B
Go to file
Andrew Stewart c49e71b9c7 Bump version to "0.21.1" 2014-11-28 15:02:11 -08:00
examples Update examples for new syntax 2014-11-25 16:01:31 -08:00
lib Add back debug logging for device/connection start 2014-11-28 14:42:26 -08:00
spec Support passing config to Logger#setup again 2014-11-28 09:37:44 -08:00
.gitignore Add CodeClimate coverage 2014-05-21 19:35:09 -07:00
.jshintrc Small changes to appease JSHint 2014-03-07 23:33:59 -08:00
.travis.yml Remove site config from travis-ci 2014-06-13 15:54:45 -07:00
CONTRIBUTORS.markdown Update list of contributors 2014-06-12 19:43:38 -07:00
LICENSE Update copyright year 2014-01-12 10:24:46 -08:00
Makefile Reorganize tests, under 'spec' directory now 2014-10-20 14:55:25 -07:00
README.markdown Bump version to "0.21.1" 2014-11-28 15:02:11 -08:00
freenode.txt Add freenode confirmation file 2014-07-19 12:36:59 -07:00
package.json Bump version to "0.21.1" 2014-11-28 15:02:11 -08:00

README.markdown

Cylon.js

Cylon.js is a JavaScript framework for robotics and physical computing built on top of Node.js.

It provides a simple, but powerful way to create solutions that incorporate multiple, different hardware devices concurrently.

Want to use Ruby on robots? Check out our sister project, Artoo.

Want to use Golang to power your robots? Check out our sister project, Gobot.

Build Status:

Build Status Code Climate Code Climate

Getting Started

Installation

All you need to get started on a new robot is the cylon module:

npm install cylon

With the core module installed, now install the modules for whatever hardware support you need. For the Arduino + LED blink example, we'll need the firmata module:

npm install cylon-firmata

Examples

Arduino + LED

The below example connects to an Arduino over a serial connection, and blinks an LED once per second.

The example requires that the Arduino have the Firmata sketch installed; which can be obtained either through the Ardunio IDE or the gort arduino upload firmata command available in gort.

var Cylon = require('cylon');

// define the robot
var robot = Cylon.robot({
  // change the port to the correct one for your Arduino
  connection: { name: 'arduino', adaptor: 'firmata', port: '/dev/ttyACM0' },
  device: { name: 'led', driver: 'led', pin: 13 },

  work: function(my) {
    every((1).second(), my.led.toggle);
  }
});

// connect to the Arduino and start working
robot.start();

Parrot ARDrone 2.0

var Cylon = require('cylon');

Cylon.robot({
  connection: { name: 'ardrone', adaptor: 'ardrone', port: '192.168.1.1' },
  device: { name: 'drone', driver: 'ardrone' },

  work: function(my) {
    my.drone.takeoff();

    after((10).seconds(), my.drone.land);
    after((15).seconds(), my.drone.stop);
  }
}).start();

Cat Toy (Leap Motion + Digispark + Servos)

var Cylon = require('cylon');

Cylon.robot({
  connections: {
    digispark: { adaptor: 'digispark' },
    leapmotion: { adaptor: 'leapmotion' }
  },

  devices: {
    servo1: { driver: 'servo', pin: 0, connection: 'digispark' },
    servo2: { driver: 'servo', pin: 1, connection: 'digispark' },
    leapmotion: { driver: 'leapmotion', connection: 'leapmotion' }
  },

  work: function(my) {
    my.x = 90;
    my.z = 90;

    my.leapmotion.on('hand', function(hand) {
      my.x = hand.palmX.fromScale(-300, 300).toScale(30, 150);
      my.z = hand.palmZ.fromScale(-300, 300).toScale(30, 150);
    });

    every(100, function() {
      my.servo1.angle(my.x);
      my.servo2.angle(my.z);

      console.log(my.servo1.currentAngle() + ", " + my.servo2.currentAngle());
    });
  }
}).start();

Multiple Spheros + API Server

var Cylon = require('cylon');

// tell the API server to listen for requests at
// https://localhost:4000
Cylon.api({ port: 4000 });

var bots = [
  { port: '/dev/rfcomm0', name: 'Thelma' },
  { port: '/dev/rfcomm1', name: 'Louise' }
];

bots.forEach(function(bot) {
  Cylon.robot({
    name: bot.name,

    connection: { name: "sphero", adaptor: "sphero", port: bot.port },
    device: { name: "sphero", driver: "sphero" },

    work: function(my) {
      every((1).second(), function() {
        console.log(my.name);
        my.sphero.setRandomColor();
        my.sphero.roll(60, Math.floor(Math.random() * 360));
      });
    }
  });
});

// start up all robots at once
Cylon.start();

Fluent Syntax

For those more familiar with jQuery, D3, or other fluent-style JavaScript libraries, Cylon.JS also supports a fluent syntax:

var cylon = require('cylon');

cylon.robot({
  connection: { name: 'arduino', adaptor: 'firmata', port: '/dev/ttyACM0' },
  device: { name: 'led', driver: 'led', pin: 13 }
})

.on('ready', function(bot) {
  setInterval(function() {
    bot.led.toggle();
  }, 1000);
})

.start();

Hardware Support

Cylon.js has an extensible syntax for connecting to multiple, different hardware devices. The following 31 platforms are currently supported:

Our implementation of GPIO (General Purpose Input/Output) allows for a shared set of drivers supporting a number of devices:

  • GPIO <=> Drivers
    • Analog Sensor
    • Button
    • Continuous Servo
    • Direct Pin
    • IR Rangefinder
    • LED
    • MakeyButton
    • Motor
    • Maxbotix Ultrasonic Range Finder
    • Servo

Additionally, we also support a number of I2C (Inter-Integrated Circuit) devices through a shared cylon-i2c module:

  • I2C <=> Drivers
    • BlinkM
    • BMP180
    • HMC6352 Digital Compass
    • LCD Display
    • MPL115A2 Barometer/Thermometer
    • MPU6050

We'll also have many more platforms and drivers coming soon, follow us on Twitter for updates.

Browser & Mobile Support

Cylon.js can be run directly in-browser, using the browserify NPM module. You can also run it from withing a Chrome connected app, or a PhoneGap mobile app.

For more info on browser support, and for help with different configurations, you can find more info in our docs.

API

Cylon has a built-in API that you can interact with your robots.

All you need to start up the API server is to place the following command in your .js file after you require Cylon.

:::javascript
var Cylon = require("cylon");
Cylon.api();

Then visit https://localhost:3000/ and you are ready to control your robots from a web browser!

You can check out more information on the Cylon API in the docs here.

CLI

Cylon uses the Gort http://gort.io Command Line Interface (CLI) so you can access important features right from the command line. We call it "RobotOps", aka "DevOps For Robotics". You can scan, connect, update device firmware, and more!

Cylon also has its own CLI to generate new robots, adaptors, and drivers. You can check it out at https://github.com/hybridgroup/cylon-cli.

Documentation

We're busy adding documentation to our website, check it out at cylonjs.com/documentation.

If you want to help with documentation, you can find the code for our website at on the https://github.com/hybridgroup/cylon-site.

Contributing

  • All patches must be provided under the Apache 2.0 License
  • Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
  • Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
  • We will look at the patch, test it out, and give you feedback.
  • Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
  • Take care to maintain the existing coding style.
  • Add unit tests for any new or changed functionality & lint and test your code using make test and make lint.
  • All pull requests should be "fast forward"
    • If there are commits after yours use “git rebase -i <new_head_branch>”
    • If you have local changes you may need to use “git stash”
    • For git help see progit which is an awesome (and free) book on git

Release History

Version 0.21.1 - Add back debug logging for starting/connecting devices/connections

Version 0.21.0 - Remove Connection/Device objects, update Robot connection/device syntax, fluent syntax updates

Version 0.20.2 - Correct API issues, possible issue with test setups

Version 0.20.1 - Revert accidental scrict handling of param in driver initializer

Version 0.20.0 - Browser support, new module loading, log level support, misc. development changes

Version 0.19.1 - Correct issue with dynamic method proxying

Version 0.19.0 - Fluent syntax, improved start/halt, various other updates

Version 0.18.0 - Updates Robot and Driver commands structure

Version 0.17.0 - Updates to API to match CPPP-IO spec

Version 0.16.0 - New IO Utils, removal of Utils#bind, add Adaptor#_noop method.

Version 0.15.1 - Fixed issue with the API on Tessel

Version 0.15.0 - Better halting, cleaner startup, removed 'connect' and 'start' events, and misc other cleanups/refactors.

Version 0.14.0 - Removal of node-namespace and misc. cleanup

Version 0.13.3 - Fixes bug with disconnect functions not being called.

Version 0.13.2 - Use pure Express, adds server-sent-events, upd API.

Version 0.13.1 - Add API authentication and HTTPS support

Version 0.13.0 - Set minimum Node version to 0.10.20, add utils to global namespace and improve initialization routines

Version 0.12.0 - Extraction of CLI tooling

Version 0.11.2 - bugfixes

Version 0.11.0 - Refactor into pure JavaScript

Version 0.10.4 - Add JS helper functions

Version 0.10.3 - Fix dependency issue

Version 0.10.2 - Create connections convenience vars, refactor config loading

Version 0.10.1 - Updates required for test driven robotics, update Robeaux version, bugfixes

Version 0.10.0 - Use Robeaux UX, add CLI commands for helping connect to devices, bugfixes

Version 0.9.0 - Add AngularJS web interface to API, extensible commands for CLI

Version 0.8.0 - Refactored Adaptor and Driver into proper base classes for easier authoring of new modules

Version 0.7.0 - cylon command for generating new adaptors, support code for better GPIO support, literate examples

Version 0.6.0 - API exposes robot commands, fixes issues in driver/adaptor init

Version 0.5.0 - Improve API, add GPIO support for reuse in adaptors

Version 0.4.0 - Refactor proxy in Cylon.Basestar, improve API

Version 0.3.0 - Improved Cylon.Basestar, and added API

Version 0.2.0 - Cylon.Basestar to help develop external adaptors/drivers

Version 0.1.0 - Initial release for ongoing development

License

Copyright (c) 2013-2014 The Hybrid Group. Licensed under the Apache 2.0 license.