he LED example demonstrates the use of a read-write characteristic to control a LED through a phone app. The canonical source for this example lives at https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_LED

To help you create your own BLE services, we have created this service template. The LED example demonstrates the use of a read-write characteristic to control a LED through a phone app.

The template covers:

  • Setting up advertising and connection states.
  • Assigning UUIDs to the service and its characteristic.
  • Creating an input characteristic: read-write, boolean. This characteristic offers control of the LED.
  • Constructing a service class and adding it to the BLE stack.

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.

  • NOTE:* If you have more than a single mbed board (e.g. nrf51dk or mkit) you can run the BLE_LED and BLE_LEDBlinker at the same time. For more information please refer to the BLE_LEDBlinker demo.

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-LED/raw-file/c6a8f2b3efb6/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 `LED`.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/scan_results.png

figure 2 Scan results using nRF Master Control Panel 4.0.5

  • Establish a connection with your device.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/connection.png

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

  • Discover the services and the characteristics on the device. The *LED service* has the UUID `0xA000` and includes the *LED 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.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/discovery.png

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

  • Open the write pannel of the *LED state* characteristic.

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/write_characteristic.png

figure 5 How to read and write a characteristic value using Master Control Panel 4.0.5

  • The characteristic accept a 1 byte value:

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/write_pannel.png

figure 6 Write characteristic pannel using Master Control Panel 4.0.5

`0x00`: LED ON

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/LED_ON.png

figure 6 Write characteristic pannel to set the LED on using Master Control Panel 4.0.5

`0x01`: LED OFF

https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-LED/raw-file/c6a8f2b3efb6/img/LED_OFF.png

figure 6 Write characteristic pannel to set the LED off using Master Control Panel 4.0.5

  • Toggle the LED characteristic value and see the LED turn ON or turn OFF according to the value you set.

If you can see the characteristic, and the LED is turned on/off as you toggle its value, the application is working properly.

Committer:
Vincent Coubard
Date:
Thu Jul 28 23:13:57 2016 +0100
Revision:
1:b1f4696c0018
Parent:
0:c6a8f2b3efb6
Child:
2:864ddfb70a9c
Sync with mbed-os-5.1.0-rc3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vincent Coubard 0:c6a8f2b3efb6 1 /* mbed Microcontroller Library
Vincent Coubard 0:c6a8f2b3efb6 2 * Copyright (c) 2006-2013 ARM Limited
Vincent Coubard 0:c6a8f2b3efb6 3 *
Vincent Coubard 0:c6a8f2b3efb6 4 * Licensed under the Apache License, Version 2.0 (the "License");
Vincent Coubard 0:c6a8f2b3efb6 5 * you may not use this file except in compliance with the License.
Vincent Coubard 0:c6a8f2b3efb6 6 * You may obtain a copy of the License at
Vincent Coubard 0:c6a8f2b3efb6 7 *
Vincent Coubard 0:c6a8f2b3efb6 8 * http://www.apache.org/licenses/LICENSE-2.0
Vincent Coubard 0:c6a8f2b3efb6 9 *
Vincent Coubard 0:c6a8f2b3efb6 10 * Unless required by applicable law or agreed to in writing, software
Vincent Coubard 0:c6a8f2b3efb6 11 * distributed under the License is distributed on an "AS IS" BASIS,
Vincent Coubard 0:c6a8f2b3efb6 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Vincent Coubard 0:c6a8f2b3efb6 13 * See the License for the specific language governing permissions and
Vincent Coubard 0:c6a8f2b3efb6 14 * limitations under the License.
Vincent Coubard 0:c6a8f2b3efb6 15 */
Vincent Coubard 0:c6a8f2b3efb6 16
Vincent Coubard 0:c6a8f2b3efb6 17 #include <mbed-events/events.h>
Vincent Coubard 0:c6a8f2b3efb6 18 #include <mbed.h>
Vincent Coubard 0:c6a8f2b3efb6 19 #include "ble/BLE.h"
Vincent Coubard 0:c6a8f2b3efb6 20 #include "LEDService.h"
Vincent Coubard 0:c6a8f2b3efb6 21
Vincent Coubard 0:c6a8f2b3efb6 22 DigitalOut alivenessLED(LED1, 0);
Vincent Coubard 0:c6a8f2b3efb6 23 DigitalOut actuatedLED(LED2, 0);
Vincent Coubard 0:c6a8f2b3efb6 24
Vincent Coubard 0:c6a8f2b3efb6 25 const static char DEVICE_NAME[] = "LED";
Vincent Coubard 0:c6a8f2b3efb6 26 static const uint16_t uuid16_list[] = {LEDService::LED_SERVICE_UUID};
Vincent Coubard 0:c6a8f2b3efb6 27
Vincent Coubard 0:c6a8f2b3efb6 28 static EventQueue eventQueue(
Vincent Coubard 0:c6a8f2b3efb6 29 /* event count */ 10 * /* event size */ 32
Vincent Coubard 0:c6a8f2b3efb6 30 );
Vincent Coubard 0:c6a8f2b3efb6 31
Vincent Coubard 0:c6a8f2b3efb6 32 LEDService *ledServicePtr;
Vincent Coubard 0:c6a8f2b3efb6 33
Vincent Coubard 0:c6a8f2b3efb6 34 void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params)
Vincent Coubard 0:c6a8f2b3efb6 35 {
Vincent Coubard 0:c6a8f2b3efb6 36 (void) params;
Vincent Coubard 0:c6a8f2b3efb6 37 BLE::Instance().gap().startAdvertising();
Vincent Coubard 0:c6a8f2b3efb6 38 }
Vincent Coubard 0:c6a8f2b3efb6 39
Vincent Coubard 0:c6a8f2b3efb6 40 void blinkCallback(void)
Vincent Coubard 0:c6a8f2b3efb6 41 {
Vincent Coubard 0:c6a8f2b3efb6 42 alivenessLED = !alivenessLED; /* Do blinky on LED1 to indicate system aliveness. */
Vincent Coubard 0:c6a8f2b3efb6 43 }
Vincent Coubard 0:c6a8f2b3efb6 44
Vincent Coubard 0:c6a8f2b3efb6 45 /**
Vincent Coubard 0:c6a8f2b3efb6 46 * This callback allows the LEDService to receive updates to the ledState Characteristic.
Vincent Coubard 0:c6a8f2b3efb6 47 *
Vincent Coubard 0:c6a8f2b3efb6 48 * @param[in] params
Vincent Coubard 0:c6a8f2b3efb6 49 * Information about the characterisitc being updated.
Vincent Coubard 0:c6a8f2b3efb6 50 */
Vincent Coubard 0:c6a8f2b3efb6 51 void onDataWrittenCallback(const GattWriteCallbackParams *params) {
Vincent Coubard 0:c6a8f2b3efb6 52 if ((params->handle == ledServicePtr->getValueHandle()) && (params->len == 1)) {
Vincent Coubard 0:c6a8f2b3efb6 53 actuatedLED = *(params->data);
Vincent Coubard 0:c6a8f2b3efb6 54 }
Vincent Coubard 0:c6a8f2b3efb6 55 }
Vincent Coubard 0:c6a8f2b3efb6 56
Vincent Coubard 0:c6a8f2b3efb6 57 /**
Vincent Coubard 0:c6a8f2b3efb6 58 * This function is called when the ble initialization process has failled
Vincent Coubard 0:c6a8f2b3efb6 59 */
Vincent Coubard 0:c6a8f2b3efb6 60 void onBleInitError(BLE &ble, ble_error_t error)
Vincent Coubard 0:c6a8f2b3efb6 61 {
Vincent Coubard 0:c6a8f2b3efb6 62 /* Initialization error handling should go here */
Vincent Coubard 0:c6a8f2b3efb6 63 }
Vincent Coubard 0:c6a8f2b3efb6 64
Vincent Coubard 0:c6a8f2b3efb6 65 /**
Vincent Coubard 0:c6a8f2b3efb6 66 * Callback triggered when the ble initialization process has finished
Vincent Coubard 0:c6a8f2b3efb6 67 */
Vincent Coubard 0:c6a8f2b3efb6 68 void bleInitComplete(BLE::InitializationCompleteCallbackContext *params)
Vincent Coubard 0:c6a8f2b3efb6 69 {
Vincent Coubard 0:c6a8f2b3efb6 70 BLE& ble = params->ble;
Vincent Coubard 0:c6a8f2b3efb6 71 ble_error_t error = params->error;
Vincent Coubard 0:c6a8f2b3efb6 72
Vincent Coubard 0:c6a8f2b3efb6 73 if (error != BLE_ERROR_NONE) {
Vincent Coubard 0:c6a8f2b3efb6 74 /* In case of error, forward the error handling to onBleInitError */
Vincent Coubard 0:c6a8f2b3efb6 75 onBleInitError(ble, error);
Vincent Coubard 0:c6a8f2b3efb6 76 return;
Vincent Coubard 0:c6a8f2b3efb6 77 }
Vincent Coubard 0:c6a8f2b3efb6 78
Vincent Coubard 0:c6a8f2b3efb6 79 /* Ensure that it is the default instance of BLE */
Vincent Coubard 0:c6a8f2b3efb6 80 if(ble.getInstanceID() != BLE::DEFAULT_INSTANCE) {
Vincent Coubard 0:c6a8f2b3efb6 81 return;
Vincent Coubard 0:c6a8f2b3efb6 82 }
Vincent Coubard 0:c6a8f2b3efb6 83
Vincent Coubard 0:c6a8f2b3efb6 84 ble.gap().onDisconnection(disconnectionCallback);
Vincent Coubard 0:c6a8f2b3efb6 85 ble.gattServer().onDataWritten(onDataWrittenCallback);
Vincent Coubard 0:c6a8f2b3efb6 86
Vincent Coubard 0:c6a8f2b3efb6 87 bool initialValueForLEDCharacteristic = false;
Vincent Coubard 0:c6a8f2b3efb6 88 ledServicePtr = new LEDService(ble, initialValueForLEDCharacteristic);
Vincent Coubard 0:c6a8f2b3efb6 89
Vincent Coubard 0:c6a8f2b3efb6 90 /* setup advertising */
Vincent Coubard 0:c6a8f2b3efb6 91 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
Vincent Coubard 0:c6a8f2b3efb6 92 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, (uint8_t *)uuid16_list, sizeof(uuid16_list));
Vincent Coubard 0:c6a8f2b3efb6 93 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME, (uint8_t *)DEVICE_NAME, sizeof(DEVICE_NAME));
Vincent Coubard 0:c6a8f2b3efb6 94 ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
Vincent Coubard 0:c6a8f2b3efb6 95 ble.gap().setAdvertisingInterval(1000); /* 1000ms. */
Vincent Coubard 0:c6a8f2b3efb6 96 ble.gap().startAdvertising();
Vincent Coubard 0:c6a8f2b3efb6 97 }
Vincent Coubard 0:c6a8f2b3efb6 98
Vincent Coubard 0:c6a8f2b3efb6 99 void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) {
Vincent Coubard 0:c6a8f2b3efb6 100 BLE &ble = BLE::Instance();
Vincent Coubard 0:c6a8f2b3efb6 101 eventQueue.post(Callback<void()>(&ble, &BLE::processEvents));
Vincent Coubard 0:c6a8f2b3efb6 102 }
Vincent Coubard 0:c6a8f2b3efb6 103
Vincent Coubard 0:c6a8f2b3efb6 104 int main()
Vincent Coubard 0:c6a8f2b3efb6 105 {
Vincent Coubard 1:b1f4696c0018 106 eventQueue.post_every(500, blinkCallback);
Vincent Coubard 0:c6a8f2b3efb6 107
Vincent Coubard 0:c6a8f2b3efb6 108 BLE &ble = BLE::Instance();
Vincent Coubard 0:c6a8f2b3efb6 109 ble.onEventsToProcess(scheduleBleEventsProcessing);
Vincent Coubard 0:c6a8f2b3efb6 110 ble.init(bleInitComplete);
Vincent Coubard 0:c6a8f2b3efb6 111
Vincent Coubard 0:c6a8f2b3efb6 112 while (true) {
Vincent Coubard 0:c6a8f2b3efb6 113 eventQueue.dispatch();
Vincent Coubard 0:c6a8f2b3efb6 114 }
Vincent Coubard 0:c6a8f2b3efb6 115
Vincent Coubard 0:c6a8f2b3efb6 116 return 0;
Vincent Coubard 0:c6a8f2b3efb6 117 }