Go to file

deadprogram ce154f8d25 Removing commentted line		2013-10-22 18:55:27 -07:00
examples	Knowledge of self when working	2013-10-22 17:51:36 -07:00
src	Removing commentted line	2013-10-22 18:55:27 -07:00
test	Connections and Devices should belong to a robot	2013-10-22 16:39:49 -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	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	Fix 'CoffeeScrip' in README.md	2013-10-22 18:33:54 -07:00
package.json	Correct syntax outside of tests	2013-10-22 12:21:09 -07:00

README.md

cylon

A JavaScript framework for robotics and physical computing using node.js and nactor

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() {
    // we do our thing here
    every((1).second(), function() { 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: ->
    # we do our thing here
    every 1.second, -> 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)