Maxim Integrated / Mbed OS MAXREFDES101_SOURCE

HSP Platform firmware evaluating ECG data and hearth rate over PPG data.

Dependencies:   max32630fthr Adafruit_FeatherOLED USBDevice

Interfaces/SensorComm/SmartSensorComm/SSGenericCmd/SSGenericCmd.h@1:f60eafbf009a, 2019-04-10 (annotated)

Committer:
gmehmet
Date:
Wed Apr 10 14:56:25 2019 +0300
Revision:
1:f60eafbf009a
upload from local

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gmehmet 1:f60eafbf009a 1 /*******************************************************************************
gmehmet 1:f60eafbf009a 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
gmehmet 1:f60eafbf009a 3 *
gmehmet 1:f60eafbf009a 4 * Permission is hereby granted, free of charge, to any person obtaining a
gmehmet 1:f60eafbf009a 5 * copy of this software and associated documentation files (the "Software"),
gmehmet 1:f60eafbf009a 6 * to deal in the Software without restriction, including without limitation
gmehmet 1:f60eafbf009a 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
gmehmet 1:f60eafbf009a 8 * and/or sell copies of the Software, and to permit persons to whom the
gmehmet 1:f60eafbf009a 9 * Software is furnished to do so, subject to the following conditions:
gmehmet 1:f60eafbf009a 10 *
gmehmet 1:f60eafbf009a 11 * The above copyright notice and this permission notice shall be included
gmehmet 1:f60eafbf009a 12 * in all copies or substantial portions of the Software.
gmehmet 1:f60eafbf009a 13 *
gmehmet 1:f60eafbf009a 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
gmehmet 1:f60eafbf009a 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gmehmet 1:f60eafbf009a 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
gmehmet 1:f60eafbf009a 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
gmehmet 1:f60eafbf009a 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
gmehmet 1:f60eafbf009a 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
gmehmet 1:f60eafbf009a 20 * OTHER DEALINGS IN THE SOFTWARE.
gmehmet 1:f60eafbf009a 21 *
gmehmet 1:f60eafbf009a 22 * Except as contained in this notice, the name of Maxim Integrated
gmehmet 1:f60eafbf009a 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
gmehmet 1:f60eafbf009a 24 * Products, Inc. Branding Policy.
gmehmet 1:f60eafbf009a 25 *
gmehmet 1:f60eafbf009a 26 * The mere transfer of this software does not imply any licenses
gmehmet 1:f60eafbf009a 27 * of trade secrets, proprietary technology, copyrights, patents,
gmehmet 1:f60eafbf009a 28 * trademarks, maskwork rights, or any other form of intellectual
gmehmet 1:f60eafbf009a 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
gmehmet 1:f60eafbf009a 30 * ownership rights.
gmehmet 1:f60eafbf009a 31 *******************************************************************************
gmehmet 1:f60eafbf009a 32 */
gmehmet 1:f60eafbf009a 33
gmehmet 1:f60eafbf009a 34 #ifndef _SSGENERICCMD_H_
gmehmet 1:f60eafbf009a 35 #define _SSGENERICCMD_H_
gmehmet 1:f60eafbf009a 36
gmehmet 1:f60eafbf009a 37 #include "mbed.h"
gmehmet 1:f60eafbf009a 38 #include "SensorComm.h"
gmehmet 1:f60eafbf009a 39 #include "USBSerial.h"
gmehmet 1:f60eafbf009a 40 #include "SSInterface.h"
gmehmet 1:f60eafbf009a 41 #include "queue.h"
gmehmet 1:f60eafbf009a 42
gmehmet 1:f60eafbf009a 43 /*
gmehmet 1:f60eafbf009a 44 * Include this class to use "ss_read" and "ss_write" commands to read and write arbitrary
gmehmet 1:f60eafbf009a 45 * SmartSensor data:
gmehmet 1:f60eafbf009a 46 *
gmehmet 1:f60eafbf009a 47 * ss_write [cmdByte0] [cmdByte1] ... [cmdByteN]
gmehmet 1:f60eafbf009a 48 * ss_read [cmdByte0] [cmdByte1] ... [cmdByteN] <bytes_to_read_in_hex>
gmehmet 1:f60eafbf009a 49 *
gmehmet 1:f60eafbf009a 50 * Example: Read SS firmware version
gmehmet 1:f60eafbf009a 51 * "ss_read FF 03 4"
gmehmet 1:f60eafbf009a 52 *
gmehmet 1:f60eafbf009a 53 * Example: Set MAX30101 register 8 to 1F
gmehmet 1:f60eafbf009a 54 * "ss_write 40 03 8 1F"
gmehmet 1:f60eafbf009a 55 *
gmehmet 1:f60eafbf009a 56 * Example: Read MAX30101 register 1F
gmehmet 1:f60eafbf009a 57 * "ss_read 40 03 8 2"
gmehmet 1:f60eafbf009a 58 *
gmehmet 1:f60eafbf009a 59 */
gmehmet 1:f60eafbf009a 60
gmehmet 1:f60eafbf009a 61
gmehmet 1:f60eafbf009a 62 /**
gmehmet 1:f60eafbf009a 63 * @brief SSMAX30101Comm Command handler class for communication with MAX30101 on SmartSensor board
gmehmet 1:f60eafbf009a 64 * @details
gmehmet 1:f60eafbf009a 65 */
gmehmet 1:f60eafbf009a 66 class SSGenericCmd: public SensorComm
gmehmet 1:f60eafbf009a 67 {
gmehmet 1:f60eafbf009a 68 public:
gmehmet 1:f60eafbf009a 69
gmehmet 1:f60eafbf009a 70 /* PUBLIC FUNCTION DECLARATIONS */
gmehmet 1:f60eafbf009a 71 /**
gmehmet 1:f60eafbf009a 72 * @brief SSMAX30101Comm constructor.
gmehmet 1:f60eafbf009a 73 *
gmehmet 1:f60eafbf009a 74 */
gmehmet 1:f60eafbf009a 75 SSGenericCmd(USBSerial* USB, SSInterface* ssInterface, DSInterface* dsInterface);
gmehmet 1:f60eafbf009a 76
gmehmet 1:f60eafbf009a 77 /**
gmehmet 1:f60eafbf009a 78 * @brief Parses DeviceStudio-style commands.
gmehmet 1:f60eafbf009a 79 * @details Parses and executes commands. Prints return code to i/o device.
gmehmet 1:f60eafbf009a 80 * @returns true if sensor acted upon the command, false if command was unknown
gmehmet 1:f60eafbf009a 81 */
gmehmet 1:f60eafbf009a 82 bool parse_command(const char* cmd);
gmehmet 1:f60eafbf009a 83
gmehmet 1:f60eafbf009a 84 private:
gmehmet 1:f60eafbf009a 85 typedef enum _cmd_state_t {
gmehmet 1:f60eafbf009a 86 ss_write,
gmehmet 1:f60eafbf009a 87 ss_read,
gmehmet 1:f60eafbf009a 88 NUM_CMDS,
gmehmet 1:f60eafbf009a 89 } cmd_state_t;
gmehmet 1:f60eafbf009a 90
gmehmet 1:f60eafbf009a 91 /* PRIVATE VARIABLES */
gmehmet 1:f60eafbf009a 92 USBSerial *m_USB;
gmehmet 1:f60eafbf009a 93 SSInterface *ss_int;
gmehmet 1:f60eafbf009a 94 DSInterface *ds_int;
gmehmet 1:f60eafbf009a 95
gmehmet 1:f60eafbf009a 96 };
gmehmet 1:f60eafbf009a 97
gmehmet 1:f60eafbf009a 98 #endif /* _SSMAX30101COMM_H_ */