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/MAX30205/MAX30205/MAX30205.h@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 #ifndef __MAX30205_H_
jbradshaw 0:e4a10ed6eb92 34 #define __MAX30205_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 MAX30205 on the HSP Platform
jbradshaw 0:e4a10ed6eb92 40 *
jbradshaw 0:e4a10ed6eb92 41 * @code
jbradshaw 0:e4a10ed6eb92 42 * #include <stdio.h>
jbradshaw 0:e4a10ed6eb92 43 * #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 44 * #include "xxx.h"
jbradshaw 0:e4a10ed6eb92 45 *
jbradshaw 0:e4a10ed6eb92 46 * I2C i2c(I2C_SDA, I2C_SCL);
jbradshaw 0:e4a10ed6eb92 47 * xxx xxx(&i2c);
jbradshaw 0:e4a10ed6eb92 48 *
jbradshaw 0:e4a10ed6eb92 49 * int main(void) {
jbradshaw 0:e4a10ed6eb92 50 * printf("Initialized xxx\n");
jbradshaw 0:e4a10ed6eb92 51 * while(1) {
jbradshaw 0:e4a10ed6eb92 52 * if (xxx.init() != 0) {
jbradshaw 0:e4a10ed6eb92 53 * printf("Error communicating with xxx\n");
jbradshaw 0:e4a10ed6eb92 54 * } else {
jbradshaw 0:e4a10ed6eb92 55 * printf("Initialized xxx\n");
jbradshaw 0:e4a10ed6eb92 56 * break;
jbradshaw 0:e4a10ed6eb92 57 * }
jbradshaw 0:e4a10ed6eb92 58 * wait(1);
jbradshaw 0:e4a10ed6eb92 59 * }
jbradshaw 0:e4a10ed6eb92 60 *
jbradshaw 0:e4a10ed6eb92 61 * while(1) {
jbradshaw 0:e4a10ed6eb92 62 * printf("");
jbradshaw 0:e4a10ed6eb92 63 * wait(1);
jbradshaw 0:e4a10ed6eb92 64 * }
jbradshaw 0:e4a10ed6eb92 65 * }
jbradshaw 0:e4a10ed6eb92 66 * @endcode
jbradshaw 0:e4a10ed6eb92 67 */
jbradshaw 0:e4a10ed6eb92 68
jbradshaw 0:e4a10ed6eb92 69 class MAX30205 {
jbradshaw 0:e4a10ed6eb92 70 public:
jbradshaw 0:e4a10ed6eb92 71 /// MAX30205 Register Addresses
jbradshaw 0:e4a10ed6eb92 72 typedef enum Registers {
jbradshaw 0:e4a10ed6eb92 73 MAX30205_Temperature = 0x00,
jbradshaw 0:e4a10ed6eb92 74 MAX30205_Configuration = 0x01,
jbradshaw 0:e4a10ed6eb92 75 MAX30205_THYST = 0x02,
jbradshaw 0:e4a10ed6eb92 76 MAX30205_TOS = 0x03
jbradshaw 0:e4a10ed6eb92 77 };
jbradshaw 0:e4a10ed6eb92 78
jbradshaw 0:e4a10ed6eb92 79 /**
jbradshaw 0:e4a10ed6eb92 80 * @brief Constructor using I2C PinNames
jbradshaw 0:e4a10ed6eb92 81 * @param sda Pinname for sda
jbradshaw 0:e4a10ed6eb92 82 * @param scl Pinname for scl
jbradshaw 0:e4a10ed6eb92 83 */
jbradshaw 0:e4a10ed6eb92 84 MAX30205(PinName sda, PinName scl, int slaveAddress);
jbradshaw 0:e4a10ed6eb92 85 /**
jbradshaw 0:e4a10ed6eb92 86 * @brief Constructor using pointer to I2C object
jbradshaw 0:e4a10ed6eb92 87 * @param *i2c Pointer to I2C object
jbradshaw 0:e4a10ed6eb92 88 */
jbradshaw 0:e4a10ed6eb92 89 MAX30205(I2C *i2c, int slaveAddress);
jbradshaw 0:e4a10ed6eb92 90
jbradshaw 0:e4a10ed6eb92 91 /** @brief Destructor */
jbradshaw 0:e4a10ed6eb92 92 ~MAX30205(void);
jbradshaw 0:e4a10ed6eb92 93
jbradshaw 0:e4a10ed6eb92 94 /** @brief Write a register into device at slave address
jbradshaw 0:e4a10ed6eb92 95 * @param reg register address
jbradshaw 0:e4a10ed6eb92 96 * @param value value to write
jbradshaw 0:e4a10ed6eb92 97 */
jbradshaw 0:e4a10ed6eb92 98 int reg_write(char reg, char value);
jbradshaw 0:e4a10ed6eb92 99
jbradshaw 0:e4a10ed6eb92 100 /**
jbradshaw 0:e4a10ed6eb92 101 * @brief Detect the second instance of the MAX30205
jbradshaw 0:e4a10ed6eb92 102 * @param reg register address
jbradshaw 0:e4a10ed6eb92 103 * @param value 8-bit value to writes
jbradshaw 0:e4a10ed6eb92 104 */
jbradshaw 0:e4a10ed6eb92 105 int reg_read(char reg, char *value);
jbradshaw 0:e4a10ed6eb92 106
jbradshaw 0:e4a10ed6eb92 107 /**
jbradshaw 0:e4a10ed6eb92 108 * @brief Write a 16-bit value into device at slave address
jbradshaw 0:e4a10ed6eb92 109 * @param reg register address
jbradshaw 0:e4a10ed6eb92 110 * @param value 16-bit value to write
jbradshaw 0:e4a10ed6eb92 111 */
jbradshaw 0:e4a10ed6eb92 112 int reg_write16(char reg, uint16_t value);
jbradshaw 0:e4a10ed6eb92 113
jbradshaw 0:e4a10ed6eb92 114 /**
jbradshaw 0:e4a10ed6eb92 115 * @brief Read a 16-bit value from a device at a slave address
jbradshaw 0:e4a10ed6eb92 116 * @param reg register address
jbradshaw 0:e4a10ed6eb92 117 * @param value pointer to store read value
jbradshaw 0:e4a10ed6eb92 118 */
jbradshaw 0:e4a10ed6eb92 119 int reg_read16(char reg, uint16_t *value);
jbradshaw 0:e4a10ed6eb92 120
jbradshaw 0:e4a10ed6eb92 121 /**
jbradshaw 0:e4a10ed6eb92 122 * @brief Read the temperature from the device into a 16 bit value
jbradshaw 0:e4a10ed6eb92 123 * @param value pointer to a 16 bit short
jbradshaw 0:e4a10ed6eb92 124 */
jbradshaw 0:e4a10ed6eb92 125 int readTemperature(uint16_t *value);
jbradshaw 0:e4a10ed6eb92 126
jbradshaw 0:e4a10ed6eb92 127 /**
jbradshaw 0:e4a10ed6eb92 128 * @brief Read the THYST value from a specified device instance
jbradshaw 0:e4a10ed6eb92 129 * @param value 16-bit pointer of value to read into
jbradshaw 0:e4a10ed6eb92 130 */
jbradshaw 0:e4a10ed6eb92 131 int reg_THYST_Read(uint16_t *value);
jbradshaw 0:e4a10ed6eb92 132
jbradshaw 0:e4a10ed6eb92 133 /**
jbradshaw 0:e4a10ed6eb92 134 * @brief Write the THYST to a device instance
jbradshaw 0:e4a10ed6eb92 135 * @param value 16-bit value to write
jbradshaw 0:e4a10ed6eb92 136 */
jbradshaw 0:e4a10ed6eb92 137 int reg_THYST_Write(uint16_t value);
jbradshaw 0:e4a10ed6eb92 138
jbradshaw 0:e4a10ed6eb92 139 /**
jbradshaw 0:e4a10ed6eb92 140 * @brief Convert a raw temperature value into a float
jbradshaw 0:e4a10ed6eb92 141 * @param rawTemp raw temperature value to convert
jbradshaw 0:e4a10ed6eb92 142 * @return the convereted value in degrees C
jbradshaw 0:e4a10ed6eb92 143 */
jbradshaw 0:e4a10ed6eb92 144 float toCelsius(unsigned int rawTemp);
jbradshaw 0:e4a10ed6eb92 145
jbradshaw 0:e4a10ed6eb92 146 /**
jbradshaw 0:e4a10ed6eb92 147 * @brief Convert the passed in temperature in C to Fahrenheit
jbradshaw 0:e4a10ed6eb92 148 * @param temperatureC Temperature in C to convert
jbradshaw 0:e4a10ed6eb92 149 * @returns Returns the converted Fahrenheit value
jbradshaw 0:e4a10ed6eb92 150 */
jbradshaw 0:e4a10ed6eb92 151 float toFahrenheit(float temperatureC);
jbradshaw 0:e4a10ed6eb92 152
jbradshaw 0:e4a10ed6eb92 153 private:
jbradshaw 0:e4a10ed6eb92 154 /// I2C pointer
jbradshaw 0:e4a10ed6eb92 155 I2C *i2c;
jbradshaw 0:e4a10ed6eb92 156 /// Is this object the owner of the I2C object
jbradshaw 0:e4a10ed6eb92 157 bool isOwner;
jbradshaw 0:e4a10ed6eb92 158 /// Device slave address
jbradshaw 0:e4a10ed6eb92 159 int slaveAddress;
jbradshaw 0:e4a10ed6eb92 160 };
jbradshaw 0:e4a10ed6eb92 161
jbradshaw 0:e4a10ed6eb92 162 #endif /* __MAX30205_H_ */