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.

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 #include "Test_MAX30101.h"
jbradshaw 0:e4a10ed6eb92 34 #include "Test_Utilities.h"
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 uint32_t testing_max30101 = 0;
jbradshaw 0:e4a10ed6eb92 37 uint32_t testing_max30101_flags[4];
jbradshaw 0:e4a10ed6eb92 38
jbradshaw 0:e4a10ed6eb92 39 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 40 void test_MAX30101(void (*outputString)(const char *)) {
jbradshaw 0:e4a10ed6eb92 41 Timer timer;
jbradshaw 0:e4a10ed6eb92 42 int totalPass = 1;
jbradshaw 0:e4a10ed6eb92 43 uint32_t foundHR = 0;
jbradshaw 0:e4a10ed6eb92 44 uint32_t foundSPO2 = 0;
jbradshaw 0:e4a10ed6eb92 45 uint32_t foundMULTI = 0;
jbradshaw 0:e4a10ed6eb92 46 MAX30101 *max30101;
jbradshaw 0:e4a10ed6eb92 47
jbradshaw 0:e4a10ed6eb92 48 max30101 = Peripherals::max30101();
jbradshaw 0:e4a10ed6eb92 49
jbradshaw 0:e4a10ed6eb92 50 // display header
jbradshaw 0:e4a10ed6eb92 51 outputString("Testing MAX30101|");
jbradshaw 0:e4a10ed6eb92 52
jbradshaw 0:e4a10ed6eb92 53 // clear testing flags
jbradshaw 0:e4a10ed6eb92 54 testing_max30101_flags[TESTING_HR_FLAG] = 0;
jbradshaw 0:e4a10ed6eb92 55 testing_max30101_flags[TESTING_SPO2_FLAG] = 0;
jbradshaw 0:e4a10ed6eb92 56 testing_max30101_flags[TESTING_MULTI_FLAG] = 0;
jbradshaw 0:e4a10ed6eb92 57 testing_max30101 = 1;
jbradshaw 0:e4a10ed6eb92 58
jbradshaw 0:e4a10ed6eb92 59 //
jbradshaw 0:e4a10ed6eb92 60 // start stream (HR)
jbradshaw 0:e4a10ed6eb92 61 //
jbradshaw 0:e4a10ed6eb92 62 outputString("Start HR Streaming...|");
jbradshaw 0:e4a10ed6eb92 63 max30101->HRmode_init(0x0, 0x00, 0x01, 0x03,
jbradshaw 0:e4a10ed6eb92 64 0x33); // This is the HR mode only (IR LED only)
jbradshaw 0:e4a10ed6eb92 65 // look for (HR) streaming
jbradshaw 0:e4a10ed6eb92 66 timer.start();
jbradshaw 0:e4a10ed6eb92 67 while (1) {
jbradshaw 0:e4a10ed6eb92 68 if ((foundHR == 0) && (testing_max30101_flags[TESTING_HR_FLAG] == 1)) {
jbradshaw 0:e4a10ed6eb92 69 foundHR = 1;
jbradshaw 0:e4a10ed6eb92 70 outputString("HR Stream: PASS|");
jbradshaw 0:e4a10ed6eb92 71 break;
jbradshaw 0:e4a10ed6eb92 72 }
jbradshaw 0:e4a10ed6eb92 73 if (timer.read() >= TESTING_MAX30101_TIMEOUT_SECONDS) {
jbradshaw 0:e4a10ed6eb92 74 break;
jbradshaw 0:e4a10ed6eb92 75 }
jbradshaw 0:e4a10ed6eb92 76 }
jbradshaw 0:e4a10ed6eb92 77 if (foundHR == 0) {
jbradshaw 0:e4a10ed6eb92 78 outputString("HR Stream: FAIL|");
jbradshaw 1:9490836294ea 79 totalPass = 0;
jbradshaw 0:e4a10ed6eb92 80 }
jbradshaw 0:e4a10ed6eb92 81 // stop stream
jbradshaw 0:e4a10ed6eb92 82 max30101->HRmode_stop();
jbradshaw 0:e4a10ed6eb92 83
jbradshaw 0:e4a10ed6eb92 84 //
jbradshaw 0:e4a10ed6eb92 85 // start stream (SPO2)
jbradshaw 0:e4a10ed6eb92 86 //
jbradshaw 0:e4a10ed6eb92 87 outputString("Start SPO2 Streaming...|");
jbradshaw 0:e4a10ed6eb92 88 max30101->SpO2mode_init(
jbradshaw 0:e4a10ed6eb92 89 0xF, 0x00, 0x01, 0x03, 0x33,
jbradshaw 0:e4a10ed6eb92 90 0x33); // This is the SpO2 mode only (Red and IR LED only)
jbradshaw 0:e4a10ed6eb92 91 // look for (SPO2) stream
jbradshaw 0:e4a10ed6eb92 92 timer.reset();
jbradshaw 0:e4a10ed6eb92 93 while (1) {
jbradshaw 0:e4a10ed6eb92 94 if ((foundSPO2 == 0) && (testing_max30101_flags[TESTING_SPO2_FLAG] == 1)) {
jbradshaw 0:e4a10ed6eb92 95 foundSPO2 = 1;
jbradshaw 0:e4a10ed6eb92 96 outputString("SPO2 Stream: PASS|");
jbradshaw 0:e4a10ed6eb92 97 break;
jbradshaw 0:e4a10ed6eb92 98 }
jbradshaw 0:e4a10ed6eb92 99 if (timer.read() >= TESTING_MAX30101_TIMEOUT_SECONDS) {
jbradshaw 0:e4a10ed6eb92 100 break;
jbradshaw 0:e4a10ed6eb92 101 }
jbradshaw 0:e4a10ed6eb92 102 }
jbradshaw 0:e4a10ed6eb92 103 if (foundSPO2 == 0) {
jbradshaw 0:e4a10ed6eb92 104 outputString("SPO2 Stream: FAIL|");
jbradshaw 1:9490836294ea 105 totalPass = 0;
jbradshaw 0:e4a10ed6eb92 106 }
jbradshaw 0:e4a10ed6eb92 107 // stop stream
jbradshaw 0:e4a10ed6eb92 108 max30101->SpO2mode_stop();
jbradshaw 0:e4a10ed6eb92 109
jbradshaw 0:e4a10ed6eb92 110 //
jbradshaw 0:e4a10ed6eb92 111 // start stream (MULTI)
jbradshaw 0:e4a10ed6eb92 112 //
jbradshaw 0:e4a10ed6eb92 113 outputString("Start Multi Streaming...|");
jbradshaw 0:e4a10ed6eb92 114 max30101->Multimode_init(0x00, 0x00, 0x01, 0x03, 0x33, 0x33, 0x33, 0x01, 0x02,
jbradshaw 0:e4a10ed6eb92 115 0x03, 0x00); // Up to 4 LED can be turned on over
jbradshaw 0:e4a10ed6eb92 116 // look for (SPO2) stream
jbradshaw 0:e4a10ed6eb92 117 timer.reset();
jbradshaw 0:e4a10ed6eb92 118 while (1) {
jbradshaw 0:e4a10ed6eb92 119 if ((foundMULTI == 0) &&
jbradshaw 0:e4a10ed6eb92 120 (testing_max30101_flags[TESTING_MULTI_FLAG] == 1)) {
jbradshaw 0:e4a10ed6eb92 121 foundMULTI = 1;
jbradshaw 0:e4a10ed6eb92 122 outputString("Multi Stream: PASS|");
jbradshaw 0:e4a10ed6eb92 123 break;
jbradshaw 0:e4a10ed6eb92 124 }
jbradshaw 0:e4a10ed6eb92 125 if (timer.read() >= TESTING_MAX30101_TIMEOUT_SECONDS) {
jbradshaw 0:e4a10ed6eb92 126 break;
jbradshaw 0:e4a10ed6eb92 127 }
jbradshaw 0:e4a10ed6eb92 128 }
jbradshaw 0:e4a10ed6eb92 129 if (foundMULTI == 0) {
jbradshaw 0:e4a10ed6eb92 130 outputString("Multi Stream: FAIL|");
jbradshaw 1:9490836294ea 131 totalPass = 0;
jbradshaw 0:e4a10ed6eb92 132 }
jbradshaw 0:e4a10ed6eb92 133 // stop stream
jbradshaw 0:e4a10ed6eb92 134 max30101->Multimode_stop();
jbradshaw 0:e4a10ed6eb92 135
jbradshaw 0:e4a10ed6eb92 136 testing_max30101 = 0;
jbradshaw 0:e4a10ed6eb92 137
jbradshaw 0:e4a10ed6eb92 138 timer.stop();
jbradshaw 0:e4a10ed6eb92 139 // final results
jbradshaw 0:e4a10ed6eb92 140 outputString("Result: ");
jbradshaw 0:e4a10ed6eb92 141 _printPassFail(totalPass, 0, outputString);
jbradshaw 0:e4a10ed6eb92 142 }