Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/Hsp_BLE/BluetoothLE/BluetoothLE.h@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darienf 20:6d2af70c92ab 1 /*******************************************************************************
darienf 20:6d2af70c92ab 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
darienf 20:6d2af70c92ab 3 *
darienf 20:6d2af70c92ab 4 * Permission is hereby granted, free of charge, to any person obtaining a
darienf 20:6d2af70c92ab 5 * copy of this software and associated documentation files (the "Software"),
darienf 20:6d2af70c92ab 6 * to deal in the Software without restriction, including without limitation
darienf 20:6d2af70c92ab 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
darienf 20:6d2af70c92ab 8 * and/or sell copies of the Software, and to permit persons to whom the
darienf 20:6d2af70c92ab 9 * Software is furnished to do so, subject to the following conditions:
darienf 20:6d2af70c92ab 10 *
darienf 20:6d2af70c92ab 11 * The above copyright notice and this permission notice shall be included
darienf 20:6d2af70c92ab 12 * in all copies or substantial portions of the Software.
darienf 20:6d2af70c92ab 13 *
darienf 20:6d2af70c92ab 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
darienf 20:6d2af70c92ab 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
darienf 20:6d2af70c92ab 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
darienf 20:6d2af70c92ab 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
darienf 20:6d2af70c92ab 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
darienf 20:6d2af70c92ab 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
darienf 20:6d2af70c92ab 20 * OTHER DEALINGS IN THE SOFTWARE.
darienf 20:6d2af70c92ab 21 *
darienf 20:6d2af70c92ab 22 * Except as contained in this notice, the name of Maxim Integrated
darienf 20:6d2af70c92ab 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
darienf 20:6d2af70c92ab 24 * Products, Inc. Branding Policy.
darienf 20:6d2af70c92ab 25 *
darienf 20:6d2af70c92ab 26 * The mere transfer of this software does not imply any licenses
darienf 20:6d2af70c92ab 27 * of trade secrets, proprietary technology, copyrights, patents,
darienf 20:6d2af70c92ab 28 * trademarks, maskwork rights, or any other form of intellectual
darienf 20:6d2af70c92ab 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
darienf 20:6d2af70c92ab 30 * ownership rights.
darienf 20:6d2af70c92ab 31 *******************************************************************************
darienf 20:6d2af70c92ab 32 */
darienf 20:6d2af70c92ab 33 #ifndef _BLUETOOTHLE_H_
darienf 20:6d2af70c92ab 34 #define _BLUETOOTHLE_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37 #include "BLE.h"
darienf 20:6d2af70c92ab 38 #include "Characteristic.h"
darienf 20:6d2af70c92ab 39
darienf 20:6d2af70c92ab 40 class BluetoothLE {
darienf 20:6d2af70c92ab 41 public:
darienf 20:6d2af70c92ab 42 BluetoothLE(BLE *ble, int numberOfCharacteristics);
darienf 20:6d2af70c92ab 43 ~BluetoothLE(void);
darienf 20:6d2af70c92ab 44 void addCharacteristic(Characteristic *characteristic);
darienf 20:6d2af70c92ab 45 void initService(uint8_t *serialNumber, uint8_t *deviceName, int nameSize, uint8_t *serviceUUID);
darienf 20:6d2af70c92ab 46 void notifyCharacteristic(int index, uint8_t *data);
darienf 20:6d2af70c92ab 47
darienf 20:6d2af70c92ab 48
darienf 20:6d2af70c92ab 49 /**
darienf 20:6d2af70c92ab 50 * @brief Return a characteristic based on incoming index
darienf 20:6d2af70c92ab 51 * @param index index into an array of characteristics
darienf 20:6d2af70c92ab 52 */
darienf 20:6d2af70c92ab 53 Characteristic *getCharacteristic(int index) {
darienf 20:6d2af70c92ab 54 return characteristics[index];
darienf 20:6d2af70c92ab 55 }
darienf 20:6d2af70c92ab 56
darienf 20:6d2af70c92ab 57 /**
darienf 20:6d2af70c92ab 58 * @brief Get the payload for this characteristic
darienf 20:6d2af70c92ab 59 */
darienf 20:6d2af70c92ab 60 uint8_t *getCharacteristicPayload(int index) {
darienf 20:6d2af70c92ab 61 return characteristics[index]->getPayloadPtr();
darienf 20:6d2af70c92ab 62 }
darienf 20:6d2af70c92ab 63 typedef void (*PtrFunction)(int index);
darienf 20:6d2af70c92ab 64
darienf 20:6d2af70c92ab 65 /**
darienf 20:6d2af70c92ab 66 * @brief Used to connect a connection callback
darienf 20:6d2af70c92ab 67 */
darienf 20:6d2af70c92ab 68 template<typename T>
darienf 20:6d2af70c92ab 69 void onConnect(T *object, void (T::*member)(void)) {
darienf 20:6d2af70c92ab 70 _onConnect.attach( object, member );
darienf 20:6d2af70c92ab 71 }
darienf 20:6d2af70c92ab 72 /**
darienf 20:6d2af70c92ab 73 * @brief Used to connect a disconnection callback
darienf 20:6d2af70c92ab 74 */
darienf 20:6d2af70c92ab 75 template<typename T>
darienf 20:6d2af70c92ab 76 void onDisconnect(T *object, void (T::*member)(void)) {
darienf 20:6d2af70c92ab 77 _onDisconnect.attach( object, member );
darienf 20:6d2af70c92ab 78 }
darienf 20:6d2af70c92ab 79 /**
darienf 20:6d2af70c92ab 80 * @brief Used to connect a characteristic written callback
darienf 20:6d2af70c92ab 81 */
darienf 20:6d2af70c92ab 82 void onDataWritten(PtrFunction _onDataWritten) {
darienf 20:6d2af70c92ab 83 this->_onDataWritten = _onDataWritten;
darienf 20:6d2af70c92ab 84 }
darienf 20:6d2af70c92ab 85 /**
darienf 20:6d2af70c92ab 86 * @brief Get the connection state of the BLE
darienf 20:6d2af70c92ab 87 * @return true if connection BLE connection is present, false if no connection
darienf 20:6d2af70c92ab 88 */
darienf 20:6d2af70c92ab 89 bool isConnected(void);
darienf 20:6d2af70c92ab 90
darienf 20:6d2af70c92ab 91 /**
darienf 20:6d2af70c92ab 92 * @brief Perform a notification test
darienf 20:6d2af70c92ab 93 * @param index Index into an array of characteristic objects
darienf 20:6d2af70c92ab 94 */
darienf 20:6d2af70c92ab 95 void notifyCharacteristicTest(int index);
darienf 20:6d2af70c92ab 96
darienf 20:6d2af70c92ab 97 /**
darienf 20:6d2af70c92ab 98 * @brief Get the data that was written to the indexed characteristic
darienf 20:6d2af70c92ab 99 * @return true if connection BLE connection is present, false if no connection
darienf 20:6d2af70c92ab 100 */
darienf 20:6d2af70c92ab 101 uint8_t *getDataWritten(int index, int *length);
darienf 20:6d2af70c92ab 102
darienf 20:6d2af70c92ab 103 private:
darienf 20:6d2af70c92ab 104 /**
darienf 20:6d2af70c92ab 105 * @brief Disconnection callback
darienf 20:6d2af70c92ab 106 */
darienf 20:6d2af70c92ab 107 void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params);
darienf 20:6d2af70c92ab 108 /**
darienf 20:6d2af70c92ab 109 * @brief Connection callback
darienf 20:6d2af70c92ab 110 */
darienf 20:6d2af70c92ab 111 void connectionCallback(const Gap::ConnectionCallbackParams_t *params);
darienf 20:6d2af70c92ab 112 /**
darienf 20:6d2af70c92ab 113 * @brief Characteristic written callback
darienf 20:6d2af70c92ab 114 */
darienf 20:6d2af70c92ab 115 void onDataWritten(const GattWriteCallbackParams *params);
darienf 20:6d2af70c92ab 116
darienf 20:6d2af70c92ab 117 /// array of characteristic class pointers
darienf 20:6d2af70c92ab 118 Characteristic **characteristics;
darienf 20:6d2af70c92ab 119 /// array of gatt characteristic pointers
darienf 20:6d2af70c92ab 120 GattCharacteristic **gattCharacteristics;
darienf 20:6d2af70c92ab 121 /// pointer to mbed BLE layer
darienf 20:6d2af70c92ab 122 BLE *ble;
darienf 20:6d2af70c92ab 123 /// total number of characteristics
darienf 20:6d2af70c92ab 124 int numberOfCharacteristics;
darienf 20:6d2af70c92ab 125 /// flag to keep track of BLE connection state
darienf 20:6d2af70c92ab 126 bool _isConnected;
darienf 20:6d2af70c92ab 127 /// running index for building characteristic array
darienf 20:6d2af70c92ab 128 int runningIndex;
darienf 20:6d2af70c92ab 129 /// callback function for when a connection is made
darienf 20:6d2af70c92ab 130 FunctionPointer _onConnect;
darienf 20:6d2af70c92ab 131 /// callback function for when a connection is disconnected
darienf 20:6d2af70c92ab 132 FunctionPointer _onDisconnect;
darienf 20:6d2af70c92ab 133 /// callback function for when characteristic data is written
darienf 20:6d2af70c92ab 134 PtrFunction _onDataWritten;
darienf 20:6d2af70c92ab 135 };
darienf 20:6d2af70c92ab 136
darienf 20:6d2af70c92ab 137 #endif // _BLUETOOTHLE_H_