Go to file
deadprogram 7cbf27e636 Fixing the example 2013-10-19 17:57:51 -07:00
src Remove not needed exports 2013-10-19 16:13:31 -07:00
test Placeholders for core classes 2013-10-19 16:10:24 -07: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 Initial commit 2013-10-17 23:55:48 -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 Fixing the example 2013-10-19 17:57:51 -07:00
package.json Remove commented lines 2013-10-19 14:36:40 -07:00

README.md

cylon Build Status

A JavaScript robotics framework using node.js and nactor

Getting Started

Install the module with: npm install cylon

Documentation

(Coming soon)

Examples

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() {
    // we do our thing here
    every(1.second(), function() { led.toggle(); });
  }
});

// start working
robot.work();
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: ->
    # we do our thing here
    every 1.second, ->
      led.toggle

# start working
robot.work

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.