cylon-keyboard

Cylon module for Keyboard

Cylon.js For Keyboard Input

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and physical computing using Node.js

This repository contains the Cylon adaptor for keyboard input.

Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)

Want to use the Go programming language to power your robots? Check out our sister project Gobot (http://gobot.io).

Installing cylon.js with a keyboard support is pretty easy.

$ npm install cylon cylon-keyboard
var Cylon = require('cylon');
 
Cylon.robot({
  connections: {
    keyboard: { adaptor: 'keyboard' }
  },
 
  devices: {
    keyboard: { driver: 'keyboard' }
  },
 
  workfunction(my) {
    my.keyboard.on('a', function(key) {
      console.log("A PRESSED!");
    });
  }
}).start();

All that you need to do is plug the keyboard into your computer as usual.

We're busy adding documentation to our web site at http://cylonjs.com/ please check there as we continue to work on Cylon.js

Thank you!

  • All patches must be provided under the Apache 2.0 License
  • Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
  • Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
  • We will look at the patch, test it out, and give you feedback.
  • Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
  • Take care to maintain the existing coding style.
  • Add unit tests for any new or changed functionality & Lint and test your code using Grunt.
  • All pull requests should be "fast forward"
    • If there are commits after yours use “git rebase -i <new_head_branch>”
    • If you have local changes you may need to use “git stash”
    • For git help see progit which is an awesome (and free) book on git
VersionNotes
0.14.0Compatibility with Cylon 1.0.0
0.13.0Provide number key support via hybridgroup-keypress fork
0.12.0Compatibility with Cylon 0.22.0
0.11.0Compatibility with Cylon 0.21.0
0.10.0Compatibility with Cylon 0.20.0
0.9.0Compatibility with Cylon 0.19.0
0.8.0Compatibility with Cylon 0.18.0
0.7.0Compatibility with Cylon 0.16.0
0.6.2Add peerDependencies to package.json
0.6.0Compatibility with Cylon 0.15.0, support for 'keydown', 'keypress', and 'keyup' events
0.5.0Compatibility with Cylon 0.14.0, remove node-namespace.
0.4.1BugFix ctrl-c not terminating the process.
0.4.0Update for Cylon.js 0.12.0
0.3.0Update for Cylon.js 0.11.0, refactor into pure JavaScript
0.2.0Update to cylon 0.10.0
0.1.0Initial release

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