Darien Figueroa / Mbed OS Final_Program

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   USBDevice

HSP/LoggingService/Device_Logging.h@0:832122ce6748, 2021-04-07 (annotated)

Committer:
darienf
Date:
Wed Apr 07 22:37:59 2021 +0000
Revision:
0:832122ce6748
painnie

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darienf 0:832122ce6748 1 /*******************************************************************************
darienf 0:832122ce6748 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
darienf 0:832122ce6748 3 *
darienf 0:832122ce6748 4 * Permission is hereby granted, free of charge, to any person obtaining a
darienf 0:832122ce6748 5 * copy of this software and associated documentation files (the "Software"),
darienf 0:832122ce6748 6 * to deal in the Software without restriction, including without limitation
darienf 0:832122ce6748 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
darienf 0:832122ce6748 8 * and/or sell copies of the Software, and to permit persons to whom the
darienf 0:832122ce6748 9 * Software is furnished to do so, subject to the following conditions:
darienf 0:832122ce6748 10 *
darienf 0:832122ce6748 11 * The above copyright notice and this permission notice shall be included
darienf 0:832122ce6748 12 * in all copies or substantial portions of the Software.
darienf 0:832122ce6748 13 *
darienf 0:832122ce6748 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
darienf 0:832122ce6748 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
darienf 0:832122ce6748 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
darienf 0:832122ce6748 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
darienf 0:832122ce6748 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
darienf 0:832122ce6748 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
darienf 0:832122ce6748 20 * OTHER DEALINGS IN THE SOFTWARE.
darienf 0:832122ce6748 21 *
darienf 0:832122ce6748 22 * Except as contained in this notice, the name of Maxim Integrated
darienf 0:832122ce6748 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
darienf 0:832122ce6748 24 * Products, Inc. Branding Policy.
darienf 0:832122ce6748 25 *
darienf 0:832122ce6748 26 * The mere transfer of this software does not imply any licenses
darienf 0:832122ce6748 27 * of trade secrets, proprietary technology, copyrights, patents,
darienf 0:832122ce6748 28 * trademarks, maskwork rights, or any other form of intellectual
darienf 0:832122ce6748 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
darienf 0:832122ce6748 30 * ownership rights.
darienf 0:832122ce6748 31 *******************************************************************************
darienf 0:832122ce6748 32 */
darienf 0:832122ce6748 33 #ifndef _DEVICE_LOGGING_H_
darienf 0:832122ce6748 34 #define _DEVICE_LOGGING_H_
darienf 0:832122ce6748 35
darienf 0:832122ce6748 36 #include "mbed.h"
darienf 0:832122ce6748 37
darienf 0:832122ce6748 38 /**
darienf 0:832122ce6748 39 * @brief Class that is used to store device logging parameters when logging to
darienf 0:832122ce6748 40 * flash or streaming usb
darienf 0:832122ce6748 41 */
darienf 0:832122ce6748 42 class Device_Logging {
darienf 0:832122ce6748 43 public:
darienf 0:832122ce6748 44 /**
darienf 0:832122ce6748 45 * @brief Check if logging is enabled for this device
darienf 0:832122ce6748 46 */
darienf 0:832122ce6748 47 int isLoggingEnabled(void);
darienf 0:832122ce6748 48 /**
darienf 0:832122ce6748 49 * @brief Returns the sample rate for the device, rate is in seconds
darienf 0:832122ce6748 50 */
darienf 0:832122ce6748 51 int getLoggingSampleRate(void);
darienf 0:832122ce6748 52 /**
darienf 0:832122ce6748 53 * @brief Initialize the sampling rate for the device
darienf 0:832122ce6748 54 * @param sampleRate Rate to log device output in seconds
darienf 0:832122ce6748 55 */
darienf 0:832122ce6748 56 void initStart(int sampleRate);
darienf 0:832122ce6748 57 /**
darienf 0:832122ce6748 58 * @brief Gets a value that represents when device needs to be sampled again,
darienf 0:832122ce6748 59 * used for datalogging and usb streaming
darienf 0:832122ce6748 60 */
darienf 0:832122ce6748 61 int getNextSampleTime(void);
darienf 0:832122ce6748 62 /**
darienf 0:832122ce6748 63 * @brief Sets a value that represents when device needs to be sampled again,
darienf 0:832122ce6748 64 * used for datalogging and usb streaming
darienf 0:832122ce6748 65 * @param time Time for next sample in seconds, time is relative to a timer
darienf 0:832122ce6748 66 */
darienf 0:832122ce6748 67 void setNextSampleTime(int time);
darienf 0:832122ce6748 68 /**
darienf 0:832122ce6748 69 * @brief Disables further datalog and streaming sampling for the device
darienf 0:832122ce6748 70 * @param time Time for next sample in seconds, time is relative to a timer
darienf 0:832122ce6748 71 */
darienf 0:832122ce6748 72 void stop(void);
darienf 0:832122ce6748 73
darienf 0:832122ce6748 74 private:
darienf 0:832122ce6748 75 /// The sample rate in seconds
darienf 0:832122ce6748 76 int sampleRate;
darienf 0:832122ce6748 77 /// If logging is enabled or not
darienf 0:832122ce6748 78 int enabled;
darienf 0:832122ce6748 79 /// Bookkeeping var to keep track of the next sample time
darienf 0:832122ce6748 80 int nextSampleTime;
darienf 0:832122ce6748 81 };
darienf 0:832122ce6748 82
darienf 0:832122ce6748 83 #endif /* _DEVICE_LOGGING_H_ */