Streaming.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 _STREAMING_H_
00034 #define _STREAMING_H_
00035 
00036 #include "mbed.h"
00037 
00038 #define PACKET_LIS2DH 0x20
00039 
00040 #define PACKET_MAX30205_TEMP_TOP 0x40
00041 #define PACKET_MAX30205_TEMP_BOTTOM 0x50
00042 #define PACKET_BMP280_PRESSURE 0x60
00043 #define PACKET_LSM6DS3_ACCEL 0x70
00044 #define PACKET_MAX30205_TEMP 0x80
00045 #define PACKET_NOP 0x90
00046 
00047 /**
00048 * @brief Creates a packet that will be streamed via USB or saved into flash
00049 * datalog memory
00050 * @brief the packet created will be inserted into a fifo to be streamed at a
00051 * later time
00052 * @param id Streaming ID
00053 * @param buffer Pointer to a uint32 array that contains the data to include in
00054 * the packet
00055 * @param number Number of elements in the buffer
00056 */
00057 void StreamPacketUint32(uint32_t id, uint32_t *buffer, uint32_t number);
00058 /**
00059 * @brief Insert a buffer into the out going fifo
00060 * @param buffer Array of uint32 to send to the fifo
00061 * @param len Length of the array
00062 */
00063 int StreamFifoUint32Array(uint32_t buffer[], uint32_t len);
00064 /**
00065 * @brief Insert a timestamp into the out going fifo
00066 */
00067 int StreamFifoTimeStamp(void);
00068 /**
00069 * @brief Insert a packet id into the out going fifo
00070 * @param id The uint32 packet id
00071 */
00072 int StreamFifoId(uint32_t id);
00073 /**
00074 * @brief Return a value that indicates if the system is streaming data
00075 * @returns Returns a one or zero value
00076 */
00077 uint8_t IsStreaming(void);
00078 /**
00079 * @brief Set a flag to indicate if streaming is enabled
00080 * @param state A one or zero value
00081 */
00082 void SetStreaming(uint8_t state);
00083 /**
00084 * @brief Set a flag to indicate if datalogging is enabled
00085 * @param state A one or zero value
00086 */
00087 void SetDataLoggingStream(uint8_t state);
00088 /**
00089 * @brief Insert a length value into the out going fifo
00090 * @param length A uint32 number representing a length
00091 */
00092 int StreamFifoLength(uint32_t length);
00093 
00094 #endif // _STREAMING_H_