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.h@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 #ifndef __TLMFRAME_H__
andresag 34:f6d4a699a1ea 18 #define __TLMFRAME_H__
andresag 34:f6d4a699a1ea 19
andresag 34:f6d4a699a1ea 20 #include "EddystoneTypes.h"
andresag 34:f6d4a699a1ea 21
andresag 34:f6d4a699a1ea 22 class TLMFrame
andresag 34:f6d4a699a1ea 23 {
andresag 34:f6d4a699a1ea 24 public:
andresag 34:f6d4a699a1ea 25 TLMFrame(uint8_t tlmVersionIn = 0,
andresag 34:f6d4a699a1ea 26 uint16_t tlmBatteryVoltageIn = 0,
andresag 34:f6d4a699a1ea 27 uint16_t tlmBeaconTemperatureIn = 0x8000,
andresag 34:f6d4a699a1ea 28 uint32_t tlmPduCountIn = 0,
andresag 34:f6d4a699a1ea 29 uint32_t tlmTimeSinceBootIn = 0);
andresag 34:f6d4a699a1ea 30
andresag 34:f6d4a699a1ea 31 void setTLMData(uint8_t tlmVersionIn = 0);
andresag 34:f6d4a699a1ea 32
andresag 34:f6d4a699a1ea 33 void constructTLMFrame(uint8_t *rawFrame);
andresag 34:f6d4a699a1ea 34
andresag 34:f6d4a699a1ea 35 size_t getRawFrameSize(void) const;
andresag 34:f6d4a699a1ea 36
andresag 34:f6d4a699a1ea 37 void updateTimeSinceBoot(uint32_t nowInMillis);
andresag 34:f6d4a699a1ea 38
andresag 34:f6d4a699a1ea 39 void updateBatteryVoltage(uint16_t tlmBatteryVoltageIn);
andresag 34:f6d4a699a1ea 40
andresag 34:f6d4a699a1ea 41 void updateBeaconTemperature(uint16_t tlmBeaconTemperatureIn);
andresag 34:f6d4a699a1ea 42
andresag 34:f6d4a699a1ea 43 void updatePduCount(void);
andresag 34:f6d4a699a1ea 44
andresag 34:f6d4a699a1ea 45 uint16_t getBatteryVoltage(void) const;
andresag 34:f6d4a699a1ea 46
andresag 34:f6d4a699a1ea 47 uint16_t getBeaconTemperature(void) const;
andresag 34:f6d4a699a1ea 48
andresag 34:f6d4a699a1ea 49 uint8_t getTLMVersion(void) const;
andresag 34:f6d4a699a1ea 50
andresag 34:f6d4a699a1ea 51 private:
andresag 34:f6d4a699a1ea 52 static const uint8_t FRAME_TYPE_TLM = 0x20;
andresag 34:f6d4a699a1ea 53 static const uint8_t FRAME_SIZE_TLM = 14;
andresag 34:f6d4a699a1ea 54
andresag 34:f6d4a699a1ea 55 uint8_t tlmVersion;
andresag 34:f6d4a699a1ea 56 uint32_t lastTimeSinceBootRead;
andresag 34:f6d4a699a1ea 57 uint16_t tlmBatteryVoltage;
andresag 34:f6d4a699a1ea 58 uint16_t tlmBeaconTemperature;
andresag 34:f6d4a699a1ea 59 uint32_t tlmPduCount;
andresag 34:f6d4a699a1ea 60 uint32_t tlmTimeSinceBoot;
andresag 34:f6d4a699a1ea 61 };
andresag 34:f6d4a699a1ea 62
andresag 34:f6d4a699a1ea 63 #endif /* __TLMFRAME_H__ */