Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

ble/services/iBeaconService.h@716:11b41f651697, 2015-07-02 (annotated)

Committer:
rgrover1
Date:
Thu Jul 02 09:06:11 2015 +0100
Revision:
716:11b41f651697
Parent:
712:b04b5db36865
Child:
723:71507679c9b2
Synchronized with git rev d80fec88

Author: Rohit Grover

Release 0.4.0

=============



This is a major release which introduces the GATT Client functionality. It

also aligns BLE_API with builds using our new package manager: yotta

(https://github.com/armmbed/yotta).



Many APIs have seen some redesign. We encourage our users to pay attention to

the changes and migrate appropriately over time. We've also taken care to

ensure that existing code continues to work the same way. There's more

documentation in the form of comment headers for APIs to explain proper usage;

in many cases comment headers suggest alternative use of APIs.



Enhancements

~~~~~~~~~~~~



* Introduce GattClient. This includes functionality for service-discovery,

  connections, and attribute-reads and writes. You'll find a demo program for

  LEDBlinker on the mbed.org Bluetooth team page to use the new APIs. Some of

  the GATT client functionality hasn't been implemented yet, but the APIs have

  been added.



* Most APIs in the abstract base classes like Gap and GattServer return

  BLE_ERROR_NOT_IMPLEMENTED. Previously many APIs were pure-virtual, which did

  not permit partial ports to compile.



* We've added a new abstract base class for SecurityManager. All security

  related APIs have been moved into that.



* BLEDevice has been renamed as BLE. A deprecated alias for BLEDevice is

  available to support existing code.



* There has been a major cleanup of APIs under BLE. APIs have now been

  categorized as belonging to Gap, GattServer, GattClient, or SecurityManager.

  There are accessors to get references for Gap, GattServer, GattClient, and

  SecurityManager. A former call to ble.setAddress(...) is now expected to be

  achieved with ble.gap().setAddress(...).



* We've cleaned up our APIs, and this has resulted in dropping some APIs like

  BLE::reset().



* We've also dropped GattServer::initializeGattDatabase(). THis was added at

  some point to support controllers where a commit point was needed to

  indicate when the application had finished constructing the GATT database.

  This API would get called internally before Gap::startAdvertising(). We now

  expect the underlying port to do the equivalent of initializeGattDatabase()

  implicitly upon Gap::startAdvertising().



* The callback for BLE.onTimeout() now receives a TimeoutSource_t to indicate

  the cause of the timeout. This is perhaps the only breaking API change. We

  expect it to have very little disruptive effect.



* We've added a version of Gap::disconnect() which takes a connection handle.

  The previous API (which did not take a connection handle) has been

  deprecated; it will still work for situations where there's only a single

  active connection. We hold on to that API to allow existing code to migrate

  to the new API.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 712:b04b5db36865 1 /* mbed Microcontroller Library
rgrover1 712:b04b5db36865 2 * Copyright (c) 2006-2015 ARM Limited
rgrover1 712:b04b5db36865 3 *
rgrover1 712:b04b5db36865 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 712:b04b5db36865 5 * you may not use this file except in compliance with the License.
rgrover1 712:b04b5db36865 6 * You may obtain a copy of the License at
rgrover1 712:b04b5db36865 7 *
rgrover1 712:b04b5db36865 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 712:b04b5db36865 9 *
rgrover1 712:b04b5db36865 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 712:b04b5db36865 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 712:b04b5db36865 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 712:b04b5db36865 13 * See the License for the specific language governing permissions and
rgrover1 712:b04b5db36865 14 * limitations under the License.
rgrover1 712:b04b5db36865 15 */
rgrover1 712:b04b5db36865 16 #ifndef __BLE_IBEACON_SERVICE_H__
rgrover1 712:b04b5db36865 17 #define __BLE_IBEACON_SERVICE_H__
rgrover1 712:b04b5db36865 18
rgrover1 712:b04b5db36865 19 #include "core_cmInstr.h"
rgrover1 712:b04b5db36865 20 #include "BLE.h"
rgrover1 712:b04b5db36865 21
rgrover1 712:b04b5db36865 22 /**
rgrover1 712:b04b5db36865 23 * @class iBeaconService
rgrover1 712:b04b5db36865 24 * @brief iBeacon Service. This service sets up a device to broadcast advertising packets to mimic an iBeacon<br>
rgrover1 712:b04b5db36865 25 */
rgrover1 712:b04b5db36865 26
rgrover1 712:b04b5db36865 27 class iBeaconService
rgrover1 712:b04b5db36865 28 {
rgrover1 712:b04b5db36865 29 public:
rgrover1 712:b04b5db36865 30 typedef const uint8_t LocationUUID_t[16];
rgrover1 712:b04b5db36865 31
rgrover1 712:b04b5db36865 32 union Payload {
rgrover1 712:b04b5db36865 33 uint8_t raw[25];
rgrover1 712:b04b5db36865 34 struct {
rgrover1 712:b04b5db36865 35 uint16_t companyID;
rgrover1 712:b04b5db36865 36 uint8_t ID;
rgrover1 712:b04b5db36865 37 uint8_t len;
rgrover1 712:b04b5db36865 38 uint8_t proximityUUID[16];
rgrover1 712:b04b5db36865 39 uint16_t majorNumber;
rgrover1 712:b04b5db36865 40 uint16_t minorNumber;
rgrover1 712:b04b5db36865 41 uint8_t txPower;
rgrover1 712:b04b5db36865 42 };
rgrover1 712:b04b5db36865 43
rgrover1 712:b04b5db36865 44 Payload(LocationUUID_t uuid, uint16_t majNum, uint16_t minNum, uint8_t transmitPower, uint16_t companyIDIn) :
rgrover1 712:b04b5db36865 45 companyID(companyIDIn), ID(0x02), len(0x15), majorNumber(__REV16(majNum)), minorNumber(__REV16(minNum)), txPower(transmitPower)
rgrover1 712:b04b5db36865 46 {
rgrover1 712:b04b5db36865 47 memcpy(proximityUUID, uuid, sizeof(LocationUUID_t));
rgrover1 712:b04b5db36865 48 }
rgrover1 712:b04b5db36865 49 };
rgrover1 712:b04b5db36865 50
rgrover1 712:b04b5db36865 51 public:
rgrover1 712:b04b5db36865 52 iBeaconService(BLE &_ble,
rgrover1 712:b04b5db36865 53 LocationUUID_t uuid,
rgrover1 712:b04b5db36865 54 uint16_t majNum,
rgrover1 712:b04b5db36865 55 uint16_t minNum,
rgrover1 712:b04b5db36865 56 uint8_t txP = 0xC8,
rgrover1 712:b04b5db36865 57 uint16_t compID = 0x004C) :
rgrover1 712:b04b5db36865 58 ble(_ble), data(uuid, majNum, minNum, txP, compID)
rgrover1 712:b04b5db36865 59 {
rgrover1 712:b04b5db36865 60 // Generate the 0x020106 part of the iBeacon Prefix
rgrover1 712:b04b5db36865 61 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE );
rgrover1 712:b04b5db36865 62 // Generate the 0x1AFF part of the iBeacon Prefix
rgrover1 712:b04b5db36865 63 ble.accumulateAdvertisingPayload(GapAdvertisingData::MANUFACTURER_SPECIFIC_DATA, data.raw, sizeof(data.raw));
rgrover1 712:b04b5db36865 64
rgrover1 712:b04b5db36865 65 // Set advertising type
rgrover1 712:b04b5db36865 66 ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
rgrover1 712:b04b5db36865 67 }
rgrover1 712:b04b5db36865 68
rgrover1 712:b04b5db36865 69 private:
rgrover1 712:b04b5db36865 70 BLE &ble;
rgrover1 712:b04b5db36865 71 Payload data;
rgrover1 712:b04b5db36865 72 };
rgrover1 712:b04b5db36865 73
rgrover1 712:b04b5db36865 74 #endif //__BLE_IBEACON_SERVICE_H__