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