Merge pull request ARMmbed#196 from paul-szczepanek-arm/update-api

Examples updated to use the new API

.gitignore

@@ -31,3 +31,20 @@ build/
 yotta_modules/
 yotta_targets/
 .DS_Store
+
+# clion
+.idea/ 
+cmake-build-*/
+CMakeLists.txt
+
+# exporters 
+GettingStarted.html
+
+# mbed build system
+.mbed
+mbed-os/
+mbed_settings.py
+mbed_config.h
+*.pyc
+TARGET_CORDIO_BLUENRG/
+

BLE_BatteryLevel/.mbedignore

@@ -0,0 +1 @@
+deprecated/*

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/.mbed

@@ -0,0 +1 @@
+ROOT=.

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/mbed-os.lib

@@ -0,0 +1 @@
+https://github.com/ARMmbed/mbed-os/#bf6f2c3c6434a6de9eb9511feffa5948b3d1f20f

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/mbed_app.json

@@ -0,0 +1,16 @@
+{
+ "target_overrides": {
+ "K64F": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["CORDIO", "CORDIO_BLUENRG"]
+ },
+ "NUCLEO_F401RE": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["CORDIO", "CORDIO_BLUENRG"]
+ },
+ "DISCO_L475VG_IOT01A": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["CORDIO", "CORDIO_BLUENRG"]
+ }
+ }
+}

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/module.json

@@ -0,0 +1,16 @@
+{
+ "name": "ble-batterylevel",
+ "version": "0.0.1",
+ "description": "An example of creating and updating a simple GATT Service using the BLE_API",
+ "licenses": [
+ {
+ "url": "https://spdx.org/licenses/Apache-2.0",
+ "type": "Apache-2.0"
+ }
+ ],
+ "dependencies": {
+ "ble": "^2.0.0"
+ },
+ "targetDependencies": {},
+ "bin": "./source"
+}

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/readme.md

@@ -0,0 +1,68 @@
+This example creates and updates a standard Battery Level service containing a single
+GATT characteristic.
+
+The [battery service transmits](https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml) a device's battery level in percentage, with 100% being a fully charged battery and 0% being a fully drained battery.
+
+Although the sample application runs on a BLE device, it doesn't show the device's real battery level (because that changes very slowly and will make for a dull example). Instead, it transmits a fake battery level that starts at 50% (half charged). Every half second, it increments the battery level, going in single increments until reaching 100% (as if the battery is charging). It then drops down to 20% to start incrementing again.
+
+# 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).
+
+## 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.
+
+ ![](img/start_scan.png)
+
+ **figure 1** How to start scan using nRF Master Control Panel 4.0.5
+
+1. Find your device; it should be named `BATTERY`.
+
+ ![](img/scan_result.png)
+
+ **figure 2** Scan results using nRF Master Control Panel 4.0.5
+
+1. Establish a connection with your device.
+
+ ![](img/connection.png)
+
+ **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 *Battery service* has the UUID 0x180F and includes the *Battery level* characteristic which has the UUID 0x2A19.
+
+ ![](img/discovery.png)
+
+ **figure 4** Representation of the Battery service using Master Control Panel 4.0.5
+
+1. Register for the notifications sent by the *Battery level* characteristic.
+
+ ![](img/register_to_notifications.png)
+
+ **figure 5** How to register to notifications using Master Control Panel 4.0.5
+
+
+1. You should see the battery level value change every half second. It begins at 50, goes up to 100 (in steps of 1), resets to 20 and so on.
+
+ ![](img/notifications.png)
+
+ **figure 6** Notifications view using Master Control Panel 4.0.5
+
+If you can see the characteristic, and if its value is incrementing correctly, the application is working properly.
+

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/shields/TARGET_CORDIO_BLUENRG.lib

@@ -0,0 +1 @@
+https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#5e49580a0303c48c11f78ad2e5d92b5ffc02aadc

BLE_BatteryLevel/deprecated/BLE_BatteryLevel/source/main.cpp

@@ -0,0 +1,129 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2014 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 <events/mbed_events.h>
+#include <mbed.h>
+#include "ble/BLE.h"
+#include "ble/Gap.h"
+#include "ble/services/BatteryService.h"
+
+DigitalOut led1(LED1, 1);
+
+const static char DEVICE_NAME[] = "BATTERY";
+static const uint16_t uuid16_list[] = {GattService::UUID_BATTERY_SERVICE};
+
+static uint8_t batteryLevel = 50;
+static BatteryService* batteryServicePtr;
+
+static EventQueue eventQueue(/* event count */ 16 * EVENTS_EVENT_SIZE);
+
+void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params)
+{
+ BLE::Instance().gap().startAdvertising();
+}
+
+void updateSensorValue() {
+ batteryLevel++;
+ if (batteryLevel > 100) {
+ batteryLevel = 20;
+ }
+
+ batteryServicePtr->updateBatteryLevel(batteryLevel);
+}
+
+void blinkCallback(void)
+{
+ led1 = !led1; /* Do blinky on LED1 while we're waiting for BLE events */
+
+ BLE &ble = BLE::Instance();
+ if (ble.gap().getState().connected) {
+ eventQueue.call(updateSensorValue);
+ }
+}
+
+/**
+ * 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 */
+}
+
+void printMacAddress()
+{
+ /* Print out device MAC address to the console*/
+ Gap::AddressType_t addr_type;
+ Gap::Address_t address;
+ BLE::Instance().gap().getAddress(&addr_type, address);
+ printf("DEVICE MAC ADDRESS: ");
+ for (int i = 5; i >= 1; i--){
+ printf("%02x:", address[i]);
+ }
+ printf("%02x\r\n", address[0]);
+}
+
+/**
+ * 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);
+
+ /* Setup primary service */
+ batteryServicePtr = new BatteryService(ble, batteryLevel);
+
+ /* 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();
+
+ printMacAddress();
+}
+
+void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) {
+ BLE &ble = BLE::Instance();
+ eventQueue.call(Callback<void()>(&ble, &BLE::processEvents));
+}
+
+int main()
+{
+ eventQueue.call_every(500, blinkCallback);
+
+ BLE &ble = BLE::Instance();
+ ble.onEventsToProcess(scheduleBleEventsProcessing);
+ ble.init(bleInitComplete);
+
+ eventQueue.dispatch_forever();
+
+ return 0;
+}

BLE_BatteryLevel/mbed_app.json

@@ -11,6 +11,16 @@
  "DISCO_L475VG_IOT01A": {
  "target.features_add": ["BLE"],
  "target.extra_labels_add": ["CORDIO", "CORDIO_BLUENRG"]
+ },
+ "NRF52840_DK": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["CORDIO", "CORDIO_LL", "SOFTDEVICE_NONE", "NORDIC_CORDIO"],
+ "target.extra_labels_remove": ["SOFTDEVICE_COMMON", "SOFTDEVICE_S140_FULL", "NORDIC_SOFTDEVICE"]
+ },
+ "NRF52_DK": {
+ "target.features_add": ["BLE"],
+ "target.extra_labels_add": ["CORDIO", "CORDIO_LL", "SOFTDEVICE_NONE", "NORDIC_CORDIO"],
+ "target.extra_labels_remove": ["SOFTDEVICE_COMMON", "SOFTDEVICE_S132_FULL", "NORDIC_SOFTDEVICE"]
  }
  }
 }

BLE_BatteryLevel/shields/TARGET_CORDIO_BLUENRG.lib

@@ -1 +1 @@
-https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#51f60dfea514e35e5aa13c8e24005ecadc24a9f5
+https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#d0a0b2790533b1622541bccf96335aac7f0551a2