High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Overview

The BLE_API is a high level abstraction for using Bluetooth Low Energy on multiple platforms. For details and examples using the BLE_API please see the BLE_API Summary Page. Or click on the API Documentation tab above.

Supported Services

Supported services can be found in the BLE_API/services folder.

Files at this revision

API Documentation at this revision

Comitter:
vcoubard
Date:
Mon Jan 11 08:51:57 2016 +0000
Parent:
1107:93b0b9304c53
Child:
1109:09e9c8c2a5bb
Commit message:
Synchronized with git rev ec7df38a
Author: Liyou Zhou
Add deprecated message to Gap::connect overload function

Changed in this revision

ble/Gap.h Show annotated file Show diff for this revision Revisions of this file
ble/deprecate.h Show annotated file Show diff for this revision Revisions of this file
module.json Show annotated file Show diff for this revision Revisions of this file
--- a/ble/Gap.h	Mon Jan 11 08:51:57 2016 +0000
+++ b/ble/Gap.h	Mon Jan 11 08:51:57 2016 +0000
@@ -24,6 +24,7 @@
 #include "GapEvents.h"
 #include "CallChainOfFunctionPointersWithContext.h"
 #include "FunctionPointerWithContext.h"
+#include "deprecate.h"
 
 /* Forward declarations for classes that will only be used for pointers or references in the following. */
 class GapAdvertisingParams;
@@ -51,13 +52,13 @@
 
     /**
      * Address-type for BLEProtocol addresses.
-     * @note: deprecated. Use BLEProtocol::AddressType_t instead.
+     * \deprecated: Use BLEProtocol::AddressType_t instead.
      *
      * DEPRECATION ALERT: The following constants have been left in their
      * deprecated state to transparenly support existing applications which may
      * have used Gap::ADDR_TYPE_*.
      */
-    enum AddressTypeOverload_t {
+    enum DeprecatedAddressType_t {
         ADDR_TYPE_PUBLIC                        = BLEProtocol::AddressType::PUBLIC,
         ADDR_TYPE_RANDOM_STATIC                 = BLEProtocol::AddressType::RANDOM_STATIC,
         ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE     = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE,
@@ -285,9 +286,10 @@
      *      to maintain backward compatibility for change from Gap::AddressType_t to BLEProtocol::AddressType_t
      */
     ble_error_t connect(const BLEProtocol::Address_t  peerAddr,
-                        AddressTypeOverload_t         peerAddrType,
+                        DeprecatedAddressType_t       peerAddrType,
                         const ConnectionParams_t     *connectionParams,
-                        const GapScanningParams      *scanParams) {
+                        const GapScanningParams      *scanParams)
+    __deprecated_message("Gap::DeprecatedAddressType_t is deprecated, use BLEProtocol::AddressType_t instead") {
         return connect(peerAddr, (BLEProtocol::AddressType_t) peerAddrType, connectionParams, scanParams);
     }
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ble/deprecate.h	Mon Jan 11 08:51:57 2016 +0000
@@ -0,0 +1,26 @@
+/* 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 __DEPRECATE_H__
+#define __DEPRECATE_H__
+
+#ifdef YOTTA_CFG_MBED_OS
+	#include "compiler-polyfill/attributes.h"
+#else
+	#define __deprecated_message
+#endif
+
+#endif
\ No newline at end of file
--- a/module.json	Mon Jan 11 08:51:57 2016 +0000
+++ b/module.json	Mon Jan 11 08:51:57 2016 +0000
@@ -35,7 +35,8 @@
       "mbed-classic": "~0.0.1"
     },
     "mbed-os": {
-      "mbed-drivers": "*"
+      "mbed-drivers": "*",
+      "compilerpolyfill": "^1.2.1"
     }
   }
 }
\ No newline at end of file