Maxim Integrated
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/RpcServer/StringInOut.h@3:8e9b9f5818aa, 2017-04-25 (annotated)
- 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?
| User | Revision | Line number | New 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 _STRINGINOUT_H_ |
| jbradshaw | 0:e4a10ed6eb92 | 34 | #define _STRINGINOUT_H_ |
| jbradshaw | 0:e4a10ed6eb92 | 35 | |
| jbradshaw | 0:e4a10ed6eb92 | 36 | #include "mbed.h" |
| jbradshaw | 0:e4a10ed6eb92 | 37 | |
| jbradshaw | 0:e4a10ed6eb92 | 38 | /// indicates that a string up to a CRLF is being accumulated |
| jbradshaw | 0:e4a10ed6eb92 | 39 | #define GETLINE_WAITING 1 |
| jbradshaw | 0:e4a10ed6eb92 | 40 | /// indicates that a string is being processes |
| jbradshaw | 0:e4a10ed6eb92 | 41 | #define GETLINE_PROCESSING 2 |
| jbradshaw | 0:e4a10ed6eb92 | 42 | /// indicates that a CRLF string has been buffered and can be processed |
| jbradshaw | 0:e4a10ed6eb92 | 43 | #define GETLINE_DONE 3 |
| jbradshaw | 0:e4a10ed6eb92 | 44 | |
| jbradshaw | 0:e4a10ed6eb92 | 45 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 46 | * @brief Clear the incoming USB read fifo |
| jbradshaw | 0:e4a10ed6eb92 | 47 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 48 | void clearOutReadFifo(void); |
| jbradshaw | 0:e4a10ed6eb92 | 49 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 50 | * @brief Block until a character can be read from the USB |
| jbradshaw | 0:e4a10ed6eb92 | 51 | * @return the character read |
| jbradshaw | 0:e4a10ed6eb92 | 52 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 53 | char getch(void); |
| jbradshaw | 0:e4a10ed6eb92 | 54 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 55 | * @brief Place incoming USB characters into a fifo |
| jbradshaw | 0:e4a10ed6eb92 | 56 | * @param lineBuffer buffer to place the incoming characters |
| jbradshaw | 0:e4a10ed6eb92 | 57 | * @param bufferLength length of buffer |
| jbradshaw | 0:e4a10ed6eb92 | 58 | * @return GETLINE_WAITING if still waiting for a CRLF, GETLINE_DONE |
| jbradshaw | 0:e4a10ed6eb92 | 59 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 60 | int getLine(char *lineBuffer, int bufferLength); |
| jbradshaw | 0:e4a10ed6eb92 | 61 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 62 | * @brief Block until a fixed number of characters has been accumulated from the |
| jbradshaw | 0:e4a10ed6eb92 | 63 | * incoming USB |
| jbradshaw | 0:e4a10ed6eb92 | 64 | * @param lineBuffer buffer to place the incoming characters |
| jbradshaw | 0:e4a10ed6eb92 | 65 | * @param maxLength length of buffer |
| jbradshaw | 0:e4a10ed6eb92 | 66 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 67 | void getStringFixedLength(uint8_t *lineBuffer, int maxLength); |
| jbradshaw | 0:e4a10ed6eb92 | 68 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 69 | * @brief Output a string out the USB serial port |
| jbradshaw | 0:e4a10ed6eb92 | 70 | * @param str output this str the USB channel |
| jbradshaw | 0:e4a10ed6eb92 | 71 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 72 | int putStr(const char *str); |
| jbradshaw | 0:e4a10ed6eb92 | 73 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 74 | * @brief Place incoming USB characters into a fifo |
| jbradshaw | 0:e4a10ed6eb92 | 75 | * @param data_IN buffer of characters |
| jbradshaw | 0:e4a10ed6eb92 | 76 | * @param len length of data |
| jbradshaw | 0:e4a10ed6eb92 | 77 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 78 | int fifoIncomingChars(uint8_t data_IN[], unsigned int len); |
| jbradshaw | 0:e4a10ed6eb92 | 79 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 80 | * @brief Outut an array of bytes out the USB serial port |
| jbradshaw | 0:e4a10ed6eb92 | 81 | * @param data buffer to output |
| jbradshaw | 0:e4a10ed6eb92 | 82 | * @param length length of buffer |
| jbradshaw | 0:e4a10ed6eb92 | 83 | */ |
| jbradshaw | 0:e4a10ed6eb92 | 84 | int putBytes(uint8_t *data, uint32_t length); |
| jbradshaw | 0:e4a10ed6eb92 | 85 | /** |
| jbradshaw | 0:e4a10ed6eb92 | 86 | * @brief Outut 256 byte blocks out the USB serial using writeBlock bulk |
| jbradshaw | 0:e4a10ed6eb92 | 87 | * transfers |
| jbradshaw | 0:e4a10ed6eb92 | 88 | * @param data buffer of blocks to output |
| jbradshaw | 0:e4a10ed6eb92 | 89 | * @param length length of 256-byte blocks |
| jbradshaw | 0:e4a10ed6eb92 | 90 | */ |
| jbradshaw | 1:9490836294ea | 91 | //int putBytes256Block(uint8_t *data, int numberBlocks); |
| jbradshaw | 0:e4a10ed6eb92 | 92 | |
| jbradshaw | 0:e4a10ed6eb92 | 93 | #endif // _STRINGINOUT_H_ |