Maxim Integrated / MAX30001EVSYSKIT

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.

HSP/RpcServer/Streaming.h@1:957e5bad16c2, 2018-06-27 (annotated)

Committer:
Emre.Eken
Date:
Wed Jun 27 14:17:34 2018 +0300
Revision:
1:957e5bad16c2
first rev

Who changed what in which revision?

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