ST / Mbed OS mbed-os-example-ble-Beacon

BLE Beacon example

This example is a fork of the following mbed-os example:

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-Beacon/

Please read the documentation in this page.

readme.md@1:2fd54f1254fe, 2016-07-28 (annotated)

Committer:
mbed_official
Date:
Thu Jul 28 23:14:25 2016 +0100
Revision:
1:2fd54f1254fe
Parent:
0:66b59f6860ed
Child:
2:401488de6e22
Merge branch 'master' of https://github.com/ARMmbed/mbed-os-example-ble





Commit copied from ./src/github.com/ARMmbed/mbed-os-example-ble

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 1:2fd54f1254fe 1 This example creates a BLE beacon: a method of advertising a small amount of information to nearby devices. The information doesn't have to be human-readable; it can be in a format that only an application can use.
mbed_official 1:2fd54f1254fe 2
mbed_official 1:2fd54f1254fe 3 Beacons are very easy to set up: the code for all beacons is the same, and only the information you want to advertise - the beacon payload - needs to change.
mbed_official 1:2fd54f1254fe 4
mbed_official 1:2fd54f1254fe 5 This example advertises a UUID, a major and minor number and the transmission strength. The major and minor numbers are an example of information that is not (normally) meaningful to humans, but that an application can use to identify the beacon and display related information. For example, if the major number is a store ID and the minor number is a location in that store, then a matching application can use these numbers to query a database and display location-specific information.
mbed_official 1:2fd54f1254fe 6
mbed_official 1:2fd54f1254fe 7 # Running the application
mbed_official 1:2fd54f1254fe 8
mbed_official 1:2fd54f1254fe 9 ## Requirements
mbed_official 1:2fd54f1254fe 10
mbed_official 1:2fd54f1254fe 11 The sample application can be seen on any BLE scanner on a smartphone. If you don't have a scanner on your phone, please install :
mbed_official 1:2fd54f1254fe 12
mbed_official 1:2fd54f1254fe 13 - [nRF Master Control Panel](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
mbed_official 1:2fd54f1254fe 14
mbed_official 1:2fd54f1254fe 15 - [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
mbed_official 1:2fd54f1254fe 16
mbed_official 1:2fd54f1254fe 17 Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 1:2fd54f1254fe 18
mbed_official 1:2fd54f1254fe 19 ## Building instructions
mbed_official 1:2fd54f1254fe 20
mbed_official 1:2fd54f1254fe 21 Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 1:2fd54f1254fe 22
mbed_official 1:2fd54f1254fe 23 ## Checking for success
mbed_official 1:2fd54f1254fe 24
mbed_official 1:2fd54f1254fe 25 **Note:** Screens captures depicted below show what is expected from this example if the scanner used is *nRF Master Control Panel* version 4.0.5. If you encounter any difficulties consider trying another scanner or another version of nRF Master Control Panel. Alternative scanners may require reference to their manuals.
mbed_official 1:2fd54f1254fe 26
mbed_official 1:2fd54f1254fe 27 1. Build the application and install it on your board as explained in the building instructions.
mbed_official 1:2fd54f1254fe 28 1. Open the BLE scanner on your phone.
mbed_official 1:2fd54f1254fe 29 1. Start a scan.
mbed_official 1:2fd54f1254fe 30
mbed_official 1:2fd54f1254fe 31 ![](img/start_scan.png)
mbed_official 1:2fd54f1254fe 32
mbed_official 1:2fd54f1254fe 33 **figure 1** How to start scan using nRF Master Control Panel 4.0.5
mbed_official 1:2fd54f1254fe 34
mbed_official 1:2fd54f1254fe 35 1. Find your device; it should be tagged as an `iBeacon` and observe its advertisements (there is no need to connect to the beacon).
mbed_official 1:2fd54f1254fe 36
mbed_official 1:2fd54f1254fe 37 ![](img/discovery.png)
mbed_official 1:2fd54f1254fe 38
mbed_official 1:2fd54f1254fe 39 **figure 2** Scan results using nRF Master Control Panel 4.0.5
mbed_official 1:2fd54f1254fe 40
mbed_official 1:2fd54f1254fe 41 1. View the beacon's details; the exact steps depend on which scanner you're using.
mbed_official 1:2fd54f1254fe 42
mbed_official 1:2fd54f1254fe 43 ![](img/beacon_details.png)
mbed_official 1:2fd54f1254fe 44
mbed_official 1:2fd54f1254fe 45 **figure 3** Beacon details using nRF Master Control Panel 4.0.5
mbed_official 1:2fd54f1254fe 46
mbed_official 1:2fd54f1254fe 47
mbed_official 1:2fd54f1254fe 48 **Tip:** If you are in an area with many BLE devices, it may be difficult to identify your beacon. The simplest solution is to turn your board off and on, initiate a new scan on your BLE scanner every time, and look for the beacon that appears only when your board is on.
mbed_official 1:2fd54f1254fe 49
mbed_official 1:2fd54f1254fe 50 If you can see the beacon and all its information, the application worked properly.
mbed_official 1:2fd54f1254fe 51
mbed_official 1:2fd54f1254fe 52 For more information, see the [mbed Classic version of this application](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/BLE_iBeacon/).