SSGenericCmd.h

00001 /*******************************************************************************
00002  * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 
00034 #ifndef _SSGENERICCMD_H_
00035 #define _SSGENERICCMD_H_
00036 
00037 #include "mbed.h"
00038 #include "SensorComm.h"
00039 #include "USBSerial.h"
00040 #include "SSInterface.h"
00041 #include "queue.h"
00042 
00043 /*
00044  * Include this class to use "ss_read" and "ss_write" commands to read and write arbitrary
00045  * SmartSensor data:
00046  *
00047  * ss_write [cmdByte0] [cmdByte1] ... [cmdByteN]
00048  * ss_read [cmdByte0] [cmdByte1] ... [cmdByteN] <bytes_to_read_in_hex>
00049  *
00050  * Example: Read SS firmware version
00051  * "ss_read FF 03 4"
00052  *
00053  * Example: Set MAX30101 register 8 to 1F
00054  * "ss_write 40 03 8 1F"
00055  *
00056  * Example: Read MAX30101 register 1F
00057  * "ss_read 40 03 8 2"
00058  *
00059  */
00060 
00061 
00062 /**
00063  * @brief   SSMAX30101Comm Command handler class for communication with MAX30101 on SmartSensor board
00064  * @details
00065  */
00066 class SSGenericCmd: public SensorComm
00067 {
00068 public:
00069 
00070     /* PUBLIC FUNCTION DECLARATIONS */
00071     /**
00072     * @brief    SSMAX30101Comm constructor.
00073     *
00074     */
00075     SSGenericCmd(USBSerial* USB, SSInterface* ssInterface, DSInterface* dsInterface);
00076 
00077     /**
00078     * @brief    Parses DeviceStudio-style commands.
00079     * @details  Parses and executes commands. Prints return code to i/o device.
00080     * @returns true if sensor acted upon the command, false if command was unknown
00081     */
00082     bool parse_command(const char* cmd);
00083 
00084 private:
00085     typedef enum _cmd_state_t {
00086         ss_write,
00087         ss_read,
00088         NUM_CMDS,
00089     } cmd_state_t;
00090 
00091     /* PRIVATE VARIABLES */
00092     USBSerial *m_USB;
00093     SSInterface *ss_int;
00094     DSInterface *ds_int;
00095 
00096 };
00097 
00098 #endif /* _SSMAX30101COMM_H_ */