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.

Revision:
1:9490836294ea
Parent:
0:e4a10ed6eb92
--- a/HSP/Devices/MAX14720/MAX14720/MAX14720.h	Tue Oct 25 15:22:11 2016 +0000
+++ b/HSP/Devices/MAX14720/MAX14720/MAX14720.h	Fri Apr 21 12:12:30 2017 -0500
@@ -93,30 +93,30 @@
   *@details Enumerated MAX14720 register addresses
   */
   typedef enum {
-    REG_CHIP_ID = 0x00,    ///< Chip ID
-    REG_CHIP_REV = 0x01,   ///< Chip Revision
-    REG_BOOST_CDIV = 0x03, ///< Boost Clock Divider
-    REG_BOOST_ISET = 0x04, ///< Boost Peak Current
-    REG_BOOST_VSET = 0x05, ///< Boost Voltage Setting
-    REG_BOOST_CFG = 0x06,  ///< Boost Configuration
-    REG_BUCK_VSET = 0x07,  ///< Buck Voltage Setting
-    REG_BUCK_CFG = 0x08,   ///< Buck Configuration
-    REG_BUCK_ISET = 0x09,  ///< Buck Peak Current and Settings
-    REG_LDO_VSET = 0x0A,   ///< LDO Voltage Setting
-    REG_LDO_CFG = 0x0B,    ///< LDO Configuration
-    REG_SWITCH_CFG = 0x0C, ///< Switch Configuration
-    REG_BAT_TIME = 0x0D,   ///< Battery Impedance Timing
-    REG_BAT_CFG = 0x0E,    ///< Battery Impedance Configuration
-    REG_BAT_BCV = 0x0F,    ///< Battery Cell Voltage
-    REG_BAT_OCV = 0x10,    ///< Open Cell Voltage
-    REG_BAT_LCV = 0x11,    ///< Loaded Cell Voltage
-    REG_MON_CFG = 0x19,    ///< Monitor Multiplexer Configuration
-    REG_BOOT_CFG = 0x1A,   ///< Boot Configuration
-    REG_PIN_STAT = 0x1B,   ///< Pin Status
-    REG_BBB_EXTRA = 0x1C,  ///< Buck/Buck-Boost Extra
-    REG_HANDSHK = 0x1D,    ///< Power-On Handshake
-    REG_UVLO_CFG = 0x1E,   ///< Under-Voltage Lock Out
-    REG_PWR_OFF = 0x1F,    ///< Power Off Command
+    REG_CHIP_ID    = 0x00,    ///< Chip ID
+    REG_CHIP_REV   = 0x01,    ///< Chip Revision
+    REG_BOOST_CDIV = 0x03,    ///< Boost Clock Divider
+    REG_BOOST_ISET = 0x04,    ///< Boost Peak Current
+    REG_BOOST_VSET = 0x05,    ///< Boost Voltage Setting
+    REG_BOOST_CFG  = 0x06,    ///< Boost Configuration
+    REG_BUCK_VSET  = 0x07,    ///< Buck Voltage Setting
+    REG_BUCK_CFG   = 0x08,    ///< Buck Configuration
+    REG_BUCK_ISET  = 0x09,    ///< Buck Peak Current and Settings
+    REG_LDO_VSET   = 0x0A,    ///< LDO Voltage Setting
+    REG_LDO_CFG    = 0x0B,    ///< LDO Configuration
+    REG_SWITCH_CFG = 0x0C,    ///< Switch Configuration
+    REG_BAT_TIME   = 0x0D,    ///< Battery Impedance Timing
+    REG_BAT_CFG    = 0x0E,    ///< Battery Impedance Configuration
+    REG_BAT_BCV    = 0x0F,    ///< Battery Cell Voltage
+    REG_BAT_OCV    = 0x10,    ///< Open Cell Voltage
+    REG_BAT_LCV    = 0x11,    ///< Loaded Cell Voltage
+    REG_MON_CFG    = 0x19,    ///< Monitor Multiplexer Configuration
+    REG_BOOT_CFG   = 0x1A,    ///< Boot Configuration
+    REG_PIN_STAT   = 0x1B,    ///< Pin Status
+    REG_BBB_EXTRA  = 0x1C,    ///< Buck/Buck-Boost Extra
+    REG_HANDSHK    = 0x1D,    ///< Power-On Handshake
+    REG_UVLO_CFG   = 0x1E,    ///< Under-Voltage Lock Out
+    REG_PWR_OFF    = 0x1F,    ///< Power Off Command
   } registers_t;
 
   /**
@@ -306,11 +306,11 @@
       buckFScl;          /// Buck Fet Scaling
 
 private:
-  /// I2C pointer
+  /// @brief I2C pointer
   I2C *i2c;
-  /// Is this object the owner of the I2C object
+  /// @brief Is this object the owner of the I2C object
   bool isOwner;
-  /// Device slave address
+  /// @brief Device slave address
   int slaveAddress;
 };