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

This application shows how to use GAP to transmit a simple value to disconnected peer listening for advertisement every time that a value is updated. The canonical source for this example lives at: https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_GAPButton

Button count over GAP

This application shows how to use GAP to transmit a simple value to disconnected peer listening for advertisement every time that a value is updated:

  • The value is a count of how many times a button on the device was pressed (the code actually monitors the button's releases, not press downs).
  • We transmit the value in the SERVICE_DATA field of the advertising payload.

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 Master Control Panel for Android.

- LightBlue for iPhone.

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

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.

  • Build the application and install it on your board as explained in the building instructions.
  • Open the BLE scanner on your phone.
  • Start a scan.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/raw-file/8f898b781de2/img/start_scan.png

figure 1 How to start scan using nRF Master Control Panel 4.0.5.

  • Find your device; it should be named `GAPButton`; and look at the advertisement broadcasted by your device (there is no need to connect to your device).

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/raw-file/8f898b781de2/img/discovery.png

figure 2 Scan results using nRF Master Control Panel 4.0.5.

  • The Service Data field of the advertisement packet broadcasted by your device reflects the button press count. The starting value is 0.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/raw-file/8f898b781de2/img/initial_state.png

figure 3 Initial state of the button using nRF Master Control Panel 4.0.5.

  • Press the button on the device.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/raw-file/8f898b781de2/img/first_press.png

figure 3 State after 1 button press using nRF Master Control Panel 4.0.5.

  • The Service Data field value of the advertisement packet should change every time you press the button.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/raw-file/8f898b781de2/img/result.png

figure 3 State after 6 button press using nRF Master Control Panel 4.0.5.

Note

Since broadcasting is not reliable and your phone may scan intermittently, it is possible that your phone will miss button updates.

source/pretty_printer.h@83:5f43cd2a93e6, 2019-04-26 (annotated)

Committer:
mbed_official
Date:
Fri Apr 26 18:01:01 2019 +0100
Revision:
83:5f43cd2a93e6
Parent:
78:3f848aa75a8a 
Merge pull request #230 from LMESTM/NUCLEO_WB55RG_readme



Update readme with some NUCLEO_WB55RG basic info

.

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 78:3f848aa75a8a 1 /* mbed Microcontroller Library
mbed_official 78:3f848aa75a8a 2 * Copyright (c) 2018 ARM Limited
mbed_official 78:3f848aa75a8a 3 *
mbed_official 78:3f848aa75a8a 4 * Licensed under the Apache License, Version 2.0 (the "License");
mbed_official 78:3f848aa75a8a 5 * you may not use this file except in compliance with the License.
mbed_official 78:3f848aa75a8a 6 * You may obtain a copy of the License at
mbed_official 78:3f848aa75a8a 7 *
mbed_official 78:3f848aa75a8a 8 * http://www.apache.org/licenses/LICENSE-2.0
mbed_official 78:3f848aa75a8a 9 *
mbed_official 78:3f848aa75a8a 10 * Unless required by applicable law or agreed to in writing, software
mbed_official 78:3f848aa75a8a 11 * distributed under the License is distributed on an "AS IS" BASIS,
mbed_official 78:3f848aa75a8a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbed_official 78:3f848aa75a8a 13 * See the License for the specific language governing permissions and
mbed_official 78:3f848aa75a8a 14 * limitations under the License.
mbed_official 78:3f848aa75a8a 15 */
mbed_official 78:3f848aa75a8a 16
mbed_official 78:3f848aa75a8a 17 #include <mbed.h>
mbed_official 78:3f848aa75a8a 18 #include "ble/BLE.h"
mbed_official 78:3f848aa75a8a 19
mbed_official 78:3f848aa75a8a 20 inline void print_error(ble_error_t error, const char* msg)
mbed_official 78:3f848aa75a8a 21 {
mbed_official 78:3f848aa75a8a 22 printf("%s: ", msg);
mbed_official 78:3f848aa75a8a 23 switch(error) {
mbed_official 78:3f848aa75a8a 24 case BLE_ERROR_NONE:
mbed_official 78:3f848aa75a8a 25 printf("BLE_ERROR_NONE: No error");
mbed_official 78:3f848aa75a8a 26 break;
mbed_official 78:3f848aa75a8a 27 case BLE_ERROR_BUFFER_OVERFLOW:
mbed_official 78:3f848aa75a8a 28 printf("BLE_ERROR_BUFFER_OVERFLOW: The requested action would cause a buffer overflow and has been aborted");
mbed_official 78:3f848aa75a8a 29 break;
mbed_official 78:3f848aa75a8a 30 case BLE_ERROR_NOT_IMPLEMENTED:
mbed_official 78:3f848aa75a8a 31 printf("BLE_ERROR_NOT_IMPLEMENTED: Requested a feature that isn't yet implement or isn't supported by the target HW");
mbed_official 78:3f848aa75a8a 32 break;
mbed_official 78:3f848aa75a8a 33 case BLE_ERROR_PARAM_OUT_OF_RANGE:
mbed_official 78:3f848aa75a8a 34 printf("BLE_ERROR_PARAM_OUT_OF_RANGE: One of the supplied parameters is outside the valid range");
mbed_official 78:3f848aa75a8a 35 break;
mbed_official 78:3f848aa75a8a 36 case BLE_ERROR_INVALID_PARAM:
mbed_official 78:3f848aa75a8a 37 printf("BLE_ERROR_INVALID_PARAM: One of the supplied parameters is invalid");
mbed_official 78:3f848aa75a8a 38 break;
mbed_official 78:3f848aa75a8a 39 case BLE_STACK_BUSY:
mbed_official 78:3f848aa75a8a 40 printf("BLE_STACK_BUSY: The stack is busy");
mbed_official 78:3f848aa75a8a 41 break;
mbed_official 78:3f848aa75a8a 42 case BLE_ERROR_INVALID_STATE:
mbed_official 78:3f848aa75a8a 43 printf("BLE_ERROR_INVALID_STATE: Invalid state");
mbed_official 78:3f848aa75a8a 44 break;
mbed_official 78:3f848aa75a8a 45 case BLE_ERROR_NO_MEM:
mbed_official 78:3f848aa75a8a 46 printf("BLE_ERROR_NO_MEM: Out of Memory");
mbed_official 78:3f848aa75a8a 47 break;
mbed_official 78:3f848aa75a8a 48 case BLE_ERROR_OPERATION_NOT_PERMITTED:
mbed_official 78:3f848aa75a8a 49 printf("BLE_ERROR_OPERATION_NOT_PERMITTED");
mbed_official 78:3f848aa75a8a 50 break;
mbed_official 78:3f848aa75a8a 51 case BLE_ERROR_INITIALIZATION_INCOMPLETE:
mbed_official 78:3f848aa75a8a 52 printf("BLE_ERROR_INITIALIZATION_INCOMPLETE");
mbed_official 78:3f848aa75a8a 53 break;
mbed_official 78:3f848aa75a8a 54 case BLE_ERROR_ALREADY_INITIALIZED:
mbed_official 78:3f848aa75a8a 55 printf("BLE_ERROR_ALREADY_INITIALIZED");
mbed_official 78:3f848aa75a8a 56 break;
mbed_official 78:3f848aa75a8a 57 case BLE_ERROR_UNSPECIFIED:
mbed_official 78:3f848aa75a8a 58 printf("BLE_ERROR_UNSPECIFIED: Unknown error");
mbed_official 78:3f848aa75a8a 59 break;
mbed_official 78:3f848aa75a8a 60 case BLE_ERROR_INTERNAL_STACK_FAILURE:
mbed_official 78:3f848aa75a8a 61 printf("BLE_ERROR_INTERNAL_STACK_FAILURE: internal stack faillure");
mbed_official 78:3f848aa75a8a 62 break;
mbed_official 78:3f848aa75a8a 63 }
mbed_official 78:3f848aa75a8a 64 printf("\r\n");
mbed_official 78:3f848aa75a8a 65 }
mbed_official 78:3f848aa75a8a 66
mbed_official 78:3f848aa75a8a 67 /** print device address to the terminal */
mbed_official 78:3f848aa75a8a 68 inline void print_address(const Gap::Address_t &addr)
mbed_official 78:3f848aa75a8a 69 {
mbed_official 78:3f848aa75a8a 70 printf("%02x:%02x:%02x:%02x:%02x:%02x\r\n",
mbed_official 78:3f848aa75a8a 71 addr[5], addr[4], addr[3], addr[2], addr[1], addr[0]);
mbed_official 78:3f848aa75a8a 72 }
mbed_official 78:3f848aa75a8a 73
mbed_official 78:3f848aa75a8a 74 inline void print_mac_address()
mbed_official 78:3f848aa75a8a 75 {
mbed_official 78:3f848aa75a8a 76 /* Print out device MAC address to the console*/
mbed_official 78:3f848aa75a8a 77 Gap::AddressType_t addr_type;
mbed_official 78:3f848aa75a8a 78 Gap::Address_t address;
mbed_official 78:3f848aa75a8a 79 BLE::Instance().gap().getAddress(&addr_type, address);
mbed_official 78:3f848aa75a8a 80 printf("DEVICE MAC ADDRESS: ");
mbed_official 78:3f848aa75a8a 81 print_address(address);
mbed_official 78:3f848aa75a8a 82 }
mbed_official 78:3f848aa75a8a 83
mbed_official 78:3f848aa75a8a 84 inline const char* phy_to_string(Gap::Phy_t phy) {
mbed_official 78:3f848aa75a8a 85 switch(phy.value()) {
mbed_official 78:3f848aa75a8a 86 case Gap::Phy_t::LE_1M:
mbed_official 78:3f848aa75a8a 87 return "LE 1M";
mbed_official 78:3f848aa75a8a 88 case Gap::Phy_t::LE_2M:
mbed_official 78:3f848aa75a8a 89 return "LE 2M";
mbed_official 78:3f848aa75a8a 90 case Gap::Phy_t::LE_CODED:
mbed_official 78:3f848aa75a8a 91 return "LE coded";
mbed_official 78:3f848aa75a8a 92 default:
mbed_official 78:3f848aa75a8a 93 return "invalid PHY";
mbed_official 78:3f848aa75a8a 94 }
mbed_official 78:3f848aa75a8a 95 }