BLE beacon example

Files at this revision

API Documentation at this revision

Comitter:
lmottola
Date:
Tue Nov 13 13:43:41 2018 +0000
Parent:
73:bc1a73879fd6
Commit message:
Initial commit

Changed in this revision

img/beacon_details.png Show diff for this revision Revisions of this file
img/discovery.png Show diff for this revision Revisions of this file
img/start_scan.png Show diff for this revision Revisions of this file
readme.md Show diff for this revision Revisions of this file
shields/TARGET_ST_BLUENRG.lib Show diff for this revision Revisions of this file
source/main.cpp Show annotated file Show diff for this revision Revisions of this file
diff -r bc1a73879fd6 -r 3c07c0f8bd78 img/beacon_details.png
Binary file img/beacon_details.png has changed
diff -r bc1a73879fd6 -r 3c07c0f8bd78 img/discovery.png
Binary file img/discovery.png has changed
diff -r bc1a73879fd6 -r 3c07c0f8bd78 img/start_scan.png
Binary file img/start_scan.png has changed
diff -r bc1a73879fd6 -r 3c07c0f8bd78 readme.md
--- a/readme.md	Wed Nov 07 16:30:12 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,52 +0,0 @@
-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.
-
-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.
-
-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.
-
-# Running the application
-
-## Requirements
-
-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 :
-
-- [nRF Connect for Mobile](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
-
-- [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
-
-Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
-
-## Building instructions
-
-Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
-
-## Checking for success
-
-**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.
-
-1. Build the application and install it on your board as explained in the building instructions.
-1. Open the BLE scanner on your phone.
-1. Start a scan.
-
-    ![](img/start_scan.png)
-
-    **figure 1** How to start scan using nRF Master Control Panel 4.0.5
-
-1. Find your device; it should be tagged as an `iBeacon` and observe its advertisements (there is no need to connect to the beacon).
-
-    ![](img/discovery.png)
-
-    **figure 2** Scan results using nRF Master Control Panel 4.0.5
-
-1. View the beacon's details; the exact steps depend on which scanner you're using.
-
-    ![](img/beacon_details.png)
-
-    **figure 3** Beacon details using nRF Master Control Panel 4.0.5
-
-
-**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.
-
-If you can see the beacon and all its information, the application worked properly.
-
-For more information, see the [mbed Classic version of this application](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/BLE_iBeacon/).
diff -r bc1a73879fd6 -r 3c07c0f8bd78 shields/TARGET_ST_BLUENRG.lib
--- a/shields/TARGET_ST_BLUENRG.lib	Wed Nov 07 16:30:12 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#5e49580a0303c48c11f78ad2e5d92b5ffc02aadc
\ No newline at end of file
diff -r bc1a73879fd6 -r 3c07c0f8bd78 source/main.cpp
--- a/source/main.cpp	Wed Nov 07 16:30:12 2018 +0000
+++ b/source/main.cpp	Tue Nov 13 13:43:41 2018 +0000
@@ -1,19 +1,3 @@
-/* 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.
- */
-
 #include <events/mbed_events.h>
 #include <mbed.h>
 #include "ble/BLE.h"
@@ -31,19 +15,6 @@
     /* Initialization error handling should go here */
 }
 
-void printMacAddress()
-{
-    /* Print out device MAC address to the console*/
-    Gap::AddressType_t addr_type;
-    Gap::Address_t address;
-    BLE::Instance().gap().getAddress(&addr_type, address);
-    printf("DEVICE MAC ADDRESS: ");
-    for (int i = 5; i >= 1; i--){
-        printf("%02x:", address[i]);
-    }
-    printf("%02x\r\n", address[0]);
-}
-
 /**
  * Callback triggered when the ble initialization process has finished
  */
@@ -69,7 +40,7 @@
      * Major/Minor  = 0x1122 / 0x3344
      * Tx Power     = 0xC8 = 200, 2's compliment is 256-200 = (-56dB)
      *
-     * Note: please remember to calibrate your beacons TX Power for more accurate results.
+     * Note: please remember to calibrate your beacons TX Power for more accurate results
      */
     static const uint8_t uuid[] = {0xE2, 0x0A, 0x39, 0xF4, 0x73, 0xF5, 0x4B, 0xC4,
                                    0xA1, 0x2F, 0x17, 0xD1, 0xAD, 0x07, 0xA9, 0x61};
@@ -80,8 +51,6 @@
 
     ble.gap().setAdvertisingInterval(1000); /* 1000ms. */
     ble.gap().startAdvertising();
-
-    printMacAddress();
 }
 
 void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) {