Diff: nordic/nrf-sdk/ble/ble_sensorsim.h

Revision:

0:eff01767de02

Child:

37:c29c330d942c

diff -r 000000000000 -r eff01767de02 nordic/nrf-sdk/ble/ble_sensorsim.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/nordic/nrf-sdk/ble/ble_sensorsim.h	Wed Mar 26 14:38:17 2014 +0000
@@ -0,0 +1,66 @@
+/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
+ *
+ * The information contained herein is property of Nordic Semiconductor ASA.
+ * Terms and conditions of usage are described in detail in NORDIC
+ * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
+ *
+ * Licensees are granted free, non-transferable use of the information. NO
+ * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
+ * the file.
+ *
+ */
+
+/** @file
+ *
+ * @defgroup ble_sdk_lib_sensorsim Sensor Data Simulator
+ * @{
+ * @ingroup ble_sdk_lib
+ * @brief Functions for simulating sensor data.
+ *
+ * @details Currently only a triangular waveform simulator is implemented.
+ */
+
+#ifndef BLE_SENSORSIM_H__
+#define BLE_SENSORSIM_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "nordic_global.h"
+
+/**@brief Triangular waveform sensor simulator configuration. */
+typedef struct
+{
+    uint32_t min;                       /**< Minimum simulated value. */
+    uint32_t max;                       /**< Maximum simulated value. */
+    uint32_t incr;                      /**< Increment between each measurement. */
+    bool     start_at_max;              /**< TRUE is measurement is to start at the maximum value, FALSE if it is to start at the minimum. */
+} ble_sensorsim_cfg_t;
+
+/**@brief Triangular waveform sensor simulator state. */
+typedef struct
+{
+    uint32_t current_val;               /**< Current sensor value. */
+    bool     is_increasing;             /**< TRUE if the simulator is in increasing state, FALSE otherwise. */
+} ble_sensorsim_state_t;
+
+/**@brief Function for initializing a triangular waveform sensor simulator.
+ *
+ * @param[out]  p_state  Current state of simulator.
+ * @param[in]   p_cfg    Simulator configuration.
+ */
+void ble_sensorsim_init(ble_sensorsim_state_t *     p_state, 
+                        const ble_sensorsim_cfg_t * p_cfg);
+
+/**@brief Function for generating a simulated sensor measurement using a triangular waveform generator.
+ *
+ * @param[in,out]  p_state  Current state of simulator.
+ * @param[in]      p_cfg    Simulator configuration.
+ *
+ * @return         Simulator output.
+ */
+uint32_t ble_sensorsim_measure(ble_sensorsim_state_t *     p_state,
+                               const ble_sensorsim_cfg_t * p_cfg);
+
+#endif // BLE_SENSORSIM_H__
+
+/** @} */