fea55228cc | ||
---|---|---|
dist | ||
examples | ||
src | ||
test | ||
.gitignore | ||
.jshintrc | ||
.travis.yml | ||
Gruntfile.js | ||
LICENSE | ||
README.md | ||
package.json |
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)
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.