cylon-spark

Cylon adaptor for the Spark core device

Cylon.js For Spark

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

This module provides an adaptor for the Spark core device using either the built-in Tinker protocol (https://www.spark.io/), or else VoodooSpark from @voodootikigod. The VoodooSpark implementation uses the Spark-IO node module from @rwaldron. Thank you!

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).

Install the module with:

$ npm install cylon cylon-spark

You'll need your access_token and device_id to push new software to yourSpark, and you can get both of these from Spark's Build tool.

  • access_token: In the Build tool, click on the Settings cog in the bottom-left corner to find your access token.
  • device_id: After you have your Spark Core registered to your account through the Tinker app, click on the Cores section (just above the Settings cog) on the Build tool. Then, click on the arrow next to your core's name to get its device ID.

You will need to install the appropriate firmware on your Spark Core to use it from Cylon.js.

One option is to use the Tinker software, which has the same API as the "default.cpp" code that is included with the Gort CLI (http://gort.io). This routes all of your calls thru the Spark cloud, with is appropriate for communicating with Spark devices in a remote location.

Another option is to use the VoodooSpark firmware, which has its own binary API. This discovers your device thru the Spark cloud, and then routes all of your calls directly to the Spark Core device. This is appropriate for communicating with Spark devices on the same local subnet as the computer that you wish to control them from.

For more information on how to program your Spark, please see Spark's examples.

For more information about VoodooSpark, click here.

var Cylon = require('cylon');
 
// Initialize the robot 
Cylon.robot({
  connections: {
    spark: { adaptor: 'spark', accessToken: 'XYZPDQ123', deviceId: '123ABC456' }
  },
 
  devices: {
    led: { driver: 'led', pin: 'D0'}
  },
 
  workfunction(my) {
    every((1).second(), function() {my.led.toggle()});
  }
}).start();
var Cylon = require('cylon');
 
// Initialize the robot 
Cylon.robot({
  connections: {
    voodoospark: {
      adaptor: 'voodoospark',
      accessToken: 'XYZPDQ123',
      deviceId: '123ABC456',
      module: 'cylon-spark'
    }
  },
 
  devices: {
    led: { driver: 'led', pin: 'D0' }
  },
 
  workfunction(my) {
    every((1).second(), function() {my.led.toggle()});
  }
}).start();

The setup process for the Spark core is fully explained by their docs, and requires only an active internet connection with a WiFi access point.

Once your Spark is connected, you can get the accessToken and deviceId necessary to communicate with it from Cylon.

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

Version 0.19.0 - Compatibility with Cylon 1.0.0

Version 0.18.0 - Compatibility with Cylon 0.22.0

Version 0.17.1 - Readme and test coverage updates

Version 0.17.0 - Compatibility with Cylon 0.21.0

Version 0.16.1 - Fixes issue with analogRead and digitalRead not working with voodoospark.

Version 0.16.0 - Compatibility with Cylon 0.20.0

Version 0.15.0 - Compatibility with Cylon 0.19.0

Version 0.14.0 - Compatibility with Cylon 0.18.0

Version 0.13.1 - Added servo support ussing the updated Gort.io default firmware.

Version 0.13.0 - Compatibility with Cylon 0.16.0

Version 0.12.2 - Update PWM write functions in adaptor.

Version 0.12.1 - Add peerDependencies to package.json

Version 0.12.0 - Compatibility with Cylon 0.15.0

Version 0.11.0 - Spark analog/digital Read now returns return_value directly, with a configurable read interval.

Version 0.10.0 - Alter {analog,digital}Read to act more like Firmata, trigger callback repeatedly.

Version 0.9.0 - Correct implementation with Tinker firmware read calls

Version 0.8.0 - Compatibility with Cylon 0.14.0, remove node-namespace.

Version 0.7.0 - Release for cylon 0.12.0

Version 0.6.0 - Release for cylon 0.11.2, Add support for server side events, user defined functions, variables and a firmware upload cli command

Version 0.5.0 - Release for cylon 0.11.0, refactor into pure JavaScript

Version 0.4.0 - Release for cylon 0.10.0

Version 0.3.0 - Release for cylon 0.9.0

Version 0.2.0 - Release for cylon 0.8.0

Version 0.1.0 - Initial release

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