BLEep Quick Start Guide

RevisionDateDetails
1.011 June 2014Document Creation
1.517 Aug 2014Updated for BLEep SDK v1.5
1.217 Apr 2014Updated for BLEep SDK v1.6 and BMS
  1. Quick setup for BMS
  2. Quick setup for BLEep iOS sample mobile app
  3. Quick setup for BLEep Android sample mobile app
  4. Troubleshooting
  5. Supported devices

Quick setup for BMS

  1. Sign up for a free account at BMS and login.



  2. Create an application on BMS



  3. Give a package name/bundle id and select your time zone.



  4. Take note and copy your API key that's linked to your package name/bundle id.



  5. Under ‘Beacon Management’, click ‘Manage Beacons’ and add your first beacon!



  6. Add a beacon with the UUID, major and minor values of a beacon you want to interact with.



  7. Add a rule for that beacon, ignore including values in the fields and go straight to create at the bottom of the page. You can return anytime and add in values later.




  8. Assign a communication (action) type with that rule (the easiest to test would be ‘Alert’ type, then enter ‘Hello World’ as the message). You can return anytime to try out the different communication (action) types.





  9. When you're done, it should look like this.

Quick setup for BLEep iOS sample mobile app

  1. Please visit http://www.rainmaker-labs.com/portfolio/bleepsdk or http://goo.gl/2invUu on your iPhone's web browser and follow the instructions to install the BLEep iOS sample mobile app.
  2. Retrieve your API key from BMS (refer to Section 1.0), open your iPhone’s Settings, go to the settings page for the app BLEep SDK Demo App, and use it to replace the default API key.




  3. Ensure the beacon you want to track is nearby, and that working batteries are inserted, and that Bluetooth is enabled on your phone.
  4. If you have our SDK demo app opened, please kill it (remove it from multitasking). Then open the app, grant it permission to access location services, and it should work.

Quick setup for BLEep Android sample mobile app

    1. Please visit http://www.rainmaker-labs.com/portfolio/bleepsdk or http://goo.gl/2invUu on your Android device's web browser and follow the instructions to install the BLEep Android sample mobile app.
    2. Retrieve your API key from BMS (refer to Quick setup for BMS - point 4: Take note and copy your API key that's linked to your package name/bundle id.)
    3. Open BLEep SDK demo app and click on the 'Options' button at the top right-hand corner to open the setting 'Settings' page. 
    4. Replace the default API key with your own and then click the 'Save and Close' button at the bottom.
    5. Ensure the beacon you want to interact with is nearby, working batteries are inserted, and that Bluetooth is enabled on your phone.
    6. If nothing happens, try killing the app from multitasking and then relaunch it. It will work now.

    Troubleshooting


    Please note that the BLEep SDK is designed to work with BMS, so it will not respond to just any beacon in the vicinity, but only to the beacons tracked under your application in BMS that meet the conditions you set.
    Using BMS, you can link to a beacon, set trigger rules like distance limits, and set a communication (action) type to be triggered when all conditions in a rule are met.

    Hence you need to do the following:

    • Set up a beacon in BMS (with the UUID, major and minor values of a beacon you want to use or simulate)
    • Set up a rule (trigger) for that beacon (you can use the default settings, just click ‘Add Rules’, then ‘Create Rule’ without changing anything)
    • Set up a communication (action) type linked to that rule (the easiest to test would be ‘Alert’ type, then enter ‘Hello World’ as the message)
    • Put the API key for your BMS application into the settings page for the app you downloaded directly
    Ensure the following points:
    • The beacon you want to track is nearby, and working batteries are inserted
    • Your phone is listed under Supported Devices (section 4.0)
    • Bluetooth is enabled on your phoneIf you are using iOS, Background App Refresh and Location Services should be enabled for our demo app

    Supported Devices


    Support Android Device
    Minimum Android SDK Version – Android 4.3 (API Level 18) 
    Tested on
    • Samsung (Galaxy S3, S3 Mini, Galaxy S4, S4 Mini, Note 2 and Note 3)
    • HTC (One)   
    Support iPhone Device 
    Minimum iPhone OS SDK Version – iOS 7.0 Tested on
    • Phone 4S and later
    • iPad (3rd generation and later)
    • iPod touch (5th generation)
    • iPad Mini (all generations)

        Feedback and Knowledge Base