2013-10-19 13:59:58 +08:00
# cylon [](http://travis-ci.org/hybridgroup/cylon)
2013-10-18 14:55:48 +08:00
2013-10-21 05:11:58 +08:00
A JavaScript framework for robotics and physical computing using node.js and nactor
2013-10-18 14:55:48 +08:00
## Getting Started
Install the module with: `npm install cylon`
2013-10-20 08:56:00 +08:00
## Examples
2013-10-18 14:55:48 +08:00
```javascript
2013-10-20 08:53:53 +08:00
var cylon = require("cylon");
// Initialize the robot
var robot = cylon.robot({
2013-10-20 08:56:49 +08:00
connection: { name: 'arduino', adaptor: 'firmata', port: '/dev/ttyACM0' },
device: { name: 'led', driver: 'led', pin: 13 },
2013-10-20 08:53:53 +08:00
2013-10-20 08:56:49 +08:00
work: function() {
2013-10-20 08:53:53 +08:00
// we do our thing here
every(1.second(), function() { led.toggle(); });
}
});
// start working
2013-10-20 11:31:29 +08:00
robot.start();
2013-10-18 14:55:48 +08:00
```
```coffee-script
2013-10-20 08:53:53 +08:00
cylon = require("cylon")
# Initialize the robot
robot = cylon.robot
connection:
name: 'arduino', adaptor: 'firmata', port: '/dev/ttyACM0'
device:
name: 'led', driver: 'led', pin: 13
2013-10-20 08:56:49 +08:00
work: ->
2013-10-20 08:53:53 +08:00
# we do our thing here
2013-10-20 08:57:51 +08:00
every 1.second, ->
led.toggle
2013-10-20 08:53:53 +08:00
2013-10-20 11:31:29 +08:00
robot.start
2013-10-18 14:55:48 +08:00
```
2013-10-21 05:11:58 +08:00
## Documentation
_(Coming soon)_
2013-10-18 14:55:48 +08:00
## 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 ](http://gruntjs.com/ ).
## Release History
_(Nothing yet)_
## License
2013-10-19 13:32:23 +08:00
Copyright (c) 2013 The Hybrid Group. Licensed under the Apache 2.0 license.
