Jinu Andrews / nRF51

lib/ble/inc/ble_sensorsim.h@0:6ba9b94b8997, 2017-02-09 (annotated)

Committer:
jinu
Date:
Thu Feb 09 06:08:17 2017 +0000
Revision:
0:6ba9b94b8997
NRF51 serialization libraries for mDot

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jinu 0:6ba9b94b8997 1 /* Copyright (c) Nordic Semiconductor ASA
jinu 0:6ba9b94b8997 2 * All rights reserved.
jinu 0:6ba9b94b8997 3 *
jinu 0:6ba9b94b8997 4 * Redistribution and use in source and binary forms, with or without modification,
jinu 0:6ba9b94b8997 5 * are permitted provided that the following conditions are met:
jinu 0:6ba9b94b8997 6 *
jinu 0:6ba9b94b8997 7 * 1. Redistributions of source code must retain the above copyright notice, this
jinu 0:6ba9b94b8997 8 * list of conditions and the following disclaimer.
jinu 0:6ba9b94b8997 9 *
jinu 0:6ba9b94b8997 10 * 2. Redistributions in binary form must reproduce the above copyright notice, this
jinu 0:6ba9b94b8997 11 * list of conditions and the following disclaimer in the documentation and/or
jinu 0:6ba9b94b8997 12 * other materials provided with the distribution.
jinu 0:6ba9b94b8997 13 *
jinu 0:6ba9b94b8997 14 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
jinu 0:6ba9b94b8997 15 * contributors to this software may be used to endorse or promote products
jinu 0:6ba9b94b8997 16 * derived from this software without specific prior written permission.
jinu 0:6ba9b94b8997 17 *
jinu 0:6ba9b94b8997 18 * 4. This software must only be used in a processor manufactured by Nordic
jinu 0:6ba9b94b8997 19 * Semiconductor ASA, or in a processor manufactured by a third party that
jinu 0:6ba9b94b8997 20 * is used in combination with a processor manufactured by Nordic Semiconductor.
jinu 0:6ba9b94b8997 21 *
jinu 0:6ba9b94b8997 22 *
jinu 0:6ba9b94b8997 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
jinu 0:6ba9b94b8997 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
jinu 0:6ba9b94b8997 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
jinu 0:6ba9b94b8997 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
jinu 0:6ba9b94b8997 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jinu 0:6ba9b94b8997 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
jinu 0:6ba9b94b8997 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
jinu 0:6ba9b94b8997 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
jinu 0:6ba9b94b8997 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
jinu 0:6ba9b94b8997 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jinu 0:6ba9b94b8997 33 */
jinu 0:6ba9b94b8997 34
jinu 0:6ba9b94b8997 35 /** @file
jinu 0:6ba9b94b8997 36 *
jinu 0:6ba9b94b8997 37 * @defgroup ble_sdk_lib_sensorsim Sensor Data Simulator
jinu 0:6ba9b94b8997 38 * @{
jinu 0:6ba9b94b8997 39 * @ingroup ble_sdk_lib
jinu 0:6ba9b94b8997 40 * @brief Functions for simulating sensor data.
jinu 0:6ba9b94b8997 41 *
jinu 0:6ba9b94b8997 42 * @details Currently only a triangular waveform simulator is implemented.
jinu 0:6ba9b94b8997 43 */
jinu 0:6ba9b94b8997 44
jinu 0:6ba9b94b8997 45 #ifndef BLE_SENSORSIM_H__
jinu 0:6ba9b94b8997 46 #define BLE_SENSORSIM_H__
jinu 0:6ba9b94b8997 47
jinu 0:6ba9b94b8997 48 #include <stdint.h>
jinu 0:6ba9b94b8997 49 #include <stdbool.h>
jinu 0:6ba9b94b8997 50
jinu 0:6ba9b94b8997 51 /**@brief Triangular waveform sensor simulator configuration. */
jinu 0:6ba9b94b8997 52 typedef struct
jinu 0:6ba9b94b8997 53 {
jinu 0:6ba9b94b8997 54 uint32_t min; /**< Minimum simulated value. */
jinu 0:6ba9b94b8997 55 uint32_t max; /**< Maximum simulated value. */
jinu 0:6ba9b94b8997 56 uint32_t incr; /**< Increment between each measurement. */
jinu 0:6ba9b94b8997 57 bool start_at_max; /**< TRUE is measurement is to start at the maximum value, FALSE if it is to start at the minimum. */
jinu 0:6ba9b94b8997 58 } ble_sensorsim_cfg_t;
jinu 0:6ba9b94b8997 59
jinu 0:6ba9b94b8997 60 /**@brief Triangular waveform sensor simulator state. */
jinu 0:6ba9b94b8997 61 typedef struct
jinu 0:6ba9b94b8997 62 {
jinu 0:6ba9b94b8997 63 uint32_t current_val; /**< Current sensor value. */
jinu 0:6ba9b94b8997 64 bool is_increasing; /**< TRUE if the simulator is in increasing state, FALSE otherwise. */
jinu 0:6ba9b94b8997 65 } ble_sensorsim_state_t;
jinu 0:6ba9b94b8997 66
jinu 0:6ba9b94b8997 67 /**@brief Function for initializing a triangular waveform sensor simulator.
jinu 0:6ba9b94b8997 68 *
jinu 0:6ba9b94b8997 69 * @param[out] p_state Current state of simulator.
jinu 0:6ba9b94b8997 70 * @param[in] p_cfg Simulator configuration.
jinu 0:6ba9b94b8997 71 */
jinu 0:6ba9b94b8997 72 void ble_sensorsim_init(ble_sensorsim_state_t * p_state,
jinu 0:6ba9b94b8997 73 const ble_sensorsim_cfg_t * p_cfg);
jinu 0:6ba9b94b8997 74
jinu 0:6ba9b94b8997 75 /**@brief Function for generating a simulated sensor measurement using a triangular waveform generator.
jinu 0:6ba9b94b8997 76 *
jinu 0:6ba9b94b8997 77 * @param[in,out] p_state Current state of simulator.
jinu 0:6ba9b94b8997 78 * @param[in] p_cfg Simulator configuration.
jinu 0:6ba9b94b8997 79 *
jinu 0:6ba9b94b8997 80 * @return Simulator output.
jinu 0:6ba9b94b8997 81 */
jinu 0:6ba9b94b8997 82 uint32_t ble_sensorsim_measure(ble_sensorsim_state_t * p_state,
jinu 0:6ba9b94b8997 83 const ble_sensorsim_cfg_t * p_cfg);
jinu 0:6ba9b94b8997 84
jinu 0:6ba9b94b8997 85 #endif // BLE_SENSORSIM_H__
jinu 0:6ba9b94b8997 86
jinu 0:6ba9b94b8997 87 /** @} */
jinu 0:6ba9b94b8997 88