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.

main.cpp@23:05e9bb3b13af, 2015-07-23 (annotated)

Committer:
mbedAustin
Date:
Thu Jul 23 20:17:11 2015 +0000
Revision:
23:05e9bb3b13af
Parent:
22:160766614338
Child:
24:8edfe6730cc2
Renamed ZipBeacon->Eddystone, everything compiles and continues to work just fine.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:c04d932e96c9 1 /* mbed Microcontroller Library
screamer 0:c04d932e96c9 2 * Copyright (c) 2006-2013 ARM Limited
screamer 0:c04d932e96c9 3 *
screamer 0:c04d932e96c9 4 * Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:c04d932e96c9 5 * you may not use this file except in compliance with the License.
screamer 0:c04d932e96c9 6 * You may obtain a copy of the License at
screamer 0:c04d932e96c9 7 *
screamer 0:c04d932e96c9 8 * http://www.apache.org/licenses/LICENSE-2.0
screamer 0:c04d932e96c9 9 *
screamer 0:c04d932e96c9 10 * Unless required by applicable law or agreed to in writing, software
screamer 0:c04d932e96c9 11 * distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:c04d932e96c9 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:c04d932e96c9 13 * See the License for the specific language governing permissions and
screamer 0:c04d932e96c9 14 * limitations under the License.
screamer 0:c04d932e96c9 15 */
screamer 0:c04d932e96c9 16
screamer 0:c04d932e96c9 17 #include "mbed.h"
rgrover1 7:e9800c45e065 18 #include "BLE.h"
mbedAustin 23:05e9bb3b13af 19 #include "EddystoneConfigService.h"
screamer 0:c04d932e96c9 20 #include "DFUService.h"
screamer 0:c04d932e96c9 21 #include "DeviceInformationService.h"
rgrover1 2:8020d6d4455a 22 #include "ConfigParamsPersistence.h"
screamer 0:c04d932e96c9 23
rgrover1 8:1a21308e5008 24 BLE ble;
mbedAustin 23:05e9bb3b13af 25 EddystoneConfigService *zipBeaconConfig;
mbedAustin 18:91c36071aafb 26 Ticker test;
mbedAustin 15:af8c24f34a9f 27 //InterruptIn button(p17);
screamer 0:c04d932e96c9 28
screamer 0:c04d932e96c9 29 /**
screamer 0:c04d932e96c9 30 * URIBeaconConfig service can operate in two modes: a configuration mode which
screamer 0:c04d932e96c9 31 * allows a user to update settings over a connection; and normal URIBeacon mode
screamer 0:c04d932e96c9 32 * which involves advertising a URI. Constructing an object from URIBeaconConfig
screamer 0:c04d932e96c9 33 * service sets up advertisements for the configuration mode. It is then up to
screamer 0:c04d932e96c9 34 * the application to switch to URIBeacon mode based on some timeout.
screamer 0:c04d932e96c9 35 *
screamer 0:c04d932e96c9 36 * The following help with this switch.
screamer 0:c04d932e96c9 37 */
mbedAustin 15:af8c24f34a9f 38 static const int CONFIG_ADVERTISEMENT_TIMEOUT_SECONDS = 5; // Duration after power-on that config service is available.
screamer 0:c04d932e96c9 39 Ticker configAdvertisementTimeoutTicker;
screamer 0:c04d932e96c9 40
screamer 0:c04d932e96c9 41 /**
mbedAustin 19:f7c33fa88ca5 42 * Stop advertising the Config Service after a delay; and switch to a non-connectable advertising mode only beacon.
screamer 0:c04d932e96c9 43 */
screamer 0:c04d932e96c9 44 void timeout(void)
screamer 0:c04d932e96c9 45 {
screamer 0:c04d932e96c9 46 Gap::GapState_t state;
screamer 0:c04d932e96c9 47 state = ble.getGapState();
screamer 0:c04d932e96c9 48 if (!state.connected) { /* don't switch if we're in a connected state. */
mbedAustin 23:05e9bb3b13af 49 zipBeaconConfig->setupEddystoneAdvertisements();
rgrover1 8:1a21308e5008 50 ble.gap().startAdvertising();
screamer 0:c04d932e96c9 51
screamer 0:c04d932e96c9 52 configAdvertisementTimeoutTicker.detach(); /* disable the callback from the timeout Ticker. */
mbedAustin 15:af8c24f34a9f 53 printf("removing config service\r\n");
mbedAustin 22:160766614338 54 //test.attach(stupidWrapperFn,1);
screamer 0:c04d932e96c9 55 }
screamer 0:c04d932e96c9 56 }
screamer 0:c04d932e96c9 57
screamer 0:c04d932e96c9 58 /**
screamer 0:c04d932e96c9 59 * Callback triggered upon a disconnection event. Needs to re-enable advertisements.
screamer 0:c04d932e96c9 60 */
screamer 0:c04d932e96c9 61 void disconnectionCallback(Gap::Handle_t handle, Gap::DisconnectionReason_t reason)
screamer 0:c04d932e96c9 62 {
rgrover1 8:1a21308e5008 63 ble.gap().startAdvertising();
mbedAustin 15:af8c24f34a9f 64 printf("disconnect CB\r\n");
screamer 0:c04d932e96c9 65 }
screamer 0:c04d932e96c9 66
screamer 0:c04d932e96c9 67 int main(void)
screamer 0:c04d932e96c9 68 {
mbedAustin 15:af8c24f34a9f 69 printf("Starting Example\r\n");
screamer 0:c04d932e96c9 70 ble.init();
rgrover1 8:1a21308e5008 71 ble.gap().onDisconnection(disconnectionCallback);
screamer 0:c04d932e96c9 72
screamer 0:c04d932e96c9 73 /*
screamer 0:c04d932e96c9 74 * Load parameters from (platform specific) persistent storage. Parameters
screamer 0:c04d932e96c9 75 * can be set to non-default values while the URIBeacon is in configuration
screamer 0:c04d932e96c9 76 * mode (within the first 60 seconds of power-up). Thereafter, parameters
screamer 0:c04d932e96c9 77 * get copied out to persistent storage before switching to normal URIBeacon
screamer 0:c04d932e96c9 78 * operation.
screamer 0:c04d932e96c9 79 */
mbedAustin 23:05e9bb3b13af 80 EddystoneConfigService::Params_t params;
rgrover1 2:8020d6d4455a 81 bool fetchedFromPersistentStorage = loadURIBeaconConfigParams(&params);
screamer 0:c04d932e96c9 82
screamer 0:c04d932e96c9 83 /* Initialize a zipBeaconConfig service providing config params, default URI, and power levels. */
mbedAustin 23:05e9bb3b13af 84 static EddystoneConfigService::PowerLevels_t defaultAdvPowerLevels = {-20, -4, 0, 10}; // Values for ADV packets related to firmware levels
mbedAustin 23:05e9bb3b13af 85 zipBeaconConfig = new EddystoneConfigService(ble, params, !fetchedFromPersistentStorage, "http://mbed.org", defaultAdvPowerLevels);
screamer 0:c04d932e96c9 86 if (!zipBeaconConfig->configuredSuccessfully()) {
screamer 0:c04d932e96c9 87 error("failed to accommodate URI");
screamer 0:c04d932e96c9 88 }
screamer 0:c04d932e96c9 89 configAdvertisementTimeoutTicker.attach(timeout, CONFIG_ADVERTISEMENT_TIMEOUT_SECONDS);
screamer 0:c04d932e96c9 90
screamer 0:c04d932e96c9 91 // Setup auxiliary services to allow over-the-air firmware updates, etc
screamer 0:c04d932e96c9 92 DFUService dfu(ble);
screamer 0:c04d932e96c9 93 DeviceInformationService deviceInfo(ble, "ARM", "UriBeacon", "SN1", "hw-rev1", "fw-rev1", "soft-rev1");
screamer 0:c04d932e96c9 94
rgrover1 8:1a21308e5008 95 ble.gap().startAdvertising(); /* Set the whole thing in motion. After this call a GAP central can scan the zipBeaconConfig
rgrover1 8:1a21308e5008 96 * service. This can then be switched to the normal URIBeacon functionality after a timeout. */
mbedAustin 15:af8c24f34a9f 97 printf("Running...\r\n");
screamer 0:c04d932e96c9 98 while (true) {
screamer 0:c04d932e96c9 99 ble.waitForEvent();
screamer 0:c04d932e96c9 100 }
screamer 0:c04d932e96c9 101 }