Reading and sending sensor data over BLE
Dependencies: BSP_B-L475E-IOT01
Revision 2:864ddfb70a9c, committed 2016-07-28
- Comitter:
- mbed_official
- Date:
- Thu Jul 28 23:14:48 2016 +0100
- Parent:
- 1:b1f4696c0018
- Child:
- 3:0c7fa6a16f6f
- Commit message:
- Merge branch 'master' of https://github.com/ARMmbed/mbed-os-example-ble
Commit copied from ./src/github.com/ARMmbed/mbed-os-example-ble
Changed in this revision
--- a/.mbed Thu Jul 28 23:13:57 2016 +0100 +++ b/.mbed Thu Jul 28 23:14:48 2016 +0100 @@ -1,1 +1,1 @@ -ROOT=. +ROOT=.
--- a/.mbedignore Thu Jul 28 23:13:57 2016 +0100 +++ b/.mbedignore Thu Jul 28 23:14:48 2016 +0100 @@ -1,4 +1,4 @@ -mbed-os/features/net/* -mbed-os/uvisor-mbed-lib/* -mbed-os/frameworks/* -mbed-os/features/mbedtls/* +mbed-os/features/net/* +mbed-os/uvisor-mbed-lib/* +mbed-os/frameworks/* +mbed-os/features/mbedtls/*
--- a/mbed-events.lib Thu Jul 28 23:13:57 2016 +0100 +++ b/mbed-events.lib Thu Jul 28 23:14:48 2016 +0100 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/mbed-events.git#6be60bf880c11a0beafcc2064bf467f8d897529a +https://github.com/ARMmbed/mbed-events.git#6be60bf880c11a0beafcc2064bf467f8d897529a
--- a/mbed-os.lib Thu Jul 28 23:13:57 2016 +0100 +++ b/mbed-os.lib Thu Jul 28 23:14:48 2016 +0100 @@ -1,1 +1,1 @@ -https://github.com/mbedmicro/mbed#36468c9acbfeabb717d2cc7d2a7ea7d17df1ac09 +https://github.com/mbedmicro/mbed#36468c9acbfeabb717d2cc7d2a7ea7d17df1ac09
--- a/mbed_app.json Thu Jul 28 23:13:57 2016 +0100
+++ b/mbed_app.json Thu Jul 28 23:14:48 2016 +0100
@@ -1,13 +1,13 @@
-{
- "target_overrides": {
- "K64F": {
- "target.features_add": ["BLE"],
- "target.extra_labels_add": ["ST_BLUENRG"],
- "target.macros_add": ["IDB0XA1_D13_PATCH"]
- },
- "NUCLEO_F401RE": {
- "target.features_add": ["BLE"],
- "target.extra_labels_add": ["ST_BLUENRG"]
- }
- }
-}
+{
+ "target_overrides": {
+ "K64F": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["ST_BLUENRG"],
+ "target.macros_add": ["IDB0XA1_D13_PATCH"]
+ },
+ "NUCLEO_F401RE": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["ST_BLUENRG"]
+ }
+ }
+}
--- a/module.json Thu Jul 28 23:13:57 2016 +0100
+++ b/module.json Thu Jul 28 23:14:48 2016 +0100
@@ -1,16 +1,16 @@
-{
- "name": "ble-led",
- "version": "0.0.1",
- "description": "A simple service that demonstrates the use of a read-write characteristic to control a LED",
- "licenses": [
- {
- "url": "https://spdx.org/licenses/Apache-2.0",
- "type": "Apache-2.0"
- }
- ],
- "dependencies": {
- "ble": "^2.0.0"
- },
- "targetDependencies": {},
- "bin": "./source"
-}
+{
+ "name": "ble-led",
+ "version": "0.0.1",
+ "description": "A simple service that demonstrates the use of a read-write characteristic to control a LED",
+ "licenses": [
+ {
+ "url": "https://spdx.org/licenses/Apache-2.0",
+ "type": "Apache-2.0"
+ }
+ ],
+ "dependencies": {
+ "ble": "^2.0.0"
+ },
+ "targetDependencies": {},
+ "bin": "./source"
+}
--- a/readme.md Thu Jul 28 23:13:57 2016 +0100 +++ b/readme.md Thu Jul 28 23:14:48 2016 +0100 @@ -1,93 +1,93 @@ -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](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android. - -- [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone. - -Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). - -*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 instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). - -## 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. - - -1. Build the application and install it on your board as explained in the building instructions. -1. Open the BLE scanner on your phone. - -1. Start a scan. - -  - - **figure 1** How to start scan using nRF Master Control Panel 4.0.5 - -1. Find your device; it should be named `LED`. - -  - - **figure 2** Scan results using nRF Master Control Panel 4.0.5 - -1. Establish a connection with your device. - -  - - **figure 3** How to establish a connection using Master Control Panel 4.0.5 - -1. 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. - -  - - **figure 4** Representation of the Led service using Master Control Panel 4.0.5 - -1. Open the write pannel of the *LED state* characteristic. - -  - - **figure 5** How to read and write a characteristic value using Master Control Panel 4.0.5 - - -1. The characteristic accept a 1 byte value: - -  - - **figure 6** Write characteristic pannel using Master Control Panel 4.0.5 - - * `0x00`: LED ON - -  - - **figure 6** Write characteristic pannel to set the LED on using Master Control Panel 4.0.5 - - - * `0x01`: LED OFF - -  - - **figure 6** Write characteristic pannel to set the LED off using Master Control Panel 4.0.5 - - -1. 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. +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](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android. + +- [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone. + +Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). + +*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 instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). + +## 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. + + +1. Build the application and install it on your board as explained in the building instructions. +1. Open the BLE scanner on your phone. + +1. Start a scan. + +  + + **figure 1** How to start scan using nRF Master Control Panel 4.0.5 + +1. Find your device; it should be named `LED`. + +  + + **figure 2** Scan results using nRF Master Control Panel 4.0.5 + +1. Establish a connection with your device. + +  + + **figure 3** How to establish a connection using Master Control Panel 4.0.5 + +1. 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. + +  + + **figure 4** Representation of the Led service using Master Control Panel 4.0.5 + +1. Open the write pannel of the *LED state* characteristic. + +  + + **figure 5** How to read and write a characteristic value using Master Control Panel 4.0.5 + + +1. The characteristic accept a 1 byte value: + +  + + **figure 6** Write characteristic pannel using Master Control Panel 4.0.5 + + * `0x00`: LED ON + +  + + **figure 6** Write characteristic pannel to set the LED on using Master Control Panel 4.0.5 + + + * `0x01`: LED OFF + +  + + **figure 6** Write characteristic pannel to set the LED off using Master Control Panel 4.0.5 + + +1. 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.
--- a/shields/TARGET_ST_BLUENRG.lib Thu Jul 28 23:13:57 2016 +0100 +++ b/shields/TARGET_ST_BLUENRG.lib Thu Jul 28 23:14:48 2016 +0100 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/ble-x-nucleo-idb0xa1#6781fbb835912132d7fed0d78606c7090ae03959 +https://github.com/ARMmbed/ble-x-nucleo-idb0xa1#6781fbb835912132d7fed0d78606c7090ae03959
--- a/source/LEDService.h Thu Jul 28 23:13:57 2016 +0100
+++ b/source/LEDService.h Thu Jul 28 23:14:48 2016 +0100
@@ -1,43 +1,43 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef __BLE_LED_SERVICE_H__
-#define __BLE_LED_SERVICE_H__
-
-class LEDService {
-public:
- const static uint16_t LED_SERVICE_UUID = 0xA000;
- const static uint16_t LED_STATE_CHARACTERISTIC_UUID = 0xA001;
-
- LEDService(BLEDevice &_ble, bool initialValueForLEDCharacteristic) :
- ble(_ble), ledState(LED_STATE_CHARACTERISTIC_UUID, &initialValueForLEDCharacteristic)
- {
- GattCharacteristic *charTable[] = {&ledState};
- GattService ledService(LED_SERVICE_UUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
- ble.addService(ledService);
- }
-
- GattAttribute::Handle_t getValueHandle() const
- {
- return ledState.getValueHandle();
- }
-
-private:
- BLEDevice &ble;
- ReadWriteGattCharacteristic<bool> ledState;
-};
-
-#endif /* #ifndef __BLE_LED_SERVICE_H__ */
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __BLE_LED_SERVICE_H__
+#define __BLE_LED_SERVICE_H__
+
+class LEDService {
+public:
+ const static uint16_t LED_SERVICE_UUID = 0xA000;
+ const static uint16_t LED_STATE_CHARACTERISTIC_UUID = 0xA001;
+
+ LEDService(BLEDevice &_ble, bool initialValueForLEDCharacteristic) :
+ ble(_ble), ledState(LED_STATE_CHARACTERISTIC_UUID, &initialValueForLEDCharacteristic)
+ {
+ GattCharacteristic *charTable[] = {&ledState};
+ GattService ledService(LED_SERVICE_UUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
+ ble.addService(ledService);
+ }
+
+ GattAttribute::Handle_t getValueHandle() const
+ {
+ return ledState.getValueHandle();
+ }
+
+private:
+ BLEDevice &ble;
+ ReadWriteGattCharacteristic<bool> ledState;
+};
+
+#endif /* #ifndef __BLE_LED_SERVICE_H__ */
--- a/source/main.cpp Thu Jul 28 23:13:57 2016 +0100
+++ b/source/main.cpp Thu Jul 28 23:14:48 2016 +0100
@@ -1,117 +1,117 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include <mbed-events/events.h>
-#include <mbed.h>
-#include "ble/BLE.h"
-#include "LEDService.h"
-
-DigitalOut alivenessLED(LED1, 0);
-DigitalOut actuatedLED(LED2, 0);
-
-const static char DEVICE_NAME[] = "LED";
-static const uint16_t uuid16_list[] = {LEDService::LED_SERVICE_UUID};
-
-static EventQueue eventQueue(
- /* event count */ 10 * /* event size */ 32
-);
-
-LEDService *ledServicePtr;
-
-void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params)
-{
- (void) params;
- BLE::Instance().gap().startAdvertising();
-}
-
-void blinkCallback(void)
-{
- alivenessLED = !alivenessLED; /* Do blinky on LED1 to indicate system aliveness. */
-}
-
-/**
- * This callback allows the LEDService to receive updates to the ledState Characteristic.
- *
- * @param[in] params
- * Information about the characterisitc being updated.
- */
-void onDataWrittenCallback(const GattWriteCallbackParams *params) {
- if ((params->handle == ledServicePtr->getValueHandle()) && (params->len == 1)) {
- actuatedLED = *(params->data);
- }
-}
-
-/**
- * This function is called when the ble initialization process has failled
- */
-void onBleInitError(BLE &ble, ble_error_t error)
-{
- /* Initialization error handling should go here */
-}
-
-/**
- * Callback triggered when the ble initialization process has finished
- */
-void bleInitComplete(BLE::InitializationCompleteCallbackContext *params)
-{
- BLE& ble = params->ble;
- ble_error_t error = params->error;
-
- if (error != BLE_ERROR_NONE) {
- /* In case of error, forward the error handling to onBleInitError */
- onBleInitError(ble, error);
- return;
- }
-
- /* Ensure that it is the default instance of BLE */
- if(ble.getInstanceID() != BLE::DEFAULT_INSTANCE) {
- return;
- }
-
- ble.gap().onDisconnection(disconnectionCallback);
- ble.gattServer().onDataWritten(onDataWrittenCallback);
-
- bool initialValueForLEDCharacteristic = false;
- ledServicePtr = new LEDService(ble, initialValueForLEDCharacteristic);
-
- /* setup advertising */
- ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
- ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, (uint8_t *)uuid16_list, sizeof(uuid16_list));
- ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME, (uint8_t *)DEVICE_NAME, sizeof(DEVICE_NAME));
- ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
- ble.gap().setAdvertisingInterval(1000); /* 1000ms. */
- ble.gap().startAdvertising();
-}
-
-void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) {
- BLE &ble = BLE::Instance();
- eventQueue.post(Callback<void()>(&ble, &BLE::processEvents));
-}
-
-int main()
-{
- eventQueue.post_every(500, blinkCallback);
-
- BLE &ble = BLE::Instance();
- ble.onEventsToProcess(scheduleBleEventsProcessing);
- ble.init(bleInitComplete);
-
- while (true) {
- eventQueue.dispatch();
- }
-
- return 0;
-}
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <mbed-events/events.h>
+#include <mbed.h>
+#include "ble/BLE.h"
+#include "LEDService.h"
+
+DigitalOut alivenessLED(LED1, 0);
+DigitalOut actuatedLED(LED2, 0);
+
+const static char DEVICE_NAME[] = "LED";
+static const uint16_t uuid16_list[] = {LEDService::LED_SERVICE_UUID};
+
+static EventQueue eventQueue(
+ /* event count */ 10 * /* event size */ 32
+);
+
+LEDService *ledServicePtr;
+
+void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params)
+{
+ (void) params;
+ BLE::Instance().gap().startAdvertising();
+}
+
+void blinkCallback(void)
+{
+ alivenessLED = !alivenessLED; /* Do blinky on LED1 to indicate system aliveness. */
+}
+
+/**
+ * This callback allows the LEDService to receive updates to the ledState Characteristic.
+ *
+ * @param[in] params
+ * Information about the characterisitc being updated.
+ */
+void onDataWrittenCallback(const GattWriteCallbackParams *params) {
+ if ((params->handle == ledServicePtr->getValueHandle()) && (params->len == 1)) {
+ actuatedLED = *(params->data);
+ }
+}
+
+/**
+ * This function is called when the ble initialization process has failled
+ */
+void onBleInitError(BLE &ble, ble_error_t error)
+{
+ /* Initialization error handling should go here */
+}
+
+/**
+ * Callback triggered when the ble initialization process has finished
+ */
+void bleInitComplete(BLE::InitializationCompleteCallbackContext *params)
+{
+ BLE& ble = params->ble;
+ ble_error_t error = params->error;
+
+ if (error != BLE_ERROR_NONE) {
+ /* In case of error, forward the error handling to onBleInitError */
+ onBleInitError(ble, error);
+ return;
+ }
+
+ /* Ensure that it is the default instance of BLE */
+ if(ble.getInstanceID() != BLE::DEFAULT_INSTANCE) {
+ return;
+ }
+
+ ble.gap().onDisconnection(disconnectionCallback);
+ ble.gattServer().onDataWritten(onDataWrittenCallback);
+
+ bool initialValueForLEDCharacteristic = false;
+ ledServicePtr = new LEDService(ble, initialValueForLEDCharacteristic);
+
+ /* setup advertising */
+ ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
+ ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, (uint8_t *)uuid16_list, sizeof(uuid16_list));
+ ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME, (uint8_t *)DEVICE_NAME, sizeof(DEVICE_NAME));
+ ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
+ ble.gap().setAdvertisingInterval(1000); /* 1000ms. */
+ ble.gap().startAdvertising();
+}
+
+void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) {
+ BLE &ble = BLE::Instance();
+ eventQueue.post(Callback<void()>(&ble, &BLE::processEvents));
+}
+
+int main()
+{
+ eventQueue.post_every(500, blinkCallback);
+
+ BLE &ble = BLE::Instance();
+ ble.onEventsToProcess(scheduleBleEventsProcessing);
+ ble.init(bleInitComplete);
+
+ while (true) {
+ eventQueue.dispatch();
+ }
+
+ return 0;
+}