Device_Logging.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 _DEVICE_LOGGING_H_
00034 #define _DEVICE_LOGGING_H_
00035 
00036 #include "mbed.h"
00037 
00038 /**
00039 * @brief  Class that is used to store device logging parameters when logging to
00040 * flash or streaming usb
00041 */
00042 class Device_Logging {
00043 public:
00044   /**
00045   * @brief Check if logging is enabled for this device
00046   */
00047   int isLoggingEnabled(void);
00048   /**
00049   * @brief Returns the sample rate for the device, rate is in seconds
00050   */
00051   int getLoggingSampleRate(void);
00052   /**
00053   * @brief Initialize the sampling rate for the device
00054   * @param sampleRate Rate to log device output in seconds
00055   */
00056   void initStart(int sampleRate);
00057   /**
00058   * @brief Gets a value that represents when device needs to be sampled again,
00059   * used for datalogging and usb streaming
00060   */
00061   int getNextSampleTime(void);
00062   /**
00063   * @brief Sets a value that represents when device needs to be sampled again,
00064   * used for datalogging and usb streaming
00065   * @param time Time for next sample in seconds, time is relative to a timer
00066   */
00067   void setNextSampleTime(int time);
00068   /**
00069   * @brief Disables further datalog and streaming sampling for the device
00070   * @param time Time for next sample in seconds, time is relative to a timer
00071   */
00072   void stop(void);
00073 
00074 private:
00075   /// The sample rate in seconds
00076   int sampleRate;
00077   /// If logging is enabled or not
00078   int enabled;
00079   /// Bookkeeping var to keep track of the next sample time
00080   int nextSampleTime;
00081 };
00082 
00083 #endif /* _DEVICE_LOGGING_H_ */