npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cylon-spark

v0.21.1

Published

Cylon adaptor for the Particle Core & Photon device

Downloads

87

Readme

Cylon.js For Particle (nee Spark)

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things (IoT).

This module provides an adaptor for the Spark Core WiFi microcontroller from Particle, the company formerly known as Spark Devices.

It uses the built-in Tinker protocol via the Spark.js library thank you!

As an alternative, you can also use 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).

Build Status Code Climate Test Coverage

How to Install

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.

Installing Firmware On Your Spark Core

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.

How to Use

Spark using Tinker API:

var Cylon = require('cylon');

// Initialize the robot
Cylon.robot({
  connections: {
    spark: { adaptor: 'spark', accessToken: 'XYZPDQ123', deviceId: '123ABC456' }
  },

  devices: {
    led: { driver: 'led', pin: 'D0'}
  },

  work: function(my) {
    every((1).second(), function() {my.led.toggle()});
  }
}).start();

Spark using VoodooSpark API:

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' }
  },

  work: function(my) {
    every((1).second(), function() {my.led.toggle()});
  }
}).start();

How to Connect

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.

Documentation

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!

Contributing

For our contribution guidelines, please go to https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md .

Release History

For the release history, please go to https://github.com/hybridgroup/cylon-spark/blob/master/RELEASES.md .

License

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