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

BLE GAP Button 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-GAPButton/

Please read the documentation in this page.

README.md@3:f0ed4199b362, 2016-07-28 (annotated)

Committer:
mbed_official
Date:
Thu Jul 28 23:26:14 2016 +0100
Revision:
3:f0ed4199b362
Parent:
2:e532bbe3fd8e
Child:
7:d4dd083eba53
Merge branch 'master' of https://github.com/ARMmbed/mbed-os-example-ble





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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 3:f0ed4199b362 1 # Button count over GAP
mbed_official 3:f0ed4199b362 2
mbed_official 3:f0ed4199b362 3 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:
mbed_official 3:f0ed4199b362 4
mbed_official 3:f0ed4199b362 5 1. 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).
mbed_official 3:f0ed4199b362 6
mbed_official 3:f0ed4199b362 7 1. We transmit the value in the SERVICE_DATA field of the advertising payload.
mbed_official 3:f0ed4199b362 8
mbed_official 3:f0ed4199b362 9 # Running the application
mbed_official 3:f0ed4199b362 10
mbed_official 3:f0ed4199b362 11 ## Requirements
mbed_official 3:f0ed4199b362 12
mbed_official 3:f0ed4199b362 13 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 3:f0ed4199b362 14
mbed_official 3:f0ed4199b362 15 - [nRF Master Control Panel](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
mbed_official 3:f0ed4199b362 16
mbed_official 3:f0ed4199b362 17 - [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
mbed_official 3:f0ed4199b362 18
mbed_official 3:f0ed4199b362 19 Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 3:f0ed4199b362 20
mbed_official 3:f0ed4199b362 21 ## Building instructions
mbed_official 3:f0ed4199b362 22
mbed_official 3:f0ed4199b362 23 Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 3:f0ed4199b362 24
mbed_official 3:f0ed4199b362 25 ## Checking for success
mbed_official 3:f0ed4199b362 26
mbed_official 3:f0ed4199b362 27 **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 3:f0ed4199b362 28
mbed_official 3:f0ed4199b362 29 1. Build the application and install it on your board as explained in the building instructions.
mbed_official 3:f0ed4199b362 30
mbed_official 3:f0ed4199b362 31 1. Open the BLE scanner on your phone.
mbed_official 3:f0ed4199b362 32
mbed_official 3:f0ed4199b362 33 1. Start a scan.
mbed_official 3:f0ed4199b362 34
mbed_official 3:f0ed4199b362 35 ![](img/start_scan.png)
mbed_official 3:f0ed4199b362 36
mbed_official 3:f0ed4199b362 37 **figure 1** How to start scan using nRF Master Control Panel 4.0.5.
mbed_official 3:f0ed4199b362 38
mbed_official 3:f0ed4199b362 39 1. 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).
mbed_official 3:f0ed4199b362 40
mbed_official 3:f0ed4199b362 41 ![](img/discovery.png)
mbed_official 3:f0ed4199b362 42
mbed_official 3:f0ed4199b362 43 **figure 2** Scan results using nRF Master Control Panel 4.0.5.
mbed_official 3:f0ed4199b362 44
mbed_official 3:f0ed4199b362 45 1. The Service Data field of the advertisement packet broadcasted by your device reflects the button press count. The starting value is 0.
mbed_official 3:f0ed4199b362 46
mbed_official 3:f0ed4199b362 47 ![](img/initial_state.png)
mbed_official 3:f0ed4199b362 48
mbed_official 3:f0ed4199b362 49 **figure 3** Initial state of the button using nRF Master Control Panel 4.0.5.
mbed_official 3:f0ed4199b362 50
mbed_official 3:f0ed4199b362 51 1. Press the button on the device.
mbed_official 3:f0ed4199b362 52
mbed_official 3:f0ed4199b362 53 ![](img/first_press.png)
mbed_official 3:f0ed4199b362 54
mbed_official 3:f0ed4199b362 55 **figure 3** State after 1 button press using nRF Master Control Panel 4.0.5.
mbed_official 3:f0ed4199b362 56
mbed_official 3:f0ed4199b362 57 1. The Service Data field value of the advertisement packet should change every time you press the button.
mbed_official 3:f0ed4199b362 58
mbed_official 3:f0ed4199b362 59 ![](img/result.png)
mbed_official 3:f0ed4199b362 60
mbed_official 3:f0ed4199b362 61 **figure 3** State after 6 button press using nRF Master Control Panel 4.0.5.
mbed_official 3:f0ed4199b362 62
mbed_official 3:f0ed4199b362 63 ## Note
mbed_official 3:f0ed4199b362 64
mbed_official 3:f0ed4199b362 65 Since broadcasting is not reliable and your phone may scan intermittently, it is possible that your phone will miss button updates.