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 #ifndef _LED_H_
jbradshaw 0:e4a10ed6eb92 34 #define _LED_H_
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 37
jbradshaw 0:e4a10ed6eb92 38 /**
jbradshaw 0:e4a10ed6eb92 39 * Driver for the HSP Led, supports different blink rates and patterns
jbradshaw 0:e4a10ed6eb92 40 *
jbradshaw 0:e4a10ed6eb92 41 */
jbradshaw 0:e4a10ed6eb92 42
jbradshaw 0:e4a10ed6eb92 43 class HspLed {
jbradshaw 0:e4a10ed6eb92 44 public:
jbradshaw 0:e4a10ed6eb92 45 static const int LED_ON = 0;
jbradshaw 0:e4a10ed6eb92 46 static const int LED_OFF = 1;
jbradshaw 0:e4a10ed6eb92 47
jbradshaw 0:e4a10ed6eb92 48 /// define all of the modes the LED can support
jbradshaw 0:e4a10ed6eb92 49 typedef enum eMode {
jbradshaw 0:e4a10ed6eb92 50 eLedOn,
jbradshaw 0:e4a10ed6eb92 51 eLedOff,
jbradshaw 0:e4a10ed6eb92 52 eLedPeriod,
jbradshaw 0:e4a10ed6eb92 53 eLedPattern
jbradshaw 1:9490836294ea 54 } eMode_t;
jbradshaw 0:e4a10ed6eb92 55 /// define the values that turn the LED on or off at the pin
jbradshaw 0:e4a10ed6eb92 56 #define HSP_LED_ON 0
jbradshaw 0:e4a10ed6eb92 57 #define HSP_LED_OFF 1
jbradshaw 0:e4a10ed6eb92 58
jbradshaw 0:e4a10ed6eb92 59 /*
jbradshaw 0:e4a10ed6eb92 60 * @brief Constructor where you specify the LED pin name
jbradshaw 0:e4a10ed6eb92 61 */
jbradshaw 0:e4a10ed6eb92 62 HspLed(PinName ledPin);
jbradshaw 0:e4a10ed6eb92 63
jbradshaw 0:e4a10ed6eb92 64 /**
jbradshaw 1:9490836294ea 65 * @brief Blink the HSP LED at a set time interval
jbradshaw 0:e4a10ed6eb92 66 * @param mSeconds Number of seconds to set the timer interval
jbradshaw 0:e4a10ed6eb92 67 */
jbradshaw 0:e4a10ed6eb92 68 void blink(uint32_t mSeconds);
jbradshaw 0:e4a10ed6eb92 69
jbradshaw 0:e4a10ed6eb92 70 /**
jbradshaw 0:e4a10ed6eb92 71 * @brief Start rotating the LED through a 32-bit pattern at a mS rate specified
jbradshaw 0:e4a10ed6eb92 72 * @param pattern 32-bit pattern to rotate through
jbradshaw 0:e4a10ed6eb92 73 * @param mSeconds the amount of time to take per bit in the pattern
jbradshaw 0:e4a10ed6eb92 74 */
jbradshaw 0:e4a10ed6eb92 75 void pattern(uint32_t pattern, uint32_t mSeconds);
jbradshaw 0:e4a10ed6eb92 76
jbradshaw 0:e4a10ed6eb92 77 /**
jbradshaw 0:e4a10ed6eb92 78 * @brief Turn the LED on
jbradshaw 0:e4a10ed6eb92 79 */
jbradshaw 0:e4a10ed6eb92 80 void on(void);
jbradshaw 0:e4a10ed6eb92 81
jbradshaw 0:e4a10ed6eb92 82 /**
jbradshaw 0:e4a10ed6eb92 83 * @brief Turn the LED off
jbradshaw 0:e4a10ed6eb92 84 */
jbradshaw 0:e4a10ed6eb92 85 void off(void);
jbradshaw 0:e4a10ed6eb92 86
jbradshaw 0:e4a10ed6eb92 87 /**
jbradshaw 0:e4a10ed6eb92 88 * @brief Update the LED
jbradshaw 0:e4a10ed6eb92 89 */
jbradshaw 0:e4a10ed6eb92 90 void service(void);
jbradshaw 0:e4a10ed6eb92 91
jbradshaw 0:e4a10ed6eb92 92 private:
jbradshaw 0:e4a10ed6eb92 93
jbradshaw 0:e4a10ed6eb92 94 /**
jbradshaw 1:9490836294ea 95 * @brief Set the mode of the LED, the mode include blinking at a set rate or blinking
jbradshaw 1:9490836294ea 96 * @brief according to a pattern
jbradshaw 0:e4a10ed6eb92 97 * @param mode Mode to set the LED to
jbradshaw 0:e4a10ed6eb92 98 */
jbradshaw 1:9490836294ea 99 void setMode(eMode_t state);
jbradshaw 0:e4a10ed6eb92 100
jbradshaw 0:e4a10ed6eb92 101 /**
jbradshaw 1:9490836294ea 102 * @brief Toggle the state of the LED
jbradshaw 0:e4a10ed6eb92 103 */
jbradshaw 0:e4a10ed6eb92 104 void toggle(void);
jbradshaw 0:e4a10ed6eb92 105
jbradshaw 0:e4a10ed6eb92 106 /**
jbradshaw 1:9490836294ea 107 * @brief Start the LED blinking or rotating through a pattern
jbradshaw 0:e4a10ed6eb92 108 */
jbradshaw 0:e4a10ed6eb92 109 void start(void);
jbradshaw 0:e4a10ed6eb92 110
jbradshaw 0:e4a10ed6eb92 111 /**
jbradshaw 1:9490836294ea 112 * @brief Stop blinking or rotating through a pattern
jbradshaw 0:e4a10ed6eb92 113 */
jbradshaw 0:e4a10ed6eb92 114 void stop(void);
jbradshaw 0:e4a10ed6eb92 115
jbradshaw 0:e4a10ed6eb92 116 /**
jbradshaw 1:9490836294ea 117 * @brief Write the LED pin to a state
jbradshaw 0:e4a10ed6eb92 118 * @param state A one or zero value to write to the LED pin
jbradshaw 0:e4a10ed6eb92 119 */
jbradshaw 0:e4a10ed6eb92 120 void state(int state);
jbradshaw 0:e4a10ed6eb92 121
jbradshaw 1:9490836294ea 122 /**
jbradshaw 0:e4a10ed6eb92 123 * @brief Single step through the pattern and output to the LED
jbradshaw 0:e4a10ed6eb92 124 */
jbradshaw 0:e4a10ed6eb92 125 void patternToLed(void);
jbradshaw 0:e4a10ed6eb92 126
jbradshaw 1:9490836294ea 127 /**
jbradshaw 1:9490836294ea 128 * @brief timer interval in mS
jbradshaw 1:9490836294ea 129 */
jbradshaw 0:e4a10ed6eb92 130 float timerInterval;
jbradshaw 1:9490836294ea 131
jbradshaw 1:9490836294ea 132 /**
jbradshaw 1:9490836294ea 133 * @brief last timer interval set to... used to prevent resetting the timer to the same value
jbradshaw 1:9490836294ea 134 */
jbradshaw 0:e4a10ed6eb92 135 float timerIntervalLast;
jbradshaw 1:9490836294ea 136
jbradshaw 1:9490836294ea 137 /**
jbradshaw 1:9490836294ea 138 * @brief local state of the pattern to rotate through
jbradshaw 1:9490836294ea 139 */
jbradshaw 0:e4a10ed6eb92 140 uint32_t bitPattern;
jbradshaw 1:9490836294ea 141
jbradshaw 1:9490836294ea 142 /**
jbradshaw 1:9490836294ea 143 * @brief current mode of the LED
jbradshaw 1:9490836294ea 144 */
jbradshaw 1:9490836294ea 145 eMode_t mode;
jbradshaw 1:9490836294ea 146
jbradshaw 1:9490836294ea 147 /**
jbradshaw 1:9490836294ea 148 * @brief the LED digital output
jbradshaw 1:9490836294ea 149 */
jbradshaw 0:e4a10ed6eb92 150 DigitalOut redLed;
jbradshaw 1:9490836294ea 151
jbradshaw 1:9490836294ea 152 /**
jbradshaw 1:9490836294ea 153 * @brief Timer service used to update the LED
jbradshaw 1:9490836294ea 154 */
jbradshaw 0:e4a10ed6eb92 155 Ticker ticker;
jbradshaw 1:9490836294ea 156
jbradshaw 1:9490836294ea 157 /**
jbradshaw 1:9490836294ea 158 * @brief Flag to indicate if the timer has been started
jbradshaw 1:9490836294ea 159 */
jbradshaw 0:e4a10ed6eb92 160 bool isStarted;
jbradshaw 0:e4a10ed6eb92 161 };
jbradshaw 0:e4a10ed6eb92 162
jbradshaw 0:e4a10ed6eb92 163 #endif /* _LED_H_ */