Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/RpcServer/Streaming.h@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darienf 20:6d2af70c92ab 1 /*******************************************************************************
darienf 20:6d2af70c92ab 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
darienf 20:6d2af70c92ab 3 *
darienf 20:6d2af70c92ab 4 * Permission is hereby granted, free of charge, to any person obtaining a
darienf 20:6d2af70c92ab 5 * copy of this software and associated documentation files (the "Software"),
darienf 20:6d2af70c92ab 6 * to deal in the Software without restriction, including without limitation
darienf 20:6d2af70c92ab 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
darienf 20:6d2af70c92ab 8 * and/or sell copies of the Software, and to permit persons to whom the
darienf 20:6d2af70c92ab 9 * Software is furnished to do so, subject to the following conditions:
darienf 20:6d2af70c92ab 10 *
darienf 20:6d2af70c92ab 11 * The above copyright notice and this permission notice shall be included
darienf 20:6d2af70c92ab 12 * in all copies or substantial portions of the Software.
darienf 20:6d2af70c92ab 13 *
darienf 20:6d2af70c92ab 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
darienf 20:6d2af70c92ab 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
darienf 20:6d2af70c92ab 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
darienf 20:6d2af70c92ab 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
darienf 20:6d2af70c92ab 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
darienf 20:6d2af70c92ab 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
darienf 20:6d2af70c92ab 20 * OTHER DEALINGS IN THE SOFTWARE.
darienf 20:6d2af70c92ab 21 *
darienf 20:6d2af70c92ab 22 * Except as contained in this notice, the name of Maxim Integrated
darienf 20:6d2af70c92ab 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
darienf 20:6d2af70c92ab 24 * Products, Inc. Branding Policy.
darienf 20:6d2af70c92ab 25 *
darienf 20:6d2af70c92ab 26 * The mere transfer of this software does not imply any licenses
darienf 20:6d2af70c92ab 27 * of trade secrets, proprietary technology, copyrights, patents,
darienf 20:6d2af70c92ab 28 * trademarks, maskwork rights, or any other form of intellectual
darienf 20:6d2af70c92ab 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
darienf 20:6d2af70c92ab 30 * ownership rights.
darienf 20:6d2af70c92ab 31 *******************************************************************************
darienf 20:6d2af70c92ab 32 */
darienf 20:6d2af70c92ab 33 #ifndef _STREAMING_H_
darienf 20:6d2af70c92ab 34 #define _STREAMING_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37
darienf 20:6d2af70c92ab 38 #define PACKET_LIS2DH 0x20
darienf 20:6d2af70c92ab 39
darienf 20:6d2af70c92ab 40 #define PACKET_MAX30205_TEMP_TOP 0x40
darienf 20:6d2af70c92ab 41 #define PACKET_MAX30205_TEMP_BOTTOM 0x50
darienf 20:6d2af70c92ab 42 #define PACKET_BMP280_PRESSURE 0x60
darienf 20:6d2af70c92ab 43 #define PACKET_LSM6DS3_ACCEL 0x70
darienf 20:6d2af70c92ab 44 #define PACKET_MAX30205_TEMP 0x80
darienf 20:6d2af70c92ab 45 #define PACKET_NOP 0x90
darienf 20:6d2af70c92ab 46
darienf 20:6d2af70c92ab 47 /**
darienf 20:6d2af70c92ab 48 * @brief Creates a packet that will be streamed via USB or saved into flash
darienf 20:6d2af70c92ab 49 * datalog memory
darienf 20:6d2af70c92ab 50 * @brief the packet created will be inserted into a fifo to be streamed at a
darienf 20:6d2af70c92ab 51 * later time
darienf 20:6d2af70c92ab 52 * @param id Streaming ID
darienf 20:6d2af70c92ab 53 * @param buffer Pointer to a uint32 array that contains the data to include in
darienf 20:6d2af70c92ab 54 * the packet
darienf 20:6d2af70c92ab 55 * @param number Number of elements in the buffer
darienf 20:6d2af70c92ab 56 */
darienf 20:6d2af70c92ab 57 void StreamPacketUint32(uint32_t id, uint32_t *buffer, uint32_t number);
darienf 20:6d2af70c92ab 58 /**
darienf 20:6d2af70c92ab 59 * @brief Insert a buffer into the out going fifo
darienf 20:6d2af70c92ab 60 * @param buffer Array of uint32 to send to the fifo
darienf 20:6d2af70c92ab 61 * @param len Length of the array
darienf 20:6d2af70c92ab 62 */
darienf 20:6d2af70c92ab 63 int StreamFifoUint32Array(uint32_t buffer[], uint32_t len);
darienf 20:6d2af70c92ab 64 /**
darienf 20:6d2af70c92ab 65 * @brief Insert a timestamp into the out going fifo
darienf 20:6d2af70c92ab 66 */
darienf 20:6d2af70c92ab 67 int StreamFifoTimeStamp(void);
darienf 20:6d2af70c92ab 68 /**
darienf 20:6d2af70c92ab 69 * @brief Insert a packet id into the out going fifo
darienf 20:6d2af70c92ab 70 * @param id The uint32 packet id
darienf 20:6d2af70c92ab 71 */
darienf 20:6d2af70c92ab 72 int StreamFifoId(uint32_t id);
darienf 20:6d2af70c92ab 73 /**
darienf 20:6d2af70c92ab 74 * @brief Return a value that indicates if the system is streaming data
darienf 20:6d2af70c92ab 75 * @returns Returns a one or zero value
darienf 20:6d2af70c92ab 76 */
darienf 20:6d2af70c92ab 77 uint8_t IsStreaming(void);
darienf 20:6d2af70c92ab 78 /**
darienf 20:6d2af70c92ab 79 * @brief Set a flag to indicate if streaming is enabled
darienf 20:6d2af70c92ab 80 * @param state A one or zero value
darienf 20:6d2af70c92ab 81 */
darienf 20:6d2af70c92ab 82 void SetStreaming(uint8_t state);
darienf 20:6d2af70c92ab 83 /**
darienf 20:6d2af70c92ab 84 * @brief Set a flag to indicate if datalogging is enabled
darienf 20:6d2af70c92ab 85 * @param state A one or zero value
darienf 20:6d2af70c92ab 86 */
darienf 20:6d2af70c92ab 87 void SetDataLoggingStream(uint8_t state);
darienf 20:6d2af70c92ab 88 /**
darienf 20:6d2af70c92ab 89 * @brief Insert a length value into the out going fifo
darienf 20:6d2af70c92ab 90 * @param length A uint32 number representing a length
darienf 20:6d2af70c92ab 91 */
darienf 20:6d2af70c92ab 92 int StreamFifoLength(uint32_t length);
darienf 20:6d2af70c92ab 93
darienf 20:6d2af70c92ab 94 #endif // _STREAMING_H_