Microbug / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

hw/BLEDevice.h@35:f3b0c1192cf7, 2014-05-22 (annotated)

Committer:
Rohit Grover
Date:
Thu May 22 12:11:12 2014 +0100
Revision:
35:f3b0c1192cf7
Parent:
34:da2ea8cd6216
Child:
36:9ec94579bb78
enhancing the interface for BLEDevice to absorb GAP API.

This will allow applications to avoid having to call getGAP() or

similar before operating on underlying services.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 29:011e95ce78b8 1 /* mbed Microcontroller Library
ktownsend 29:011e95ce78b8 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 29:011e95ce78b8 3 *
ktownsend 29:011e95ce78b8 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 29:011e95ce78b8 5 * you may not use this file except in compliance with the License.
ktownsend 29:011e95ce78b8 6 * You may obtain a copy of the License at
ktownsend 29:011e95ce78b8 7 *
ktownsend 29:011e95ce78b8 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 29:011e95ce78b8 9 *
ktownsend 29:011e95ce78b8 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 29:011e95ce78b8 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 29:011e95ce78b8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 29:011e95ce78b8 13 * See the License for the specific language governing permissions and
ktownsend 29:011e95ce78b8 14 * limitations under the License.
ktownsend 29:011e95ce78b8 15 */
Rohit Grover 34:da2ea8cd6216 16
ktownsend 29:011e95ce78b8 17 #ifndef __BLE_DEVICE_H__
ktownsend 29:011e95ce78b8 18 #define __BLE_DEVICE_H__
ktownsend 29:011e95ce78b8 19
ktownsend 29:011e95ce78b8 20 #include "mbed.h"
ktownsend 29:011e95ce78b8 21 #include "blecommon.h"
ktownsend 29:011e95ce78b8 22 #include "hw/Gap.h"
ktownsend 29:011e95ce78b8 23 #include "hw/GattServer.h"
ktownsend 29:011e95ce78b8 24
ktownsend 29:011e95ce78b8 25 /**************************************************************************/
ktownsend 29:011e95ce78b8 26 /*!
ktownsend 29:011e95ce78b8 27 \brief
ktownsend 29:011e95ce78b8 28 The base class used to abstract away BLE capable radio transceivers
ktownsend 29:011e95ce78b8 29 or SOCs, to enable this BLE API to work with any radio transparently.
ktownsend 29:011e95ce78b8 30 */
ktownsend 29:011e95ce78b8 31 /**************************************************************************/
ktownsend 29:011e95ce78b8 32 class BLEDevice
ktownsend 29:011e95ce78b8 33 {
Rohit Grover 34:da2ea8cd6216 34 public:
Rohit Grover 35:f3b0c1192cf7 35 virtual ble_error_t init() = 0;
Rohit Grover 35:f3b0c1192cf7 36 virtual ble_error_t reset(void) = 0;
Rohit Grover 35:f3b0c1192cf7 37
Rohit Grover 35:f3b0c1192cf7 38 /* GAP specific APIs */
Rohit Grover 35:f3b0c1192cf7 39 public:
Rohit Grover 35:f3b0c1192cf7 40 ble_error_t setAddress(Gap::addr_type_t type, uint8_t address[6]) {
Rohit Grover 35:f3b0c1192cf7 41 return getGap().setAddress(type, address);
Rohit Grover 35:f3b0c1192cf7 42 }
Rohit Grover 35:f3b0c1192cf7 43
Rohit Grover 35:f3b0c1192cf7 44 ble_error_t setAdvertisingData(GapAdvertisingData &ADStructures,
Rohit Grover 35:f3b0c1192cf7 45 GapAdvertisingData &scanResponse) {
Rohit Grover 35:f3b0c1192cf7 46 return getGap().setAdvertisingData(ADStructures, scanResponse);
Rohit Grover 35:f3b0c1192cf7 47 }
Rohit Grover 35:f3b0c1192cf7 48
Rohit Grover 35:f3b0c1192cf7 49 ble_error_t setAdvertisingData(GapAdvertisingData &ADStructures) {
Rohit Grover 35:f3b0c1192cf7 50 GapAdvertisingData scanResponse;
Rohit Grover 35:f3b0c1192cf7 51 return getGap().setAdvertisingData(ADStructures, scanResponse);
Rohit Grover 35:f3b0c1192cf7 52 }
Rohit Grover 35:f3b0c1192cf7 53
Rohit Grover 35:f3b0c1192cf7 54 ble_error_t startAdvertising(GapAdvertisingParams &advParams) {
Rohit Grover 35:f3b0c1192cf7 55 return getGap().startAdvertising(advParams);
Rohit Grover 35:f3b0c1192cf7 56 }
Rohit Grover 35:f3b0c1192cf7 57
Rohit Grover 35:f3b0c1192cf7 58 ble_error_t stopAdvertising(void) {
Rohit Grover 35:f3b0c1192cf7 59 return getGap().stopAdvertising();
Rohit Grover 35:f3b0c1192cf7 60 }
Rohit Grover 35:f3b0c1192cf7 61
Rohit Grover 35:f3b0c1192cf7 62 ble_error_t disconnect(void) {
Rohit Grover 35:f3b0c1192cf7 63 return getGap().disconnect();
Rohit Grover 35:f3b0c1192cf7 64 }
Rohit Grover 35:f3b0c1192cf7 65
Rohit Grover 35:f3b0c1192cf7 66 public: /* TODO: to be made private soon */
Rohit Grover 34:da2ea8cd6216 67 virtual Gap& getGap() = 0;
Rohit Grover 34:da2ea8cd6216 68 virtual GattServer& getGattServer() = 0;
ktownsend 29:011e95ce78b8 69 };
ktownsend 29:011e95ce78b8 70
Rohit Grover 34:da2ea8cd6216 71 #endif // ifndef __BLE_DEVICE_H__