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/Devices/MAX14720/MAX14720/MAX14720.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
jbradshaw 0:e4a10ed6eb92 34 #include "MAX14720.h"
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 37 MAX14720::MAX14720(PinName sda, PinName scl, int slaveAddress) :
jbradshaw 0:e4a10ed6eb92 38 slaveAddress(slaveAddress) {
jbradshaw 0:e4a10ed6eb92 39 i2c = new I2C(sda, scl);
jbradshaw 0:e4a10ed6eb92 40 isOwner = true;
jbradshaw 0:e4a10ed6eb92 41 clkDivEn = false;
jbradshaw 0:e4a10ed6eb92 42 clkDivSet = 0;
jbradshaw 0:e4a10ed6eb92 43 boostISet = BOOST_ISET_100mA;
jbradshaw 0:e4a10ed6eb92 44 boostMillivolts = 3300;
jbradshaw 0:e4a10ed6eb92 45 boostEn = BOOST_DISABLED;
jbradshaw 0:e4a10ed6eb92 46 boostEMI = false;
jbradshaw 0:e4a10ed6eb92 47 boostInd = false;
jbradshaw 0:e4a10ed6eb92 48 boostHysOff = false;
jbradshaw 0:e4a10ed6eb92 49 boostPasDsc = false;
jbradshaw 0:e4a10ed6eb92 50 boostActDsc = false;
jbradshaw 0:e4a10ed6eb92 51 buckMd = BUCK_BURST;
jbradshaw 0:e4a10ed6eb92 52 buckFst = false;
jbradshaw 0:e4a10ed6eb92 53 buckISet = BUCK_ISET_300mA;
jbradshaw 0:e4a10ed6eb92 54 buckCfg = false;
jbradshaw 0:e4a10ed6eb92 55 buckInd = false;
jbradshaw 0:e4a10ed6eb92 56 buckHysOff = true;
jbradshaw 0:e4a10ed6eb92 57 buckMinOT = true;
jbradshaw 0:e4a10ed6eb92 58 buckInteg = true;
jbradshaw 0:e4a10ed6eb92 59 buckPasDsc = false;
jbradshaw 0:e4a10ed6eb92 60 buckActDsc = false;
jbradshaw 0:e4a10ed6eb92 61 buckFScl = false;
jbradshaw 0:e4a10ed6eb92 62 }
jbradshaw 0:e4a10ed6eb92 63 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 64 MAX14720::MAX14720(I2C *i2c, int slaveAddress) : slaveAddress(slaveAddress) {
jbradshaw 0:e4a10ed6eb92 65 this->i2c = i2c;
jbradshaw 0:e4a10ed6eb92 66 isOwner = false;
jbradshaw 0:e4a10ed6eb92 67 clkDivEn = false;
jbradshaw 0:e4a10ed6eb92 68 clkDivSet = 0;
jbradshaw 0:e4a10ed6eb92 69 boostISet = BOOST_ISET_100mA;
jbradshaw 0:e4a10ed6eb92 70 boostMillivolts = 3300;
jbradshaw 0:e4a10ed6eb92 71 boostEn = BOOST_DISABLED;
jbradshaw 0:e4a10ed6eb92 72 boostEMI = false;
jbradshaw 0:e4a10ed6eb92 73 boostInd = false;
jbradshaw 0:e4a10ed6eb92 74 boostHysOff = false;
jbradshaw 0:e4a10ed6eb92 75 boostPasDsc = false;
jbradshaw 0:e4a10ed6eb92 76 boostActDsc = false;
jbradshaw 0:e4a10ed6eb92 77 buckMd = BUCK_BURST;
jbradshaw 0:e4a10ed6eb92 78 buckFst = false;
jbradshaw 0:e4a10ed6eb92 79 buckISet = BUCK_ISET_300mA;
jbradshaw 0:e4a10ed6eb92 80 buckCfg = false;
jbradshaw 0:e4a10ed6eb92 81 buckInd = false;
jbradshaw 0:e4a10ed6eb92 82 buckHysOff = true;
jbradshaw 0:e4a10ed6eb92 83 buckMinOT = true;
jbradshaw 0:e4a10ed6eb92 84 buckInteg = true;
jbradshaw 0:e4a10ed6eb92 85 buckPasDsc = false;
jbradshaw 0:e4a10ed6eb92 86 buckActDsc = false;
jbradshaw 0:e4a10ed6eb92 87 buckFScl = false;
jbradshaw 0:e4a10ed6eb92 88 }
jbradshaw 0:e4a10ed6eb92 89 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 90 MAX14720::~MAX14720() {
jbradshaw 0:e4a10ed6eb92 91 if (isOwner == true) {
jbradshaw 0:e4a10ed6eb92 92 delete i2c;
jbradshaw 0:e4a10ed6eb92 93 }
jbradshaw 0:e4a10ed6eb92 94 }
jbradshaw 0:e4a10ed6eb92 95
jbradshaw 0:e4a10ed6eb92 96 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 97 int MAX14720::boostSetMode(boostEn_t mode) {
jbradshaw 0:e4a10ed6eb92 98 int result;
jbradshaw 0:e4a10ed6eb92 99 char data;
jbradshaw 0:e4a10ed6eb92 100 boostEn = mode;
jbradshaw 0:e4a10ed6eb92 101 data = (boostEn << 3) | (boostEMI << 1) | (boostInd);
jbradshaw 0:e4a10ed6eb92 102 result = writeReg(REG_BOOST_CFG, data);
jbradshaw 0:e4a10ed6eb92 103 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 104 return 0;
jbradshaw 0:e4a10ed6eb92 105 }
jbradshaw 0:e4a10ed6eb92 106
jbradshaw 0:e4a10ed6eb92 107 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 108 int MAX14720::boostSetVoltage(int mV) {
jbradshaw 0:e4a10ed6eb92 109 int result;
jbradshaw 0:e4a10ed6eb92 110 char data;
jbradshaw 0:e4a10ed6eb92 111 if ((MAX14720_BOOST_MIN_MV <= mV) && (mV <= MAX14720_BOOST_MAX_MV)) {
jbradshaw 0:e4a10ed6eb92 112 boostMillivolts = mV;
jbradshaw 0:e4a10ed6eb92 113 data = (mV - MAX14720_BOOST_MIN_MV) / MAX14720_BOOST_STEP_MV;
jbradshaw 0:e4a10ed6eb92 114 } else {
jbradshaw 0:e4a10ed6eb92 115 return MAX14720_ERROR;
jbradshaw 0:e4a10ed6eb92 116 }
jbradshaw 0:e4a10ed6eb92 117 if (boostEn == BOOST_ENABLED) {
jbradshaw 0:e4a10ed6eb92 118 result = writeReg(REG_BOOST_CFG, 0x00);
jbradshaw 0:e4a10ed6eb92 119 }
jbradshaw 0:e4a10ed6eb92 120 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 121 result = writeReg(REG_BOOST_VSET, data);
jbradshaw 0:e4a10ed6eb92 122 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 123 if (boostEn == BOOST_ENABLED) {
jbradshaw 0:e4a10ed6eb92 124 data = (boostEn << 3) | (boostEMI << 1) | (boostInd);
jbradshaw 0:e4a10ed6eb92 125 result = writeReg(REG_BOOST_CFG, data);
jbradshaw 0:e4a10ed6eb92 126 }
jbradshaw 0:e4a10ed6eb92 127 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 128 return 0;
jbradshaw 0:e4a10ed6eb92 129 }
jbradshaw 0:e4a10ed6eb92 130
jbradshaw 0:e4a10ed6eb92 131 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 132 int MAX14720::init() {
jbradshaw 0:e4a10ed6eb92 133 int result;
jbradshaw 0:e4a10ed6eb92 134 char data;
jbradshaw 0:e4a10ed6eb92 135 data = (clkDivEn << 7) | (clkDivSet);
jbradshaw 0:e4a10ed6eb92 136 result = writeReg(REG_BOOST_CDIV, data);
jbradshaw 0:e4a10ed6eb92 137 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 138 data = (boostISet);
jbradshaw 0:e4a10ed6eb92 139 result = writeReg(REG_BOOST_ISET, data);
jbradshaw 0:e4a10ed6eb92 140 if (result == MAX14720_ERROR)return result;
jbradshaw 0:e4a10ed6eb92 141 if ((MAX14720_BOOST_MIN_MV <= boostMillivolts) &&
jbradshaw 0:e4a10ed6eb92 142 (boostMillivolts <= MAX14720_BOOST_MAX_MV)) {
jbradshaw 0:e4a10ed6eb92 143 data = (boostMillivolts - MAX14720_BOOST_MIN_MV) / MAX14720_BOOST_STEP_MV;
jbradshaw 0:e4a10ed6eb92 144 } else {
jbradshaw 0:e4a10ed6eb92 145 return MAX14720_ERROR;
jbradshaw 0:e4a10ed6eb92 146 }
jbradshaw 0:e4a10ed6eb92 147 result = writeReg(REG_BOOST_VSET, data);
jbradshaw 0:e4a10ed6eb92 148 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 149 data = (buckMd << 1) | (buckFst);
jbradshaw 0:e4a10ed6eb92 150 result = writeReg(REG_BUCK_CFG, data);
jbradshaw 0:e4a10ed6eb92 151 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 152 data = (boostHysOff << 7) | (boostPasDsc << 6) | (boostActDsc << 5) |
jbradshaw 0:e4a10ed6eb92 153 (buckPasDsc << 2) | (buckActDsc << 1) | (buckFScl);
jbradshaw 0:e4a10ed6eb92 154 result = writeReg(REG_BBB_EXTRA, data);
jbradshaw 0:e4a10ed6eb92 155 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 156 // Write Boost Enable Register Last
jbradshaw 0:e4a10ed6eb92 157 data = (boostEn << 3) | (boostEMI << 1) | (boostInd);
jbradshaw 0:e4a10ed6eb92 158 result = writeReg(REG_BOOST_CFG, data);
jbradshaw 0:e4a10ed6eb92 159 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 160 return 0;
jbradshaw 0:e4a10ed6eb92 161 }
jbradshaw 0:e4a10ed6eb92 162
jbradshaw 0:e4a10ed6eb92 163 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 164 int MAX14720::monSet(monCfg_t monCfg) {
jbradshaw 0:e4a10ed6eb92 165 int result;
jbradshaw 0:e4a10ed6eb92 166 result = writeReg(REG_MON_CFG, monCfg);
jbradshaw 0:e4a10ed6eb92 167 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 168 return 0;
jbradshaw 0:e4a10ed6eb92 169 }
jbradshaw 0:e4a10ed6eb92 170
jbradshaw 0:e4a10ed6eb92 171 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 172 int MAX14720::shutdown() {
jbradshaw 0:e4a10ed6eb92 173 int result;
jbradshaw 0:e4a10ed6eb92 174 result = writeReg(REG_PWR_OFF, 0xB2);
jbradshaw 0:e4a10ed6eb92 175 if (result == MAX14720_ERROR) return result;
jbradshaw 0:e4a10ed6eb92 176 return 0;
jbradshaw 0:e4a10ed6eb92 177 }
jbradshaw 0:e4a10ed6eb92 178
jbradshaw 0:e4a10ed6eb92 179 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 180 int MAX14720::writeReg(registers_t reg, char value) {
jbradshaw 0:e4a10ed6eb92 181 int result;
jbradshaw 0:e4a10ed6eb92 182 char cmdData[2] = {(char)reg, value};
jbradshaw 0:e4a10ed6eb92 183 result = i2c->write(slaveAddress, cmdData, 2);
jbradshaw 0:e4a10ed6eb92 184 if (result != 0) return MAX14720_ERROR;
jbradshaw 0:e4a10ed6eb92 185 return MAX14720_NO_ERROR;
jbradshaw 0:e4a10ed6eb92 186 }
jbradshaw 0:e4a10ed6eb92 187
jbradshaw 0:e4a10ed6eb92 188 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 189 int MAX14720::readReg(registers_t reg, char *value) {
jbradshaw 0:e4a10ed6eb92 190 int result;
jbradshaw 0:e4a10ed6eb92 191 char cmdData[1] = {(char)reg};
jbradshaw 0:e4a10ed6eb92 192
jbradshaw 0:e4a10ed6eb92 193 result = i2c->write(slaveAddress, cmdData, 1);
jbradshaw 0:e4a10ed6eb92 194 if (result != 0) return MAX14720_ERROR;
jbradshaw 0:e4a10ed6eb92 195 result = i2c->read(slaveAddress, value, 1);
jbradshaw 0:e4a10ed6eb92 196 if (result != 0) return MAX14720_ERROR;
jbradshaw 0:e4a10ed6eb92 197 return MAX14720_NO_ERROR;
jbradshaw 0:e4a10ed6eb92 198 }