Jerry Bradshaw / Mbed OS HSP_Release

This is a mbed 5.2 Release

Dependencies:   USBDevice

Fork of mbed-os-test by Jerry Bradshaw

HSP/LoggingService/Device_Logging.h@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
tewt

Who changed what in which revision?

UserRevisionLine numberNew 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 _DEVICE_LOGGING_H_
jbradshaw 0:e4a10ed6eb92 34 #define _DEVICE_LOGGING_H_
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 37
jbradshaw 0:e4a10ed6eb92 38 /**
jbradshaw 0:e4a10ed6eb92 39 * @brief Class that is used to store device logging parameters when logging to
jbradshaw 0:e4a10ed6eb92 40 * flash or streaming usb
jbradshaw 0:e4a10ed6eb92 41 */
jbradshaw 0:e4a10ed6eb92 42 class Device_Logging {
jbradshaw 0:e4a10ed6eb92 43 public:
jbradshaw 0:e4a10ed6eb92 44 /**
jbradshaw 0:e4a10ed6eb92 45 * @brief Check if logging is enabled for this device
jbradshaw 0:e4a10ed6eb92 46 */
jbradshaw 0:e4a10ed6eb92 47 int isLoggingEnabled(void);
jbradshaw 0:e4a10ed6eb92 48 /**
jbradshaw 0:e4a10ed6eb92 49 * @brief Returns the sample rate for the device, rate is in seconds
jbradshaw 0:e4a10ed6eb92 50 */
jbradshaw 0:e4a10ed6eb92 51 int getLoggingSampleRate(void);
jbradshaw 0:e4a10ed6eb92 52 /**
jbradshaw 0:e4a10ed6eb92 53 * @brief Initialize the sampling rate for the device
jbradshaw 0:e4a10ed6eb92 54 * @param sampleRate Rate to log device output in seconds
jbradshaw 0:e4a10ed6eb92 55 */
jbradshaw 0:e4a10ed6eb92 56 void initStart(int sampleRate);
jbradshaw 0:e4a10ed6eb92 57 /**
jbradshaw 0:e4a10ed6eb92 58 * @brief Gets a value that represents when device needs to be sampled again,
jbradshaw 0:e4a10ed6eb92 59 * used for datalogging and usb streaming
jbradshaw 0:e4a10ed6eb92 60 */
jbradshaw 0:e4a10ed6eb92 61 int getNextSampleTime(void);
jbradshaw 0:e4a10ed6eb92 62 /**
jbradshaw 0:e4a10ed6eb92 63 * @brief Sets a value that represents when device needs to be sampled again,
jbradshaw 0:e4a10ed6eb92 64 * used for datalogging and usb streaming
jbradshaw 0:e4a10ed6eb92 65 * @param time Time for next sample in seconds, time is relative to a timer
jbradshaw 0:e4a10ed6eb92 66 */
jbradshaw 0:e4a10ed6eb92 67 void setNextSampleTime(int time);
jbradshaw 0:e4a10ed6eb92 68 /**
jbradshaw 0:e4a10ed6eb92 69 * @brief Disables further datalog and streaming sampling for the device
jbradshaw 0:e4a10ed6eb92 70 * @param time Time for next sample in seconds, time is relative to a timer
jbradshaw 0:e4a10ed6eb92 71 */
jbradshaw 0:e4a10ed6eb92 72 void stop(void);
jbradshaw 0:e4a10ed6eb92 73
jbradshaw 0:e4a10ed6eb92 74 private:
jbradshaw 0:e4a10ed6eb92 75 /// The sample rate in seconds
jbradshaw 0:e4a10ed6eb92 76 int sampleRate;
jbradshaw 0:e4a10ed6eb92 77 /// If logging is enabled or not
jbradshaw 0:e4a10ed6eb92 78 int enabled;
jbradshaw 0:e4a10ed6eb92 79 /// Bookkeeping var to keep track of the next sample time
jbradshaw 0:e4a10ed6eb92 80 int nextSampleTime;
jbradshaw 0:e4a10ed6eb92 81 };
jbradshaw 0:e4a10ed6eb92 82
jbradshaw 0:e4a10ed6eb92 83 #endif /* _DEVICE_LOGGING_H_ */