xiao sun / BLE_API

fork BLE_API to add update adv payload API

Fork of BLE_API by Bluetooth Low Energy

services/LinkLossService.h@714:a6130aaa0fd9, 2015-07-02 (annotated)

Committer:
rgrover1
Date:
Thu Jul 02 09:06:11 2015 +0100
Revision:
714:a6130aaa0fd9
Synchronized with git rev 7e8977d8

Author: Rohit Grover

Release 0.3.8

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



This is a minor set of enhancements before we yotta-ize BLE_API.



Enhancements

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



* Minor rework for class UUID; added a default and copy constructor; and a != operator.



* Added copy constructor and accessors for GapAdvertisingParams.



* GapScanningParams:: remove unnecessary checks for SCAN_TIMEOUT_MAX.



* Add a comment header block to explain why BLEDevice::init() may not be safe

  to call from global static context.



* Introduce GattAttribute::INVALID_HANDLE.



* Replace some deprecated uses of Gap::address_t with Gap::Address_t.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 714:a6130aaa0fd9 1 /* mbed Microcontroller Library
rgrover1 714:a6130aaa0fd9 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 714:a6130aaa0fd9 3 *
rgrover1 714:a6130aaa0fd9 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 714:a6130aaa0fd9 5 * you may not use this file except in compliance with the License.
rgrover1 714:a6130aaa0fd9 6 * You may obtain a copy of the License at
rgrover1 714:a6130aaa0fd9 7 *
rgrover1 714:a6130aaa0fd9 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 714:a6130aaa0fd9 9 *
rgrover1 714:a6130aaa0fd9 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 714:a6130aaa0fd9 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 714:a6130aaa0fd9 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 714:a6130aaa0fd9 13 * See the License for the specific language governing permissions and
rgrover1 714:a6130aaa0fd9 14 * limitations under the License.
rgrover1 714:a6130aaa0fd9 15 */
rgrover1 714:a6130aaa0fd9 16
rgrover1 714:a6130aaa0fd9 17 #ifndef __BLE_LINK_LOSS_SERVICE_H__
rgrover1 714:a6130aaa0fd9 18 #define __BLE_LINK_LOSS_SERVICE_H__
rgrover1 714:a6130aaa0fd9 19
rgrover1 714:a6130aaa0fd9 20 #include "Gap.h"
rgrover1 714:a6130aaa0fd9 21
rgrover1 714:a6130aaa0fd9 22 /**
rgrover1 714:a6130aaa0fd9 23 * @class LinkLossService
rgrover1 714:a6130aaa0fd9 24 * @brief This service defines behavior when a link is lost between two devices. <br>
rgrover1 714:a6130aaa0fd9 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.link_loss.xml <br>
rgrover1 714:a6130aaa0fd9 26 * Alertness Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.alert_level.xml <br>
rgrover1 714:a6130aaa0fd9 27 */
rgrover1 714:a6130aaa0fd9 28 class LinkLossService {
rgrover1 714:a6130aaa0fd9 29 public:
rgrover1 714:a6130aaa0fd9 30 enum AlertLevel_t {
rgrover1 714:a6130aaa0fd9 31 NO_ALERT = 0,
rgrover1 714:a6130aaa0fd9 32 MILD_ALERT = 1,
rgrover1 714:a6130aaa0fd9 33 HIGH_ALERT = 2
rgrover1 714:a6130aaa0fd9 34 };
rgrover1 714:a6130aaa0fd9 35
rgrover1 714:a6130aaa0fd9 36 typedef void (* callback_t)(AlertLevel_t level);
rgrover1 714:a6130aaa0fd9 37
rgrover1 714:a6130aaa0fd9 38 /**
rgrover1 714:a6130aaa0fd9 39 * @param[ref] ble
rgrover1 714:a6130aaa0fd9 40 * BLEDevice object for the underlying controller.
rgrover1 714:a6130aaa0fd9 41 */
rgrover1 714:a6130aaa0fd9 42 LinkLossService(BLEDevice &bleIn, callback_t callbackIn, AlertLevel_t levelIn = NO_ALERT) :
rgrover1 714:a6130aaa0fd9 43 ble(bleIn),
rgrover1 714:a6130aaa0fd9 44 alertLevel(levelIn),
rgrover1 714:a6130aaa0fd9 45 callback(callbackIn),
rgrover1 714:a6130aaa0fd9 46 alertLevelChar(GattCharacteristic::UUID_ALERT_LEVEL_CHAR, reinterpret_cast<uint8_t *>(&alertLevel)) {
rgrover1 714:a6130aaa0fd9 47 static bool serviceAdded = false; /* We should only ever add one LinkLoss service. */
rgrover1 714:a6130aaa0fd9 48 if (serviceAdded) {
rgrover1 714:a6130aaa0fd9 49 return;
rgrover1 714:a6130aaa0fd9 50 }
rgrover1 714:a6130aaa0fd9 51
rgrover1 714:a6130aaa0fd9 52 GattCharacteristic *charTable[] = {&alertLevelChar};
rgrover1 714:a6130aaa0fd9 53 GattService linkLossService(GattService::UUID_LINK_LOSS_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 714:a6130aaa0fd9 54
rgrover1 714:a6130aaa0fd9 55 ble.addService(linkLossService);
rgrover1 714:a6130aaa0fd9 56 serviceAdded = true;
rgrover1 714:a6130aaa0fd9 57
rgrover1 714:a6130aaa0fd9 58 ble.addToDisconnectionCallChain(this, &LinkLossService::onDisconnectionFilter);
rgrover1 714:a6130aaa0fd9 59 ble.onDataWritten(this, &LinkLossService::onDataWritten);
rgrover1 714:a6130aaa0fd9 60 }
rgrover1 714:a6130aaa0fd9 61
rgrover1 714:a6130aaa0fd9 62 /**
rgrover1 714:a6130aaa0fd9 63 * Update the callback.
rgrover1 714:a6130aaa0fd9 64 */
rgrover1 714:a6130aaa0fd9 65 void setCallback(callback_t newCallback) {
rgrover1 714:a6130aaa0fd9 66 callback = newCallback;
rgrover1 714:a6130aaa0fd9 67 }
rgrover1 714:a6130aaa0fd9 68
rgrover1 714:a6130aaa0fd9 69 /**
rgrover1 714:a6130aaa0fd9 70 * Update Alertness Level.
rgrover1 714:a6130aaa0fd9 71 */
rgrover1 714:a6130aaa0fd9 72 void setAlertLevel(AlertLevel_t newLevel) {
rgrover1 714:a6130aaa0fd9 73 alertLevel = newLevel;
rgrover1 714:a6130aaa0fd9 74 }
rgrover1 714:a6130aaa0fd9 75
rgrover1 714:a6130aaa0fd9 76 private:
rgrover1 714:a6130aaa0fd9 77 /**
rgrover1 714:a6130aaa0fd9 78 * This callback allows receiving updates to the AlertLevel Characteristic.
rgrover1 714:a6130aaa0fd9 79 *
rgrover1 714:a6130aaa0fd9 80 * @param[in] params
rgrover1 714:a6130aaa0fd9 81 * Information about the characterisitc being updated.
rgrover1 714:a6130aaa0fd9 82 */
rgrover1 714:a6130aaa0fd9 83 virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) {
rgrover1 714:a6130aaa0fd9 84 if (params->charHandle == alertLevelChar.getValueHandle()) {
rgrover1 714:a6130aaa0fd9 85 alertLevel = *reinterpret_cast<const AlertLevel_t *>(params->data);
rgrover1 714:a6130aaa0fd9 86 }
rgrover1 714:a6130aaa0fd9 87 }
rgrover1 714:a6130aaa0fd9 88
rgrover1 714:a6130aaa0fd9 89 void onDisconnectionFilter(void) {
rgrover1 714:a6130aaa0fd9 90 if (alertLevel != NO_ALERT) {
rgrover1 714:a6130aaa0fd9 91 callback(alertLevel);
rgrover1 714:a6130aaa0fd9 92 }
rgrover1 714:a6130aaa0fd9 93 }
rgrover1 714:a6130aaa0fd9 94
rgrover1 714:a6130aaa0fd9 95 private:
rgrover1 714:a6130aaa0fd9 96 BLEDevice &ble;
rgrover1 714:a6130aaa0fd9 97 AlertLevel_t alertLevel;
rgrover1 714:a6130aaa0fd9 98 callback_t callback;
rgrover1 714:a6130aaa0fd9 99
rgrover1 714:a6130aaa0fd9 100 ReadWriteGattCharacteristic<uint8_t> alertLevelChar;
rgrover1 714:a6130aaa0fd9 101 };
rgrover1 714:a6130aaa0fd9 102
rgrover1 714:a6130aaa0fd9 103 #endif /* __BLE_LINK_LOSS_SERVICE_H__ */