Go to file
deadprogram fea55228cc Added ping driver for testing 2013-10-25 13:11:09 -07:00
dist Added ping driver for testing 2013-10-25 13:11:09 -07:00
examples Added ping driver for testing 2013-10-25 13:11:09 -07:00
src Added ping driver for testing 2013-10-25 13:11:09 -07:00
test Added colors to example. 2013-10-24 16:27:37 -05:00
.gitignore Initial commit 2013-10-17 23:55:48 -07:00
.jshintrc Initial commit 2013-10-17 23:55:48 -07:00
.travis.yml Install grunt-cli before running Travis script 2013-10-21 15:51:57 -07:00
Gruntfile.js Canonical missing semicolon 2013-10-18 00:06:10 -07:00
LICENSE Adding a test robot method 2013-10-18 22:32:23 -07:00
README.md Include reference to artoo 2013-10-25 09:19:08 -07:00
package.json Remove cylon-sphero dependency should be the other way around 2013-10-23 19:08:54 -07:00

README.md

Cylon.js

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and physical computing using node.js

It provides a simple, yet powerful way to create solutions that incorporate multiple, different hardware devices at the same time.

Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)

Build Status

Getting Started

Install the module with: npm install cylon

Examples

Note: before running examples in the examples/ dir, make sure to compile the source with grunt coffee first.

Javascript:

var Cylon = require("cylon");

// Initialize the robot
var robot = Cylon.robot({
  connection: { name: 'arduino', adaptor: 'firmata', port: '/dev/ttyACM0' },
  device: { name: 'led', driver: 'led', pin: 13 },

  work: function(my) {
    // we do our thing here
    every((1).second(), function() { my.led.toggle(); });
  }
});

// start working
robot.start();

CoffeeScript:

Cylon = require "cylon"

# Initialize the robot
robot = Cylon.robot
  connection:
    name: 'arduino'
    adaptor: 'firmata'
    port: '/dev/ttyACM0'

  device:
    name: 'led'
    driver: 'led'
    pin: 13

  work: (my) ->
    # we do our thing here
    every 1.second, -> my.led.toggle

robot.start

Documentation

(Coming soon)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

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