Beacon demo for the BLE API using the nRF51822 native mode drivers

Dependencies:   BLE_API mbed nRF51822 X_NUCLEO_IDB0XA1

Introduction

Bluetooth Low Energy Beacons are a service that allow for highly localized positioning. The Beacon service is particularly useful for indoor positioning, low power positioning and location aware software. A particular use of the Beacon service is iBeacon. The iBeacon standard is a Apple specific implementation of Beacons.

The Basics

The Beacon service is a BLE Service that operates in advertising mode only. A Beacon service advertises 4 things:

  • A company ID
  • A unique UUID (unique to a retailer)
  • A Major number (ex a store number)
  • A Minor number (ex a location in the store)
  • Signal Strength at transmitter (requires calibration per each device)

These pieces of information are all you need for a Beacon service to work. The majority of the heavy lifting is done by the smart phone application that reads these four fields and then uses a web app or a database of some sort to turn these numbers into valuable information about what you are near and how near you are to it.

The signal strength field is compared to the actual signal strength at the receiver to determine how close the beacon is to the phone. The number used is the calibrated signal strength 1 meter from the device. By doing this 1 meter increments can be used to measure distance from the Beacon. The distances usually get broken down into 3 ranges:

  • Immediate: Within a few centimeters
  • Near: Within a couple of meters
  • Far: Greater than 10 meters away

Company ID's are used to make beacon UUID's unique to companies. Some example company UUID's are:

  • 0x004C - Apple Inc.
  • 0x0059 - Nordic Semiconductor
  • 0x0078 - Nike
  • ​0x015D - Estimote
  • ​0x0171 - Amazon Fulfillment Service
  • 0xFFFF - reserved for internal testing before release

Here is the Bluetooth SIG's full list of Company ID's.

Example : Coffee Shop X

For example, if a smartphone app reads a BLE Beacon with UUID = 0x1234546... , Major Number=5, Minor number = 3, it would check that against a database. From that database it would find out that UUID 0x123456... is owned by Coffee Shop X, that Major number 5 belongs to the store on main street and that Minor number 3 belongs to the coffee rack in that store. Then the application could check to see if there are any deals for the Coffee Shop X on Main Street on Coffee today. If there are any deals the phone could then alert the user and display a coupon code.

Example : museum

The Beacon service also provides a way for the phone to tell how close it is to the beacon. This can be useful for location aware applications, such as in a museum. For example, the smartphone reads a BLE Beacon with UUID = 0x98765....., Major Number=1, minor number = 0. The smartphone then looks this up in a database and find the UUID is for the Natural Science Museum, Major Number 1 = the Art Gallery room 1, and the minor number 0 = an abstract painting of a duck. If we assume all the paintings are spread out at 10feet each, then the application can sense when you are within 3 feet of the painting (based on signal strength of the Beacon) and give the user information about the painting they are approaching.

Technical Details

An iBeacon is just a normal Bluetooth LE device broadcasting advertisements with special data shoved into the Manufacturer Specific Data field.

The iBeacon prefix is little more than metadata about the advertisement packet.

BytesDatadescription
0,1,20x020106This sets the flags for General Discoverable and BR/EDR not supported
3,40x1AFFThis says the length of the Manufacturer specific data field will be 26 bytes
0,10x4C00Company ID
20x02ID
30x15length of remaining data in bytes (16B UUID+ 2B major, 2B minor, 1B Txpower)

Note that bytes 0-4 are set implicitly by the API by declaring the advertising data to be LE General Discoverable and BR/EDR not supported. The remaining fields that make up an iBeacon advertisement packet can be clearly seen in the image below.

http://www.havlena.net/wp-content/uploads/ibeacon-packet.png

For a more depth explanation please see these well done explanations:

Committer:
Rohit Grover
Date:
Fri Jul 04 15:14:58 2014 +0100
Revision:
37:205deeded79d
Parent:
32:7b7093b653a8
Child:
41:51f585d14675
include LE_GENERAL_DISCOVERABLE in advertising payload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 0:7613d21e5974 1 /* mbed Microcontroller Library
ktownsend 0:7613d21e5974 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 0:7613d21e5974 3 *
ktownsend 0:7613d21e5974 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 0:7613d21e5974 5 * you may not use this file except in compliance with the License.
ktownsend 0:7613d21e5974 6 * You may obtain a copy of the License at
ktownsend 0:7613d21e5974 7 *
ktownsend 0:7613d21e5974 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 0:7613d21e5974 9 *
ktownsend 0:7613d21e5974 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 0:7613d21e5974 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 0:7613d21e5974 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 0:7613d21e5974 13 * See the License for the specific language governing permissions and
ktownsend 0:7613d21e5974 14 * limitations under the License.
ktownsend 0:7613d21e5974 15 */
ktownsend 0:7613d21e5974 16
ktownsend 0:7613d21e5974 17 #include "mbed.h"
Rohit Grover 32:7b7093b653a8 18 #include "BLEDevice.h"
ktownsend 0:7613d21e5974 19
Rohit Grover 32:7b7093b653a8 20 BLEDevice ble;
Rohit Grover 31:93e50a3c3dc6 21
Rohit Grover 31:93e50a3c3dc6 22 #define NEED_CONSOLE_OUTPUT 0 /* Set this if you need debug messages on the console;
Rohit Grover 31:93e50a3c3dc6 23 * it will have an impact on code-size and power consumption. */
ktownsend 0:7613d21e5974 24
Rohit Grover 31:93e50a3c3dc6 25 #if NEED_CONSOLE_OUTPUT
Rohit Grover 31:93e50a3c3dc6 26 Serial pc(USBTX, USBRX);
Rohit Grover 31:93e50a3c3dc6 27 #define DEBUG(...) { pc.printf(__VA_ARGS__); }
Rohit Grover 31:93e50a3c3dc6 28 #else
Rohit Grover 31:93e50a3c3dc6 29 #define DEBUG(...) /* nothing */
Rohit Grover 31:93e50a3c3dc6 30 #endif /* #if NEED_CONSOLE_OUTPUT */
ktownsend 0:7613d21e5974 31
Rohit Grover 10:391c1acf4b9d 32 /*
Rohit Grover 10:391c1acf4b9d 33 * For this demo application, populate the beacon advertisement payload
Rohit Grover 15:4e1b36b73213 34 * with 2 AD structures: FLAG and MSD (manufacturer specific data).
Rohit Grover 10:391c1acf4b9d 35 *
Rohit Grover 10:391c1acf4b9d 36 * Reference:
Rohit Grover 10:391c1acf4b9d 37 * Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 11, 18
Rohit Grover 10:391c1acf4b9d 38 */
ktownsend 0:7613d21e5974 39
Rohit Grover 14:dfdf0c8b1c09 40 /*
Rohit Grover 15:4e1b36b73213 41 * The Beacon payload (encapsulated within the MSD advertising data structure)
Rohit Grover 15:4e1b36b73213 42 * has the following composition:
Rohit Grover 10:391c1acf4b9d 43 * 128-Bit UUID = E2 0A 39 F4 73 F5 4B C4 A1 2F 17 D1 AD 07 A9 61
Rohit Grover 10:391c1acf4b9d 44 * Major/Minor = 0000 / 0000
Rohit Grover 10:391c1acf4b9d 45 * Tx Power = C8
Rohit Grover 10:391c1acf4b9d 46 */
Rohit Grover 22:080d9bf2f5c0 47 const static uint8_t beaconPayload[] = {
Rohit Grover 10:391c1acf4b9d 48 0x4C, 0x00, // Company identifier code (0x004C == Apple)
Rohit Grover 10:391c1acf4b9d 49 0x02, // ID
Rohit Grover 10:391c1acf4b9d 50 0x15, // length of the remaining payload
Rohit Grover 31:93e50a3c3dc6 51 0xE2, 0x0A, 0x39, 0xF4, 0x73, 0xF5, 0x4B, 0xC4, // location UUID
Rohit Grover 10:391c1acf4b9d 52 0xA1, 0x2F, 0x17, 0xD1, 0xAD, 0x07, 0xA9, 0x61,
Rohit Grover 31:93e50a3c3dc6 53 0x00, 0x00, // the major value to differentiate a location
Rohit Grover 31:93e50a3c3dc6 54 0x00, 0x00, // the minor value to differentiate a location
Rohit Grover 10:391c1acf4b9d 55 0xC8 // 2's complement of the Tx power (-56dB)
Rohit Grover 10:391c1acf4b9d 56 };
Rohit Grover 10:391c1acf4b9d 57
ktownsend 0:7613d21e5974 58 int main(void)
ktownsend 0:7613d21e5974 59 {
Rohit Grover 31:93e50a3c3dc6 60 DEBUG("Initialising BTLE transport\n\r");
Rohit Grover 11:6774f4827024 61 ble.init();
ktownsend 0:7613d21e5974 62
Rohit Grover 37:205deeded79d 63 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
Rohit Grover 27:8d4f5bda1191 64 ble.accumulateAdvertisingPayload(GapAdvertisingData::MANUFACTURER_SPECIFIC_DATA, beaconPayload, sizeof(beaconPayload));
ktownsend 0:7613d21e5974 65
Rohit Grover 20:5e84b5b253a5 66 ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
Rohit Grover 23:b66fa312e926 67 ble.setAdvertisingInterval(160); /* 100ms; in multiples of 0.625ms. */
Rohit Grover 19:869d8c7306b4 68 ble.startAdvertising();
ktownsend 0:7613d21e5974 69
Rohit Grover 21:a61af863b273 70 for (;;) {
Rohit Grover 31:93e50a3c3dc6 71 ble.waitForEvent();
ktownsend 0:7613d21e5974 72 }
Rohit Grover 31:93e50a3c3dc6 73
Rohit Grover 31:93e50a3c3dc6 74 // An alternative to the above:
Rohit Grover 31:93e50a3c3dc6 75 //
Rohit Grover 31:93e50a3c3dc6 76 // DigitalOut mainloopLED(LED1);
Rohit Grover 31:93e50a3c3dc6 77 // for (;;) {
Rohit Grover 31:93e50a3c3dc6 78 // mainloopLED = !mainloopLED;
Rohit Grover 31:93e50a3c3dc6 79 // wait(1);
Rohit Grover 31:93e50a3c3dc6 80 // }
Rohit Grover 10:391c1acf4b9d 81 }