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/LoggingService/Logging.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 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 34 #include "RpcServer.h"
jbradshaw 0:e4a10ed6eb92 35 #include "Logging.h"
jbradshaw 0:e4a10ed6eb92 36 #include "S25FS512.h"
jbradshaw 0:e4a10ed6eb92 37 #include "Peripherals.h"
jbradshaw 0:e4a10ed6eb92 38
jbradshaw 0:e4a10ed6eb92 39 /// length of flash page as dictated by the device
jbradshaw 0:e4a10ed6eb92 40 #define LENGTH_OF_FLASH_PAGE 256 // length of flash page in bytes
jbradshaw 0:e4a10ed6eb92 41 /// size in bytes of the external flash device on the HSP platform
jbradshaw 0:e4a10ed6eb92 42 #define SIZE_OF_EXTERNAL_FLASH \
jbradshaw 0:e4a10ed6eb92 43 (16777216 / 2) // length of external flash in bytes
jbradshaw 0:e4a10ed6eb92 44 /// start page of where the mission is defined
jbradshaw 0:e4a10ed6eb92 45 #define MISSION_DEFINITION_START_PAGE 0x00
jbradshaw 0:e4a10ed6eb92 46 /// end page of the mission
jbradshaw 0:e4a10ed6eb92 47 #define MISSION_DEFINITION_END_PAGE 0x0F
jbradshaw 0:e4a10ed6eb92 48 /// page of where the logging data starts
jbradshaw 0:e4a10ed6eb92 49 #define LOGGING_START_PAGE 0x12
jbradshaw 0:e4a10ed6eb92 50 /// the last logging page
jbradshaw 0:e4a10ed6eb92 51 #define LOGGING_END_PAGE (SIZE_OF_EXTERNAL_FLASH / LENGTH_OF_FLASH_PAGE)
jbradshaw 0:e4a10ed6eb92 52
jbradshaw 0:e4a10ed6eb92 53 /// static flag to know if logging was started via RPC
jbradshaw 0:e4a10ed6eb92 54 static bool startLoggingViaRpc = false;
jbradshaw 0:e4a10ed6eb92 55
jbradshaw 0:e4a10ed6eb92 56 /**
jbradshaw 0:e4a10ed6eb92 57 * @brief This will read the mission location and if there is something valid,
jbradshaw 0:e4a10ed6eb92 58 * then run the Logging_ProcessMissionCmds()
jbradshaw 0:e4a10ed6eb92 59 * @param cmdBuffer buffer
jbradshaw 0:e4a10ed6eb92 60 */
jbradshaw 0:e4a10ed6eb92 61 uint32_t Logging_IsMissionDefined(uint8_t *cmdBuffer) {
jbradshaw 0:e4a10ed6eb92 62 uint32_t valid = 1;
jbradshaw 0:e4a10ed6eb92 63 if ((cmdBuffer[0] == 0xFF) || (cmdBuffer[0] == 0x0))
jbradshaw 0:e4a10ed6eb92 64 valid = 0;
jbradshaw 0:e4a10ed6eb92 65 return valid;
jbradshaw 0:e4a10ed6eb92 66 }
jbradshaw 0:e4a10ed6eb92 67
jbradshaw 0:e4a10ed6eb92 68 /**
jbradshaw 0:e4a10ed6eb92 69 * @brief Read the mission from flash and place in buffer
jbradshaw 0:e4a10ed6eb92 70 * @param buffer pointer to byte array that will contain the read results
jbradshaw 0:e4a10ed6eb92 71 */
jbradshaw 0:e4a10ed6eb92 72 int8_t Logging_ReadMissionFromFlash(uint8_t *buffer) {
jbradshaw 0:e4a10ed6eb92 73 return Peripherals::s25FS512()->readPages_Helper(
jbradshaw 0:e4a10ed6eb92 74 MISSION_DEFINITION_START_PAGE, MISSION_DEFINITION_END_PAGE, buffer, 0);
jbradshaw 0:e4a10ed6eb92 75 }
jbradshaw 0:e4a10ed6eb92 76
jbradshaw 0:e4a10ed6eb92 77 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 78 // return the page where mission is defined, Mission specific
jbradshaw 0:e4a10ed6eb92 79 uint32_t Logging_GetMissionStartPage(void) {
jbradshaw 0:e4a10ed6eb92 80 return MISSION_DEFINITION_START_PAGE;
jbradshaw 0:e4a10ed6eb92 81 }
jbradshaw 0:e4a10ed6eb92 82
jbradshaw 0:e4a10ed6eb92 83 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 84 // return the page where the mission definition ends, Mission specific
jbradshaw 0:e4a10ed6eb92 85 uint32_t Logging_GetMissionEndPage(void) { return MISSION_DEFINITION_END_PAGE; }
jbradshaw 0:e4a10ed6eb92 86
jbradshaw 0:e4a10ed6eb92 87 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 88 // Returns the location where the Writing can start from, for data logging...
jbradshaw 0:e4a10ed6eb92 89 uint32_t Logging_GetLoggingStartPage(void) { return LOGGING_START_PAGE; }
jbradshaw 0:e4a10ed6eb92 90
jbradshaw 0:e4a10ed6eb92 91 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 92 // Returns the end location available where the Flash ends essentially.... for
jbradshaw 0:e4a10ed6eb92 93 // data logging.
jbradshaw 0:e4a10ed6eb92 94 uint32_t Logging_GetLoggingEndPage(void) { return LOGGING_END_PAGE; }
jbradshaw 0:e4a10ed6eb92 95
jbradshaw 0:e4a10ed6eb92 96 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 97 void Logging_SetStart(bool state) { startLoggingViaRpc = state; }
jbradshaw 0:e4a10ed6eb92 98
jbradshaw 0:e4a10ed6eb92 99 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 100 bool Logging_GetStart(void) { return startLoggingViaRpc; }
jbradshaw 0:e4a10ed6eb92 101
jbradshaw 0:e4a10ed6eb92 102 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 103 // for debugging... always say that usb is not connected... for easy bench
jbradshaw 0:e4a10ed6eb92 104 // testing
jbradshaw 0:e4a10ed6eb92 105 uint32_t Usb_IsConnected(void) { return 0; }