Eddystone beacons broadcast a small amount of information, like URLs, to nearby BLE devices. The canonical source for this example lives at https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_EddystoneService
Eddystone beacons broadcast a small amount of information, like URLs, to nearby BLE devices.
The Eddystone Beacon sample application runs in two stages:
- On startup, the Configuration Service (which allows modification of the beacon runs for a user-defined period (default - 30 seconds).
- When the Configuration Service period ends, the Eddystone Service broadcasts advertisement packets.
Running the application
Requirements
You should install the *Physical Web* application on your phone:
Note: It is also possible to use a regular scanner to interract with your Eddystone beacon but it requires knowledge about BLE and Eddystone beacon specification out of the scope of this document.
Hardware requirements are in the main readme.
Building instructions
Building with mbed CLI
If you'd like to use mbed CLI to build this, then you should refer to the main readme. The instructions here relate to using the developer.mbed.org Online Compiler
In order to build this example in the mbed Online Compiler, first import the example using the ‘Import’ button on the right hand side.
Next, select a platform to build for. This must either be a platform that supports BLE, for example the NRF51-DK, or one of the following:
List of platforms supporting Bluetooth Low Energy
Or you must also add a piece of hardware and the supporting library that includes a Bluetooth Low Energy driver for that hardware, for example the K64F or NUCLEO_F401RE with the X-NUCLEO-IDB05A1
List of components supporting Bluetooth Low Energy.
Once you have selected your platform, compile the example and drag and drop the resulting binary onto your board.
For general instructions on using the mbed Online Compiler, please see the mbed Handbook
Working with nRF51-based 16K targets
Because of memory constraints, you can't use the SoftDevice 130 (S130) to build for nRF51-based 16K targets. If you are using these targets, then before building:
- Open the ``config.json`` file in this sample.
- Change ``soft device`` to ``S110``.
- Save.
You can now build for nRF51-based 16K targets.
Setting up the beacon
By default, the beacon directs to the url ``http://mbed.org``. You can change this to your own URL in two ways:
- Manually edit the code in ``main.cpp`` in your copy of the sample.
- Build and run the application's default code as explained in the building instructions. When the beacon starts up, the Configuration Service runs for 30 seconds (this is the default value; you can change it in ``main.cpp``). While the Configuration Service runs, you can use a BLE scanner on your phone to edit the values the service presents.
Checking for success
- Build the application and install it on your board as explained in the building instructions.
- Open the *Physical Web* application on your phone. It will start to search for nearby beacons.
figure 1 Start of the *Physical Web* application version 0.1.856 on Android
- When the beacon starts up, the Configuration Service runs for 30 seconds. During this time it is possible to change the URL advertised by the beacon. It is also important to note that during these 30 seconds, your device will not advertise any URL.
figure 2 How to open the beacon configuration view using the *Physical Web* application version 0.1.856 on Android
- Edit the URL advertised by your beacon.
figure 3 How to edit the URL advertised by your beacon using the *Physical Web* application version 0.1.856 on Android
- Save the URL which will be advertised by your beacon.
figure 4 How to save your beacon configuration and start advertising URL using the *Physical Web* application version 0.1.856 on Android.
- Find your device; it should advertise the URL you have set.
figure 5 Display of URL advertised by your beacon using the *Physical Web* application version 0.1.856 on Android.
Note: You can use the Eddystone Observer sample instead of a phone application.
source/UIDFrame.h@2:9ee673e0b86a, 2016-07-28 (annotated)
- Committer:
- Vincent Coubard
- Date:
- Thu Jul 28 23:27:37 2016 +0100
- Revision:
- 2:9ee673e0b86a
- Parent:
- 1:9db4d46bb63f
- Child:
- 3:5120491ba317
Sync with mbed-os-5.1.0-rc3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Vincent Coubard |
2:9ee673e0b86a | 1 | /* mbed Microcontroller Library |
Vincent Coubard |
2:9ee673e0b86a | 2 | * Copyright (c) 2006-2015 ARM Limited |
Vincent Coubard |
2:9ee673e0b86a | 3 | * |
Vincent Coubard |
2:9ee673e0b86a | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Vincent Coubard |
2:9ee673e0b86a | 5 | * you may not use this file except in compliance with the License. |
Vincent Coubard |
2:9ee673e0b86a | 6 | * You may obtain a copy of the License at |
Vincent Coubard |
2:9ee673e0b86a | 7 | * |
Vincent Coubard |
2:9ee673e0b86a | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Vincent Coubard |
2:9ee673e0b86a | 9 | * |
Vincent Coubard |
2:9ee673e0b86a | 10 | * Unless required by applicable law or agreed to in writing, software |
Vincent Coubard |
2:9ee673e0b86a | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Vincent Coubard |
2:9ee673e0b86a | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Vincent Coubard |
2:9ee673e0b86a | 13 | * See the License for the specific language governing permissions and |
Vincent Coubard |
2:9ee673e0b86a | 14 | * limitations under the License. |
Vincent Coubard |
2:9ee673e0b86a | 15 | */ |
Vincent Coubard |
2:9ee673e0b86a | 16 | |
Vincent Coubard |
2:9ee673e0b86a | 17 | #ifndef __UIDFRAME_H__ |
Vincent Coubard |
2:9ee673e0b86a | 18 | #define __UIDFRAME_H__ |
Vincent Coubard |
2:9ee673e0b86a | 19 | |
Vincent Coubard |
2:9ee673e0b86a | 20 | #include <string.h> |
Vincent Coubard |
2:9ee673e0b86a | 21 | #include "EddystoneTypes.h" |
Vincent Coubard |
2:9ee673e0b86a | 22 | |
Vincent Coubard |
2:9ee673e0b86a | 23 | /** |
Vincent Coubard |
2:9ee673e0b86a | 24 | * Class that encapsulates data that belongs to the Eddystone-UID frame. For |
Vincent Coubard |
2:9ee673e0b86a | 25 | * more information refer to https://github.com/google/eddystone/tree/master/eddystone-uid. |
Vincent Coubard |
2:9ee673e0b86a | 26 | */ |
Vincent Coubard |
2:9ee673e0b86a | 27 | class UIDFrame |
Vincent Coubard |
2:9ee673e0b86a | 28 | { |
Vincent Coubard |
2:9ee673e0b86a | 29 | public: |
Vincent Coubard |
2:9ee673e0b86a | 30 | /** |
Vincent Coubard |
2:9ee673e0b86a | 31 | * Construct a new instance of this class. |
Vincent Coubard |
2:9ee673e0b86a | 32 | */ |
Vincent Coubard |
2:9ee673e0b86a | 33 | UIDFrame(void); |
Vincent Coubard |
2:9ee673e0b86a | 34 | |
Vincent Coubard |
2:9ee673e0b86a | 35 | /** |
Vincent Coubard |
2:9ee673e0b86a | 36 | * Construct a new instance of this class. |
Vincent Coubard |
2:9ee673e0b86a | 37 | * |
Vincent Coubard |
2:9ee673e0b86a | 38 | * @param[in] uidNamespaceIDIn |
Vincent Coubard |
2:9ee673e0b86a | 39 | * The Eddystone-UID namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 40 | * @param[in] uidInstanceIDIn |
Vincent Coubard |
2:9ee673e0b86a | 41 | * The Eddystone-UID instance ID. |
Vincent Coubard |
2:9ee673e0b86a | 42 | */ |
Vincent Coubard |
2:9ee673e0b86a | 43 | UIDFrame(const UIDNamespaceID_t uidNamespaceIDIn, const UIDInstanceID_t uidInstanceIDIn); |
Vincent Coubard |
2:9ee673e0b86a | 44 | |
Vincent Coubard |
2:9ee673e0b86a | 45 | /** |
Vincent Coubard |
2:9ee673e0b86a | 46 | * Set the instance and namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 47 | * |
Vincent Coubard |
2:9ee673e0b86a | 48 | * @param[in] uidNamespaceIDIn |
Vincent Coubard |
2:9ee673e0b86a | 49 | * The new Eddystone-UID namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 50 | * @param[in] uidInstanceIDIn |
Vincent Coubard |
2:9ee673e0b86a | 51 | * The new Eddystone-UID instance ID. |
Vincent Coubard |
2:9ee673e0b86a | 52 | */ |
Vincent Coubard |
2:9ee673e0b86a | 53 | void setUIDData(const UIDNamespaceID_t &uidNamespaceIDIn, const UIDInstanceID_t &uidInstanceIDIn); |
Vincent Coubard |
2:9ee673e0b86a | 54 | |
Vincent Coubard |
2:9ee673e0b86a | 55 | /** |
Vincent Coubard |
2:9ee673e0b86a | 56 | * Construct the raw bytes of the Eddystone-UID frame that will be directly |
Vincent Coubard |
2:9ee673e0b86a | 57 | * used in the advertising packets. |
Vincent Coubard |
2:9ee673e0b86a | 58 | * |
Vincent Coubard |
2:9ee673e0b86a | 59 | * @param[in] rawFrame |
Vincent Coubard |
2:9ee673e0b86a | 60 | * Pointer to the location where the raw frame will be stored. |
Vincent Coubard |
2:9ee673e0b86a | 61 | * @param[in] advPowerLevel |
Vincent Coubard |
2:9ee673e0b86a | 62 | * Power level value included withing the raw frame. |
Vincent Coubard |
2:9ee673e0b86a | 63 | */ |
Vincent Coubard |
2:9ee673e0b86a | 64 | void constructUIDFrame(uint8_t *rawFrame, int8_t advPowerLevel); |
Vincent Coubard |
2:9ee673e0b86a | 65 | |
Vincent Coubard |
2:9ee673e0b86a | 66 | /** |
Vincent Coubard |
2:9ee673e0b86a | 67 | * Get the size of the Eddystone-UID frame constructed with the |
Vincent Coubard |
2:9ee673e0b86a | 68 | * current state of the UIDFrame object. |
Vincent Coubard |
2:9ee673e0b86a | 69 | * |
Vincent Coubard |
2:9ee673e0b86a | 70 | * @return The size in bytes of the Eddystone-UID frame. |
Vincent Coubard |
2:9ee673e0b86a | 71 | */ |
Vincent Coubard |
2:9ee673e0b86a | 72 | size_t getRawFrameSize(void) const; |
Vincent Coubard |
2:9ee673e0b86a | 73 | |
Vincent Coubard |
2:9ee673e0b86a | 74 | /** |
Vincent Coubard |
2:9ee673e0b86a | 75 | * Get the Eddystone-UID namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 76 | * |
Vincent Coubard |
2:9ee673e0b86a | 77 | * @return A pointer to the namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 78 | */ |
Vincent Coubard |
2:9ee673e0b86a | 79 | uint8_t* getUIDNamespaceID(void); |
Vincent Coubard |
2:9ee673e0b86a | 80 | |
Vincent Coubard |
2:9ee673e0b86a | 81 | /** |
Vincent Coubard |
2:9ee673e0b86a | 82 | * Get the Eddystone-UID instance ID. |
Vincent Coubard |
2:9ee673e0b86a | 83 | * |
Vincent Coubard |
2:9ee673e0b86a | 84 | * @return A pointer to the instance ID. |
Vincent Coubard |
2:9ee673e0b86a | 85 | */ |
Vincent Coubard |
2:9ee673e0b86a | 86 | uint8_t* getUIDInstanceID(void); |
Vincent Coubard |
2:9ee673e0b86a | 87 | |
Vincent Coubard |
2:9ee673e0b86a | 88 | private: |
Vincent Coubard |
2:9ee673e0b86a | 89 | /** |
Vincent Coubard |
2:9ee673e0b86a | 90 | * The byte ID of an Eddystone-UID frame. |
Vincent Coubard |
2:9ee673e0b86a | 91 | */ |
Vincent Coubard |
2:9ee673e0b86a | 92 | static const uint8_t FRAME_TYPE_UID = 0x00; |
Vincent Coubard |
2:9ee673e0b86a | 93 | /** |
Vincent Coubard |
2:9ee673e0b86a | 94 | * The size (in bytes) of an Eddystone-UID frame. |
Vincent Coubard |
2:9ee673e0b86a | 95 | */ |
Vincent Coubard |
2:9ee673e0b86a | 96 | static const uint8_t FRAME_SIZE_UID = 20; |
Vincent Coubard |
2:9ee673e0b86a | 97 | |
Vincent Coubard |
2:9ee673e0b86a | 98 | /** |
Vincent Coubard |
2:9ee673e0b86a | 99 | * The Eddystone-UID namespace ID. |
Vincent Coubard |
2:9ee673e0b86a | 100 | */ |
Vincent Coubard |
2:9ee673e0b86a | 101 | UIDNamespaceID_t uidNamespaceID; |
Vincent Coubard |
2:9ee673e0b86a | 102 | /** |
Vincent Coubard |
2:9ee673e0b86a | 103 | * The Eddystone-UID instance ID. |
Vincent Coubard |
2:9ee673e0b86a | 104 | */ |
Vincent Coubard |
2:9ee673e0b86a | 105 | UIDInstanceID_t uidInstanceID; |
Vincent Coubard |
2:9ee673e0b86a | 106 | }; |
Vincent Coubard |
2:9ee673e0b86a | 107 | |
Vincent Coubard |
2:9ee673e0b86a | 108 | #endif /* __UIDFRAME_H__ */ |