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/Characteristic.h@3:8e9b9f5818aa, 2017-04-25 (annotated)

Committer:
jbradshaw
Date:
Tue Apr 25 10:47:10 2017 -0500
Revision:
3:8e9b9f5818aa
Parent:
1:9490836294ea 
Removed Bulk Erasing, instead a small number of bytes are sampled from each and every page to determine if sector is "dirty", if so sector is erased

Prevents device from sleeping when the firmware detects a series of binary flash page RPC transfers, this increases flash page transfers by %450

  when 200mS elapse with the last flash page transfer, normal sleep behaviour is resumed

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