#iBeacon Ranger
##What Is It? iBeacon Ranger is an iBeacon diagnostic tool for iOS and Android built with PhoneGap and Adobe PhoneGap Build. Built on Peter Metz's iBeacon Phonegap/Cordova plugin, range and monitor a specified set of iBeacons in real-time. This app serves as an example of how to utilize iBeacons and as a starting point for creating your own PhoneGap iBeacon app.
##Why? Well, because iBeacons are awesome. That's why. ;)
iBeacons are exciting, yet 'simple' low-energy Bluetooth (BLE) devices. They repeatedly shout out, "Here's my UUID, major version and minor version!", which in itself is not that exciting. Exciting possibilities happen when adding an app that can listen for their presence or determine their distance. Think self-guided tour, or a map that walks people though it (even inside buildings where GPS doesn't go). Trigger content by simply walking around with a mobile device. Awesome!
##Features
- Real-time scrolling line chart showcasing iBeacon RSSI (Received Signal Strength Indication)
- Range a list of iBeacons, categorize them as "immediate", "near", "far" or "unknown", and show their RSSI in real-time
- The closest calculated iBeacon gets a star (great when thinking about triggering content associated with the closest beacon).
- Monitor a list of iBeacons, showing whether or not they are inside or outside of range (note: this is allowed to happen even when the app isn't running! - great for some use cases, annoying for others).
- Lots of scripty goodness to start building your own iBeacon app with. :D
##To-do
- Theoretically this app works on Android, but hasn't been tested there yet (anyone want to give it a shot?).
- Adapt to self-build on the desktop rather than Adobe PhoneGap Build for those that want it (I found Adobe PhoneGap Build to be handy when not familiar with the build process and also to build an iOS and someday a Windows Phone app from a Linux machine - whoa!).
- Feature to manually add one's own iBeacons when the app is running (won't help anyone just scanning for my iBeacons!)
##Wish List
- Ability to scan ALL nearby iBeacons (currently not supported, see this discussion for details - prove me wrong!)
##Usage
###Adobe PhoneGap Build Usage
- Fork this repository. Fork it!
- Set iBeacons to monitor in js/BeaconMonitor.js
- Visit Adobe PhoneGap Build and login.
- Add a new app and paste the repository address in the related field. Example: The address for this repository is https://github.com/owntheweb/ibeacon-ranger .
- Upload any keys for the desired mobile platform under your project settings.
- Choose "Update Code" to pull in the latest committed code from the desired repository. PhoneGap Build will automatically build the app.
- Once build is complete, scan the QR code with an authorized mobile device, starting the install process.
- Joyfully range and monitor specified iBeacons in the area.
###PhoneGap Usage (self-build)
[I need help with this.]
##Tips for Success
- It's important to know that this app monitors a specified list of iBeacons. It cannot locate and list all iBeacons in the area.
- In iOS8, If monitoring iBeacons (inside/outside range, not ranging/distance), the app must request to always access location (as it does by default). It won't monitor otherwise. See end of delegate.didRangeBeaconsInRegion in BeaconMonitor.js.
- Note: Use this feature with caution as iOS permission makes it read like the app can always access the user's location, gives impression of "constantly track user via GPS" with active location icon always active (alarming).
- If only using ranging features, it will work properly when app requests to only access the user's location when the app is active. See end of delegate.didRangeBeaconsInRegion in BeaconMonitor.js with a commented out permissions option.
##Thank You
This app is co-sponsored by the Space Foundation.
In addition to personal time spent on this project, extra special thanks goes to the Space Foundation team, supplying iBeacon hardware, an iOS developer account and even a few on-the-clock training hours to dedicate towards iBeacon research. The Space Foundation is aiming to improve attendee navigational experiences at the annual Space Symposium via a useful app map. We're also exploring options for future use in the Space Foundation Discovery Center. You too can help the Space Foundation achieve their mission to inspire, enable and propel, by contributing to this project. :D