mbed-os-examples / Mbed OS mbed-os-example-ble-EddystoneService

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:

- Android version

- iOS version

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

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:

1. Open the ``config.json`` file in this sample.
2. Change ``soft device`` to ``S110``.
3. 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.

/* mbed Microcontroller Library
 * Copyright (c) 2006-2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __UIDFRAME_H__
#define __UIDFRAME_H__

#include <string.h>
#include "EddystoneTypes.h"

/**
 * Class that encapsulates data that belongs to the Eddystone-UID frame. For
 * more information refer to https://github.com/google/eddystone/tree/master/eddystone-uid.
 */
class UIDFrame
{
public:
    /**
     * Construct a new instance of this class.
     */
    UIDFrame(void);

    /**
     * Construct a new instance of this class.
     *
     * @param[in] uidNamespaceIDIn
     *              The Eddystone-UID namespace ID.
     * @param[in] uidInstanceIDIn
     *              The Eddystone-UID instance ID.
     */
    UIDFrame(const UIDNamespaceID_t uidNamespaceIDIn, const UIDInstanceID_t  uidInstanceIDIn);

    /**
     * Set the instance and namespace ID.
     *
     * @param[in] uidNamespaceIDIn
     *              The new Eddystone-UID namespace ID.
     * @param[in] uidInstanceIDIn
     *              The new Eddystone-UID instance ID.
     */
    void setUIDData(const UIDNamespaceID_t &uidNamespaceIDIn, const UIDInstanceID_t &uidInstanceIDIn);

    /**
     * Construct the raw bytes of the Eddystone-UID frame that will be directly
     * used in the advertising packets.
     *
     * @param[in] rawFrame
     *              Pointer to the location where the raw frame will be stored.
     * @param[in] advPowerLevel
     *              Power level value included withing the raw frame.
     */
    void constructUIDFrame(uint8_t *rawFrame, int8_t advPowerLevel);

    /**
     * Get the size of the Eddystone-UID frame constructed with the
     * current state of the UIDFrame object.
     *
     * @return The size in bytes of the Eddystone-UID frame.
     */
    size_t getRawFrameSize(void) const;

    /**
     * Get the Eddystone-UID namespace ID.
     *
     * @return A pointer to the namespace ID.
     */
    uint8_t* getUIDNamespaceID(void);

    /**
     * Get the Eddystone-UID instance ID.
     *
     * @return A pointer to the instance ID.
     */
    uint8_t* getUIDInstanceID(void);

private:
    /**
     *  The byte ID of an Eddystone-UID frame.
     */
    static const uint8_t FRAME_TYPE_UID = 0x00;
    /**
     * The size (in bytes) of an Eddystone-UID frame.
     */
    static const uint8_t FRAME_SIZE_UID = 20;

    /**
     * The Eddystone-UID namespace ID.
     */
    UIDNamespaceID_t     uidNamespaceID;
    /**
     * The Eddystone-UID instance ID.
     */
    UIDInstanceID_t      uidInstanceID;
};

#endif  /* __UIDFRAME_H__ */