Maxim Integrated / Mbed OS HSP_RPC_GUI

MAX32620HSP (MAXREFDES100) RPC Example for Graphical User Interface

Dependencies:   USBDevice

Fork of HSP_Release by Jerry Bradshaw

This is an example program for the MAX32620HSP (MAXREFDES100 Health Sensor Platform). It demonstrates all the features of the platform and works with a companion graphical user interface (GUI) to help evaluate/configure/monitor the board. Go to the MAXREFDES100 product page and click on "design resources" to download the companion software. The GUI connects to the board through an RPC interface on a virtual serial port over the USB interface.

The RPC interface provides access to all the features of the board and is available to interface with other development environments such Matlab. This firmware provides realtime data streaming through the RPC interface over USB, and also provides the ability to log the data to flash for untethered battery operation. The data logging settings are configured through the GUI, and the GUI also provides the interface to download logged data.

Details on the RPC interface can be found here: HSP RPC Interface Documentation

Windows

With this program loaded, the MAX32620HSP will appear on your computer as a serial port. On Mac and Linux, this will happen by default. For Windows, you need to install a driver: HSP serial port windows driver

For more details about this platform and how to use it, see the MAXREFDES100 product page.

HSP/Hsp_BLE/BluetoothLE/BluetoothLE.cpp@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
Child:
1:9490836294ea
tewt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33 #include "BluetoothLE.h"
jbradshaw 0:e4a10ed6eb92 34 #include "Characteristic.h"
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 /**
jbradshaw 0:e4a10ed6eb92 37 * @brief Constructor for class
jbradshaw 0:e4a10ed6eb92 38 */
jbradshaw 0:e4a10ed6eb92 39 BluetoothLE::BluetoothLE(BLE *ble, int numberOfCharacteristics)
jbradshaw 0:e4a10ed6eb92 40 : ble(ble), runningIndex(0),
jbradshaw 0:e4a10ed6eb92 41 numberOfCharacteristics(numberOfCharacteristics) {
jbradshaw 0:e4a10ed6eb92 42 characteristics = new Characteristic *[numberOfCharacteristics];
jbradshaw 0:e4a10ed6eb92 43 gattCharacteristics = new GattCharacteristic *[numberOfCharacteristics];
jbradshaw 0:e4a10ed6eb92 44 }
jbradshaw 0:e4a10ed6eb92 45
jbradshaw 0:e4a10ed6eb92 46 /**
jbradshaw 0:e4a10ed6eb92 47 * @brief Destructor for class
jbradshaw 0:e4a10ed6eb92 48 */
jbradshaw 0:e4a10ed6eb92 49 BluetoothLE::~BluetoothLE(void) {
jbradshaw 0:e4a10ed6eb92 50 for (int i = 0; i < numberOfCharacteristics; i++) delete characteristics[i];
jbradshaw 0:e4a10ed6eb92 51 delete[] gattCharacteristics;
jbradshaw 0:e4a10ed6eb92 52 delete[] characteristics;
jbradshaw 0:e4a10ed6eb92 53 }
jbradshaw 0:e4a10ed6eb92 54
jbradshaw 0:e4a10ed6eb92 55 /**
jbradshaw 0:e4a10ed6eb92 56 * @brief Initialize the advertising, characteristics, service for this platform
jbradshaw 0:e4a10ed6eb92 57 */
jbradshaw 0:e4a10ed6eb92 58 void BluetoothLE::addCharacteristic(Characteristic *characteristic) {
jbradshaw 0:e4a10ed6eb92 59 characteristic->setBLE(ble);
jbradshaw 0:e4a10ed6eb92 60 characteristic->setIndex(runningIndex);
jbradshaw 0:e4a10ed6eb92 61 characteristics[runningIndex] = characteristic;
jbradshaw 0:e4a10ed6eb92 62 gattCharacteristics[runningIndex] = characteristic->getGattCharacteristic();
jbradshaw 0:e4a10ed6eb92 63 runningIndex++;
jbradshaw 0:e4a10ed6eb92 64 }
jbradshaw 0:e4a10ed6eb92 65
jbradshaw 0:e4a10ed6eb92 66 /**
jbradshaw 0:e4a10ed6eb92 67 * @brief Initialize the advertising, characteristics, service for this platform
jbradshaw 0:e4a10ed6eb92 68 */
jbradshaw 0:e4a10ed6eb92 69 void BluetoothLE::initService(uint8_t *serialNumber, uint8_t *deviceName,
jbradshaw 0:e4a10ed6eb92 70 int nameSize, uint8_t *serviceUUID) {
jbradshaw 0:e4a10ed6eb92 71 ble->init();
jbradshaw 0:e4a10ed6eb92 72 ble->onDisconnection(this, &BluetoothLE::disconnectionCallback);
jbradshaw 0:e4a10ed6eb92 73
jbradshaw 0:e4a10ed6eb92 74 ble->gap().setAddress((BLEProtocol::AddressType_t)0, serialNumber);
jbradshaw 0:e4a10ed6eb92 75
jbradshaw 0:e4a10ed6eb92 76 // Setup Advertising
jbradshaw 0:e4a10ed6eb92 77 ble->accumulateAdvertisingPayload(
jbradshaw 0:e4a10ed6eb92 78 GapAdvertisingData::BREDR_NOT_SUPPORTED |
jbradshaw 0:e4a10ed6eb92 79 GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
jbradshaw 0:e4a10ed6eb92 80 ble->accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME,
jbradshaw 0:e4a10ed6eb92 81 (uint8_t *)deviceName, nameSize);
jbradshaw 0:e4a10ed6eb92 82 ble->setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
jbradshaw 0:e4a10ed6eb92 83 ble->setAdvertisingInterval(1600); // 1000ms; in multiples of 0.625ms.
jbradshaw 0:e4a10ed6eb92 84 GattService envService(serviceUUID, gattCharacteristics,
jbradshaw 0:e4a10ed6eb92 85 numberOfCharacteristics);
jbradshaw 0:e4a10ed6eb92 86 ble->gattServer().addService(envService);
jbradshaw 0:e4a10ed6eb92 87 ble->onDataWritten(this, &BluetoothLE::onDataWritten);
jbradshaw 0:e4a10ed6eb92 88 // Start Advertising
jbradshaw 0:e4a10ed6eb92 89 ble->startAdvertising();
jbradshaw 0:e4a10ed6eb92 90 }
jbradshaw 0:e4a10ed6eb92 91
jbradshaw 0:e4a10ed6eb92 92 static const Gap::ConnectionParams_t paramsLowPower = {
jbradshaw 0:e4a10ed6eb92 93 400, /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
jbradshaw 0:e4a10ed6eb92 94 400, /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
jbradshaw 0:e4a10ed6eb92 95 60, /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
jbradshaw 0:e4a10ed6eb92 96 3100 /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
jbradshaw 0:e4a10ed6eb92 97 };
jbradshaw 0:e4a10ed6eb92 98
jbradshaw 0:e4a10ed6eb92 99 static Gap::Handle_t connHandle = 0;
jbradshaw 0:e4a10ed6eb92 100
jbradshaw 0:e4a10ed6eb92 101 /**
jbradshaw 0:e4a10ed6eb92 102 * @brief Called on BLE connection
jbradshaw 0:e4a10ed6eb92 103 */
jbradshaw 0:e4a10ed6eb92 104 void BluetoothLE::connectionCallback(
jbradshaw 0:e4a10ed6eb92 105 const Gap::ConnectionCallbackParams_t *params) {
jbradshaw 0:e4a10ed6eb92 106 connHandle = params->handle;
jbradshaw 0:e4a10ed6eb92 107 }
jbradshaw 0:e4a10ed6eb92 108
jbradshaw 0:e4a10ed6eb92 109 /**
jbradshaw 0:e4a10ed6eb92 110 * @brief Start advertising on a disconnect
jbradshaw 0:e4a10ed6eb92 111 */
jbradshaw 0:e4a10ed6eb92 112 void BluetoothLE::disconnectionCallback(
jbradshaw 0:e4a10ed6eb92 113 const Gap::DisconnectionCallbackParams_t *params) {
jbradshaw 0:e4a10ed6eb92 114 _isConnected = false;
jbradshaw 0:e4a10ed6eb92 115 ble->startAdvertising();
jbradshaw 0:e4a10ed6eb92 116 }
jbradshaw 0:e4a10ed6eb92 117
jbradshaw 0:e4a10ed6eb92 118 /**
jbradshaw 0:e4a10ed6eb92 119 * @brief Called when the client writes to a writable characteristic
jbradshaw 0:e4a10ed6eb92 120 * @param params Pointer to a structure that contains details on what was
jbradshaw 0:e4a10ed6eb92 121 * written
jbradshaw 0:e4a10ed6eb92 122 */
jbradshaw 0:e4a10ed6eb92 123 void BluetoothLE::onDataWritten(const GattWriteCallbackParams *params) {
jbradshaw 0:e4a10ed6eb92 124 int i;
jbradshaw 0:e4a10ed6eb92 125 int index = 0;
jbradshaw 0:e4a10ed6eb92 126 // match the characteristic handle
jbradshaw 0:e4a10ed6eb92 127 printf("BluetoothLE::onDataWritten ");
jbradshaw 0:e4a10ed6eb92 128 for (i = 0; i < numberOfCharacteristics; i++) {
jbradshaw 0:e4a10ed6eb92 129 if (params->handle == gattCharacteristics[i]->getValueHandle()) {
jbradshaw 0:e4a10ed6eb92 130 characteristics[i]->copyDataWritten(params);
jbradshaw 0:e4a10ed6eb92 131 index = i;
jbradshaw 0:e4a10ed6eb92 132 break;
jbradshaw 0:e4a10ed6eb92 133 }
jbradshaw 0:e4a10ed6eb92 134 }
jbradshaw 0:e4a10ed6eb92 135 (*_onDataWritten)(index);
jbradshaw 0:e4a10ed6eb92 136 }
jbradshaw 0:e4a10ed6eb92 137
jbradshaw 0:e4a10ed6eb92 138 /**
jbradshaw 0:e4a10ed6eb92 139 * @brief Update the characteristic notification
jbradshaw 0:e4a10ed6eb92 140 * @param index Index of the characteristic
jbradshaw 0:e4a10ed6eb92 141 * @param data Pointer to the byte data to update the charateristic payload
jbradshaw 0:e4a10ed6eb92 142 */
jbradshaw 0:e4a10ed6eb92 143 void BluetoothLE::notifyCharacteristic(int index, uint8_t *data) {
jbradshaw 0:e4a10ed6eb92 144 for (int i = 0; i < characteristics[index]->getPayloadLength(); i++) {
jbradshaw 0:e4a10ed6eb92 145 characteristics[index]->getPayloadBytes()[i] = data[i];
jbradshaw 0:e4a10ed6eb92 146 }
jbradshaw 0:e4a10ed6eb92 147 characteristics[index]->update();
jbradshaw 0:e4a10ed6eb92 148 }
jbradshaw 0:e4a10ed6eb92 149
jbradshaw 0:e4a10ed6eb92 150 /**
jbradshaw 0:e4a10ed6eb92 151 * @brief Update the characteristic notification
jbradshaw 0:e4a10ed6eb92 152 * @param index Index of the characteristic
jbradshaw 0:e4a10ed6eb92 153 * @param data Pointer to the byte data to update the charateristic payload
jbradshaw 0:e4a10ed6eb92 154 */
jbradshaw 0:e4a10ed6eb92 155 void BluetoothLE::notifyCharacteristicTest(int index) {
jbradshaw 0:e4a10ed6eb92 156 for (int i = 0; i < characteristics[index]->getPayloadLength(); i++) {
jbradshaw 0:e4a10ed6eb92 157 characteristics[index]->getPayloadBytes()[i]++;
jbradshaw 0:e4a10ed6eb92 158 }
jbradshaw 0:e4a10ed6eb92 159 characteristics[index]->update();
jbradshaw 0:e4a10ed6eb92 160 }
jbradshaw 0:e4a10ed6eb92 161
jbradshaw 0:e4a10ed6eb92 162 uint8_t *BluetoothLE::getDataWritten(int index, int *length) {
jbradshaw 0:e4a10ed6eb92 163 return characteristics[index]->getDataWritten(length);
jbradshaw 0:e4a10ed6eb92 164 }
jbradshaw 0:e4a10ed6eb92 165
jbradshaw 0:e4a10ed6eb92 166 /**
jbradshaw 0:e4a10ed6eb92 167 * @brief Function to query if a BLE connection is active
jbradshaw 0:e4a10ed6eb92 168 * @return true if BLE connected, false if BLE is not connected
jbradshaw 0:e4a10ed6eb92 169 */
jbradshaw 0:e4a10ed6eb92 170 bool BluetoothLE::isConnected(void) {
jbradshaw 0:e4a10ed6eb92 171 return (ble->getGapState().connected == 1 ? true : false);
jbradshaw 0:e4a10ed6eb92 172 }