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

BLE_Button is a BLE service template. It handles a read-only characteristic with a simple input (boolean values). The input's source is the button on the board itself - the characteristic's value changes when the button is pressed or released. The canonical source for this example lives at https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_Button

BLE_Button is a BLE service template. It handles a read-only characteristic with a simple input (boolean values). The input's source is the button on the board itself - the characteristic's value changes when the button is pressed or released.

The template covers:

• Setting up advertising and connection modes.

• Creating an input characteristic: read-only, boolean, with notifications.

• Constructing a service class and adding it to the BLE stack.

• Assigning UUIDs to the service and its characteristic.

• Pushing notifications when the characteristic's value changes.

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

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.

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

• Find your device; it should appear with the name `Button` in the scanner.

figure 2 Scan results using nRF Master Control Panel 4.0.5

• Establish a connection with the device.

figure 3 How to establish a connection using Master Control Panel 4.0.5

• Discover the services and the characteristics on the device. The Button service has the UUID `0xA000` and includes the Button state characteristic which has the UUID `0xA001`. Depending on your scanner, non standard 16-bit UUID's can be displayed as 128-bit UUID's. If it is the case the following format will be used: `0000XXXX-0000-1000-8000-00805F9B34FB` where `XXXX` is the hexadecimal representation of the 16-bit UUID value.

figure 4 Representation of the Button service using Master Control Panel 4.0.5

• Register for the notifications sent by the button state characteristic then the scanner will automatically receive a notification containing the new state of the button every time the state of the button changes.

figure 5 How to register to notifications using Master Control Panel 4.0.5

• Pressing Button 1 on your board updates the state of the button and sends a notification to the scanner. The new state of the button characteristic value should be equal to 0x01.

figure 6 Notification of button pressed using Master Control Panel 4.0.5

• Releasing Button 1 on your board updates the state of the button and sends a notification to the scanner. The new state of the button characteristic value should be equal to 0x00.

figure 7 Notification of button depressed using Master Control Panel 4.0.5

Merge pull request #22 from ARMmbed/button_configuration_documentation



Document how to add button configuration on new targets.



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