Jerry Bradshaw / Mbed OS HSP_Release

This is a mbed 5.2 Release

Dependencies:   USBDevice

Fork of mbed-os-test by Jerry Bradshaw

HSP/RpcServer/Streaming.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 _STREAMING_H_
jbradshaw 0:e4a10ed6eb92 34 #define _STREAMING_H_
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 37
jbradshaw 0:e4a10ed6eb92 38 #define PACKET_LIS2DH 0x20
jbradshaw 0:e4a10ed6eb92 39
jbradshaw 0:e4a10ed6eb92 40 #define PACKET_MAX30205_TEMP_TOP 0x40
jbradshaw 0:e4a10ed6eb92 41 #define PACKET_MAX30205_TEMP_BOTTOM 0x50
jbradshaw 0:e4a10ed6eb92 42 #define PACKET_BMP280_PRESSURE 0x60
jbradshaw 0:e4a10ed6eb92 43 #define PACKET_LSM6DS3_ACCEL 0x70
jbradshaw 0:e4a10ed6eb92 44 #define PACKET_MAX30205_TEMP 0x80
jbradshaw 0:e4a10ed6eb92 45 #define PACKET_NOP 0x90
jbradshaw 0:e4a10ed6eb92 46
jbradshaw 0:e4a10ed6eb92 47 /**
jbradshaw 0:e4a10ed6eb92 48 * @brief Creates a packet that will be streamed via USB or saved into flash
jbradshaw 0:e4a10ed6eb92 49 * datalog memory
jbradshaw 0:e4a10ed6eb92 50 * @brief the packet created will be inserted into a fifo to be streamed at a
jbradshaw 0:e4a10ed6eb92 51 * later time
jbradshaw 0:e4a10ed6eb92 52 * @param id Streaming ID
jbradshaw 0:e4a10ed6eb92 53 * @param buffer Pointer to a uint32 array that contains the data to include in
jbradshaw 0:e4a10ed6eb92 54 * the packet
jbradshaw 0:e4a10ed6eb92 55 * @param number Number of elements in the buffer
jbradshaw 0:e4a10ed6eb92 56 */
jbradshaw 0:e4a10ed6eb92 57 void StreamPacketUint32(uint32_t id, uint32_t *buffer, uint32_t number);
jbradshaw 0:e4a10ed6eb92 58 /**
jbradshaw 0:e4a10ed6eb92 59 * @brief Insert a buffer into the out going fifo
jbradshaw 0:e4a10ed6eb92 60 * @param buffer Array of uint32 to send to the fifo
jbradshaw 0:e4a10ed6eb92 61 * @param len Length of the array
jbradshaw 0:e4a10ed6eb92 62 */
jbradshaw 0:e4a10ed6eb92 63 int StreamFifoUint32Array(uint32_t buffer[], uint32_t len);
jbradshaw 0:e4a10ed6eb92 64 /**
jbradshaw 0:e4a10ed6eb92 65 * @brief Insert a timestamp into the out going fifo
jbradshaw 0:e4a10ed6eb92 66 */
jbradshaw 0:e4a10ed6eb92 67 int StreamFifoTimeStamp(void);
jbradshaw 0:e4a10ed6eb92 68 /**
jbradshaw 0:e4a10ed6eb92 69 * @brief Insert a packet id into the out going fifo
jbradshaw 0:e4a10ed6eb92 70 * @param id The uint32 packet id
jbradshaw 0:e4a10ed6eb92 71 */
jbradshaw 0:e4a10ed6eb92 72 int StreamFifoId(uint32_t id);
jbradshaw 0:e4a10ed6eb92 73 /**
jbradshaw 0:e4a10ed6eb92 74 * @brief Return a value that indicates if the system is streaming data
jbradshaw 0:e4a10ed6eb92 75 * @returns Returns a one or zero value
jbradshaw 0:e4a10ed6eb92 76 */
jbradshaw 0:e4a10ed6eb92 77 uint8_t IsStreaming(void);
jbradshaw 0:e4a10ed6eb92 78 /**
jbradshaw 0:e4a10ed6eb92 79 * @brief Set a flag to indicate if streaming is enabled
jbradshaw 0:e4a10ed6eb92 80 * @param state A one or zero value
jbradshaw 0:e4a10ed6eb92 81 */
jbradshaw 0:e4a10ed6eb92 82 void SetStreaming(uint8_t state);
jbradshaw 0:e4a10ed6eb92 83 /**
jbradshaw 0:e4a10ed6eb92 84 * @brief Set a flag to indicate if datalogging is enabled
jbradshaw 0:e4a10ed6eb92 85 * @param state A one or zero value
jbradshaw 0:e4a10ed6eb92 86 */
jbradshaw 0:e4a10ed6eb92 87 void SetDataLoggingStream(uint8_t state);
jbradshaw 0:e4a10ed6eb92 88 /**
jbradshaw 0:e4a10ed6eb92 89 * @brief Insert a length value into the out going fifo
jbradshaw 0:e4a10ed6eb92 90 * @param length A uint32 number representing a length
jbradshaw 0:e4a10ed6eb92 91 */
jbradshaw 0:e4a10ed6eb92 92 int StreamFifoLength(uint32_t length);
jbradshaw 0:e4a10ed6eb92 93
jbradshaw 0:e4a10ed6eb92 94 #endif // _STREAMING_H_