Skip to content

Cylon.js adaptor/driver for Apple iBeacon technology and Altbeacon beacons

License

Notifications You must be signed in to change notification settings

juliancheal/cylon-beacon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cylon.js For Beacon

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

This repository contains the Cylon BLE adaptor for Beacons.

For more information about Cylon, check out the repo at https://github.com/hybridgroup/cylon

How to Install

Install the module with:

$ npm install cylon-beacon

How to Use

How to Connect

"use strict";

var Cylon = require("cylon");

Cylon.robot({
  connections: {
    beacon: { adaptor: "beacon", module: "cylon-beacon" }
  },

  devices: {
    ibeacon: { driver: "ble-ibeacon" }
  },

  work: function(my) {
    my.beacon.startScanning();

    my.ibeacon.getAdvertisement(function(err, data) {
      if (!!err) {
        console.log("error: ", err);
        return;
      }

      console.log("data: ", data);
    });
  }
}).start();

Documentation

Contributing

  • Put your contribution guidelines here
  • 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 make test and make lint.
  • 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

Release History

None yet...

License

Copyright (c) 2015 Julian Cheal. See LICENSE for more details

About

Cylon.js adaptor/driver for Apple iBeacon technology and Altbeacon beacons

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published