cylon/README.md

1.5 KiB

cylon Build Status

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();

CoffeeScrip:

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)

License

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