Bluetooth Low Energy / Mbed 2 deprecated BLE_EddystoneBeacon_Service Featured

Example program for the Eddystone Beacon service.

Dependencies:   BLE_API mbed nRF51822 X_NUCLEO_IDB0XA1

Fork of BLE_EddystoneBeacon by URIBeacon

This example demonstrates how to set up and initialize a Eddystone Beacon. For more details on the Eddystone specification please see the Eddystone Github Page.

The Basics

An Eddystone Beacon is a Bluetooth Low Energy beacon, that means it does all of its data transfer in GAP advertising packets. Eddystone beacons, unlike other beacons, broadcast multiple types of data. Currently Eddystone beacons have 3 frame types (UID, URL, TLM) that will get swapped out periodically. This swapping of frame data allows Eddystone beacons to send many different types of data, thus increasing their usefulness over traditional beacons. Note that the UID frame type provides the same 16Bytes of UUID namespace that iBeacons do and the URL frame type provides the same functionality as a URIBeacon.

For more details see the Eddystone Specification.

Smartphone Apps

nRF Master Control Panel - this program recognizes Eddystone beacons and will display the data for all frame types.

iPhone Physical Web app

Android App

Walkthrough of Physical Web application

Technical Details

The Eddystone Specification looks like the following image. Please note that this may change over time and for up to date information the official spec should be referenced. /media/uploads/mbedAustin/scratch-1-.png

The Eddystone Frames get swapped in and out depending on what frames you have enabled. The only required frame type is the TLM frame, all others are optional and you can have any number enabled. To disable the UID or URL frames give their values a 'NULL' in the Eddystone constructor. The Eddystone spec recommends broadcasting 10 frames a second.

Note

  • The current Eddystone mbed example does not allow for combining the eddystone service with other services, this will be changes in a future update.
  • There is an Eddystone Config service that allows for updating beacons in the field. We are working on an example for this, so keep your eyes pealed for a future update.

TLMFrame.cpp@36:17b4a0ff9abb, 2016-09-20 (annotated)

Committer:
Vincent Coubard
Date:
Tue Sep 20 14:13:43 2016 +0100
Revision:
36:17b4a0ff9abb
Parent:
34:f6d4a699a1ea 
Update libraries and add support of the ST shield.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
andresag 34:f6d4a699a1ea 1 /* mbed Microcontroller Library
andresag 34:f6d4a699a1ea 2 * Copyright (c) 2006-2015 ARM Limited
andresag 34:f6d4a699a1ea 3 *
andresag 34:f6d4a699a1ea 4 * Licensed under the Apache License, Version 2.0 (the "License");
andresag 34:f6d4a699a1ea 5 * you may not use this file except in compliance with the License.
andresag 34:f6d4a699a1ea 6 * You may obtain a copy of the License at
andresag 34:f6d4a699a1ea 7 *
andresag 34:f6d4a699a1ea 8 * http://www.apache.org/licenses/LICENSE-2.0
andresag 34:f6d4a699a1ea 9 *
andresag 34:f6d4a699a1ea 10 * Unless required by applicable law or agreed to in writing, software
andresag 34:f6d4a699a1ea 11 * distributed under the License is distributed on an "AS IS" BASIS,
andresag 34:f6d4a699a1ea 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
andresag 34:f6d4a699a1ea 13 * See the License for the specific language governing permissions and
andresag 34:f6d4a699a1ea 14 * limitations under the License.
andresag 34:f6d4a699a1ea 15 */
andresag 34:f6d4a699a1ea 16
andresag 34:f6d4a699a1ea 17 #include "TLMFrame.h"
andresag 34:f6d4a699a1ea 18
andresag 34:f6d4a699a1ea 19 TLMFrame::TLMFrame(uint8_t tlmVersionIn,
andresag 34:f6d4a699a1ea 20 uint16_t tlmBatteryVoltageIn,
andresag 34:f6d4a699a1ea 21 uint16_t tlmBeaconTemperatureIn,
andresag 34:f6d4a699a1ea 22 uint32_t tlmPduCountIn,
andresag 34:f6d4a699a1ea 23 uint32_t tlmTimeSinceBootIn) :
andresag 34:f6d4a699a1ea 24 tlmVersion(tlmVersionIn),
andresag 34:f6d4a699a1ea 25 lastTimeSinceBootRead(0),
andresag 34:f6d4a699a1ea 26 tlmBatteryVoltage(tlmBatteryVoltageIn),
andresag 34:f6d4a699a1ea 27 tlmBeaconTemperature(tlmBeaconTemperatureIn),
andresag 34:f6d4a699a1ea 28 tlmPduCount(tlmPduCountIn),
andresag 34:f6d4a699a1ea 29 tlmTimeSinceBoot(tlmTimeSinceBootIn)
andresag 34:f6d4a699a1ea 30 {
andresag 34:f6d4a699a1ea 31 }
andresag 34:f6d4a699a1ea 32
andresag 34:f6d4a699a1ea 33 void TLMFrame::setTLMData(uint8_t tlmVersionIn)
andresag 34:f6d4a699a1ea 34 {
andresag 34:f6d4a699a1ea 35 /* According to the Eddystone spec BatteryVoltage is 0 and
andresag 34:f6d4a699a1ea 36 * BeaconTemperature is 0x8000 if not supported
andresag 34:f6d4a699a1ea 37 */
andresag 34:f6d4a699a1ea 38 tlmVersion = tlmVersionIn;
andresag 34:f6d4a699a1ea 39 tlmBatteryVoltage = 0;
andresag 34:f6d4a699a1ea 40 tlmBeaconTemperature = 0x8000;
andresag 34:f6d4a699a1ea 41 tlmPduCount = 0;
andresag 34:f6d4a699a1ea 42 tlmTimeSinceBoot = 0;
andresag 34:f6d4a699a1ea 43 }
andresag 34:f6d4a699a1ea 44
andresag 34:f6d4a699a1ea 45 void TLMFrame::constructTLMFrame(uint8_t *rawFrame)
andresag 34:f6d4a699a1ea 46 {
andresag 34:f6d4a699a1ea 47 size_t index = 0;
andresag 34:f6d4a699a1ea 48 rawFrame[index++] = EDDYSTONE_UUID[0]; // 16-bit Eddystone UUID
andresag 34:f6d4a699a1ea 49 rawFrame[index++] = EDDYSTONE_UUID[1];
andresag 34:f6d4a699a1ea 50 rawFrame[index++] = FRAME_TYPE_TLM; // Eddystone frame type = Telemetry
andresag 34:f6d4a699a1ea 51 rawFrame[index++] = tlmVersion; // TLM Version Number
andresag 34:f6d4a699a1ea 52 rawFrame[index++] = (uint8_t)(tlmBatteryVoltage >> 8); // Battery Voltage[0]
andresag 34:f6d4a699a1ea 53 rawFrame[index++] = (uint8_t)(tlmBatteryVoltage >> 0); // Battery Voltage[1]
andresag 34:f6d4a699a1ea 54 rawFrame[index++] = (uint8_t)(tlmBeaconTemperature >> 8); // Beacon Temp[0]
andresag 34:f6d4a699a1ea 55 rawFrame[index++] = (uint8_t)(tlmBeaconTemperature >> 0); // Beacon Temp[1]
andresag 34:f6d4a699a1ea 56 rawFrame[index++] = (uint8_t)(tlmPduCount >> 24); // PDU Count [0]
andresag 34:f6d4a699a1ea 57 rawFrame[index++] = (uint8_t)(tlmPduCount >> 16); // PDU Count [1]
andresag 34:f6d4a699a1ea 58 rawFrame[index++] = (uint8_t)(tlmPduCount >> 8); // PDU Count [2]
andresag 34:f6d4a699a1ea 59 rawFrame[index++] = (uint8_t)(tlmPduCount >> 0); // PDU Count [3]
andresag 34:f6d4a699a1ea 60 rawFrame[index++] = (uint8_t)(tlmTimeSinceBoot >> 24); // Time Since Boot [0]
andresag 34:f6d4a699a1ea 61 rawFrame[index++] = (uint8_t)(tlmTimeSinceBoot >> 16); // Time Since Boot [1]
andresag 34:f6d4a699a1ea 62 rawFrame[index++] = (uint8_t)(tlmTimeSinceBoot >> 8); // Time Since Boot [2]
andresag 34:f6d4a699a1ea 63 rawFrame[index++] = (uint8_t)(tlmTimeSinceBoot >> 0); // Time Since Boot [3]
andresag 34:f6d4a699a1ea 64 }
andresag 34:f6d4a699a1ea 65
andresag 34:f6d4a699a1ea 66 size_t TLMFrame::getRawFrameSize(void) const
andresag 34:f6d4a699a1ea 67 {
andresag 34:f6d4a699a1ea 68 return FRAME_SIZE_TLM + EDDYSTONE_UUID_SIZE;
andresag 34:f6d4a699a1ea 69 }
andresag 34:f6d4a699a1ea 70
andresag 34:f6d4a699a1ea 71 void TLMFrame::updateTimeSinceBoot(uint32_t nowInMillis)
andresag 34:f6d4a699a1ea 72 {
andresag 34:f6d4a699a1ea 73 tlmTimeSinceBoot += (nowInMillis - lastTimeSinceBootRead) / 100;
andresag 34:f6d4a699a1ea 74 lastTimeSinceBootRead = nowInMillis;
andresag 34:f6d4a699a1ea 75 }
andresag 34:f6d4a699a1ea 76
andresag 34:f6d4a699a1ea 77 void TLMFrame::updateBatteryVoltage(uint16_t tlmBatteryVoltageIn)
andresag 34:f6d4a699a1ea 78 {
andresag 34:f6d4a699a1ea 79 tlmBatteryVoltage = tlmBatteryVoltageIn;
andresag 34:f6d4a699a1ea 80 }
andresag 34:f6d4a699a1ea 81
andresag 34:f6d4a699a1ea 82 void TLMFrame::updateBeaconTemperature(uint16_t tlmBeaconTemperatureIn)
andresag 34:f6d4a699a1ea 83 {
andresag 34:f6d4a699a1ea 84 tlmBeaconTemperature = tlmBeaconTemperatureIn;
andresag 34:f6d4a699a1ea 85 }
andresag 34:f6d4a699a1ea 86
andresag 34:f6d4a699a1ea 87 void TLMFrame::updatePduCount(void)
andresag 34:f6d4a699a1ea 88 {
andresag 34:f6d4a699a1ea 89 tlmPduCount++;
andresag 34:f6d4a699a1ea 90 }
andresag 34:f6d4a699a1ea 91
andresag 34:f6d4a699a1ea 92 uint16_t TLMFrame::getBatteryVoltage(void) const
andresag 34:f6d4a699a1ea 93 {
andresag 34:f6d4a699a1ea 94 return tlmBatteryVoltage;
andresag 34:f6d4a699a1ea 95 }
andresag 34:f6d4a699a1ea 96
andresag 34:f6d4a699a1ea 97 uint16_t TLMFrame::getBeaconTemperature(void) const
andresag 34:f6d4a699a1ea 98 {
andresag 34:f6d4a699a1ea 99 return tlmBeaconTemperature;
andresag 34:f6d4a699a1ea 100 }
andresag 34:f6d4a699a1ea 101
andresag 34:f6d4a699a1ea 102 uint8_t TLMFrame::getTLMVersion(void) const
andresag 34:f6d4a699a1ea 103 {
andresag 34:f6d4a699a1ea 104 return tlmVersion;
andresag 34:f6d4a699a1ea 105 }