Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/Hsp_BLE/BluetoothLE/Characteristic.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 _CHARACTERISTIC_H_
darienf 20:6d2af70c92ab 34 #define _CHARACTERISTIC_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37 #include "BLE.h"
darienf 20:6d2af70c92ab 38 #include "GattCharacteristic.h"
darienf 20:6d2af70c92ab 39
darienf 20:6d2af70c92ab 40 class Characteristic {
darienf 20:6d2af70c92ab 41 public:
darienf 20:6d2af70c92ab 42 /**
darienf 20:6d2af70c92ab 43 * @brief ticker handler static method
darienf 20:6d2af70c92ab 44 */
darienf 20:6d2af70c92ab 45 Characteristic(uint16_t length, const UUID &uuid,
darienf 20:6d2af70c92ab 46 uint8_t additionalProperties =
darienf 20:6d2af70c92ab 47 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NONE,
darienf 20:6d2af70c92ab 48 GattAttribute *descriptors[] = NULL,
darienf 20:6d2af70c92ab 49 unsigned numDescriptors = 0);
darienf 20:6d2af70c92ab 50
darienf 20:6d2af70c92ab 51 void setIndex(int index) { this->index = index; }
darienf 20:6d2af70c92ab 52 /**
darienf 20:6d2af70c92ab 53 * @brief Set a pointer reference to the mbed BLE framework
darienf 20:6d2af70c92ab 54 */
darienf 20:6d2af70c92ab 55 void setBLE(BLE *ble) { this->ble = ble; }
darienf 20:6d2af70c92ab 56 /**
darienf 20:6d2af70c92ab 57 * @brief Get the pointer to the byte payload
darienf 20:6d2af70c92ab 58 */
darienf 20:6d2af70c92ab 59 uint8_t *getPayloadPtr(void) { return payload.getPointer(); }
darienf 20:6d2af70c92ab 60 /**
darienf 20:6d2af70c92ab 61 * @brief Get the handle of the characteristic
darienf 20:6d2af70c92ab 62 */
darienf 20:6d2af70c92ab 63 GattAttribute::Handle_t getValueHandle();
darienf 20:6d2af70c92ab 64 /**
darienf 20:6d2af70c92ab 65 * @brief Update the characteristic
darienf 20:6d2af70c92ab 66 */
darienf 20:6d2af70c92ab 67 void update(void);
darienf 20:6d2af70c92ab 68 /**
darienf 20:6d2af70c92ab 69 * @brief Get the GattCharacteristic
darienf 20:6d2af70c92ab 70 */
darienf 20:6d2af70c92ab 71 GattCharacteristic *getGattCharacteristic();
darienf 20:6d2af70c92ab 72 /**
darienf 20:6d2af70c92ab 73 * @brief Get the length of the payload
darienf 20:6d2af70c92ab 74 */
darienf 20:6d2af70c92ab 75 int getPayloadLength(void);
darienf 20:6d2af70c92ab 76
darienf 20:6d2af70c92ab 77 uint8_t *getPayloadBytes(void) { return payload.bytes; }
darienf 20:6d2af70c92ab 78
darienf 20:6d2af70c92ab 79 void copyDataWritten(const GattWriteCallbackParams *params) {
darienf 20:6d2af70c92ab 80 int i = 0;
darienf 20:6d2af70c92ab 81 while (i < params->len && i < sizeof(dataWritten)) {
darienf 20:6d2af70c92ab 82 dataWritten[i] = params->data[i];
darienf 20:6d2af70c92ab 83 i++;
darienf 20:6d2af70c92ab 84 }
darienf 20:6d2af70c92ab 85 dataWrittenLength = params->len;
darienf 20:6d2af70c92ab 86 }
darienf 20:6d2af70c92ab 87
darienf 20:6d2af70c92ab 88 uint8_t *getDataWritten(int *length) {
darienf 20:6d2af70c92ab 89 *length = dataWrittenLength;
darienf 20:6d2af70c92ab 90 return dataWritten;
darienf 20:6d2af70c92ab 91 }
darienf 20:6d2af70c92ab 92
darienf 20:6d2af70c92ab 93 private:
darienf 20:6d2af70c92ab 94 int payloadLength;
darienf 20:6d2af70c92ab 95 struct PayloadStruct {
darienf 20:6d2af70c92ab 96 uint8_t bytes[32];
darienf 20:6d2af70c92ab 97 uint8_t *getPointer(void) { return bytes; }
darienf 20:6d2af70c92ab 98 };
darienf 20:6d2af70c92ab 99 /// local copy of data written to this characteristic
darienf 20:6d2af70c92ab 100 uint8_t dataWritten[64];
darienf 20:6d2af70c92ab 101 int dataWrittenLength;
darienf 20:6d2af70c92ab 102 /// payload structure for this characteristic
darienf 20:6d2af70c92ab 103 PayloadStruct payload;
darienf 20:6d2af70c92ab 104 /// gatt characteristic
darienf 20:6d2af70c92ab 105 GattCharacteristic gattCharacteristic;
darienf 20:6d2af70c92ab 106 /// mbed BLE framework pointer
darienf 20:6d2af70c92ab 107 BLE *ble;
darienf 20:6d2af70c92ab 108 /// index of this characteristic
darienf 20:6d2af70c92ab 109 int index;
darienf 20:6d2af70c92ab 110 };
darienf 20:6d2af70c92ab 111
darienf 20:6d2af70c92ab 112 #endif /* _CHARACTERISTIC_H_ */