DataLoggingService.h

00001 /*******************************************************************************
00002  * Copyright (C) 2016 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 #ifndef _LOGGINGSERVICE_H_
00034 #define _LOGGINGSERVICE_H_
00035 
00036 #include "mbed.h"
00037 
00038 /// types of logging
00039 typedef enum {
00040   /// do not log
00041   eLogToNothing,
00042   /// log to USB
00043   eLogtoUsb,
00044   /// Log to external flash memory
00045   eLogToFlash
00046 } eLoggingOutput;
00047 
00048 /// types of logging
00049 typedef enum {
00050   eTriggerLog_NULL,
00051   eTriggerLog_RPC_USB,
00052   eTriggerLog_RPC_FLASH,
00053   eTriggerLog_BUTTON,
00054   eTriggerLog_BLE,
00055 } eLoggingTrigger;
00056 
00057 /// extern that indicates the hardware button on the HSP was pressed
00058 extern uint32_t buttonTrigger;
00059 
00060 void LoggingService_Init(void);
00061 
00062 /**
00063 * @brief This routine checks to see if a USB or flash logging action needs to be
00064 * taken
00065 *           The routine checks for a start condition via button press, USB
00066 * command, or BLE command
00067 *           Once one of these start conditions is present, the logging begins
00068 * until stopped or memory is full
00069 * @return 1 if successful, 0 if error or logging was aborted and no logging
00070 * occurred
00071 */
00072 uint8_t LoggingService_ServiceRoutine(void);
00073 /**
00074 * @brief This is called via one of the RPC USB functions to set start conditons
00075 * to start streaming USB
00076 */
00077 void LoggingService_StartLoggingUsb(void);
00078 /**
00079 * @brief This is called via one of the RPC USB functions to set start conditons
00080 * to start logging to flash
00081 */
00082 void LoggingService_StartLoggingFlash(void);
00083 
00084 #endif /* _LOGGINGSERVICE_H_ */