diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/examples/proprietary_rf/gzll/gzp_desktop_emulator/mouse_sensor_emulator.h')
-rw-r--r-- | thirdparty/nRF5_SDK_15.0.0_a53641a/examples/proprietary_rf/gzll/gzp_desktop_emulator/mouse_sensor_emulator.h | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/proprietary_rf/gzll/gzp_desktop_emulator/mouse_sensor_emulator.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/proprietary_rf/gzll/gzp_desktop_emulator/mouse_sensor_emulator.h new file mode 100644 index 0000000..6d6c13a --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/proprietary_rf/gzll/gzp_desktop_emulator/mouse_sensor_emulator.h @@ -0,0 +1,145 @@ +/** + * Copyright (c) 2012 - 2018, Nordic Semiconductor ASA + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form, except as embedded into a Nordic + * Semiconductor ASA integrated circuit in a product or a software update for + * such product, must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. + * + * 3. Neither the name of Nordic Semiconductor ASA nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * 4. This software, with or without modification, must only be used with a + * Nordic Semiconductor ASA integrated circuit. + * + * 5. Any software provided in binary form under this license must not be reverse + * engineered, decompiled, modified and/or disassembled. + * + * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE + * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ +#ifndef __NRF_MOUSE_SENSOR_H +#define __NRF_MOUSE_SENSOR_H + +/** + * @file + * @brief Mouse Emulator API + */ + + +/** + * @defgroup gzp_mouse_emulator Mouse Emulator + * @{ + * @ingroup gzp_desktop_device_emulator_example + * @brief Emulates a mouse using one of the nRF51's timer peripherals. + */ + +#include "nrf.h" +#include <stdint.h> +#include <stdbool.h> +#include "nrf_gzllde_params.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @enum mouse_sensor_sample_period_t + * @brief Enumerator used for setting the mouse sensor sample period. + */ +typedef enum +{ + MOUSE_SENSOR_SAMPLE_PERIOD_4_MS, ///< Generate new mouse sample every 4 ms. + MOUSE_SENSOR_SAMPLE_PERIOD_8_MS, ///< Generate new mouse sample every 8 ms. +} mouse_sensor_sample_period_t; + +/** + * @brief Function for initializing the mouse sensor. + * + * @param sample_period specifies the mouse sensor sample period. + * + * @retval true If initialization succeeded. + * @retval false If initialization failed. + */ +bool mouse_sensor_init(mouse_sensor_sample_period_t sample_period); + +/** + * @brief Enable mouse sensor. + * + * When enabled, the mouse sensor will start generating mouse movement samples + * at the rate given by mouse_sensor_init(void). + */ +void mouse_sensor_enable(void); + +/** + * @brief Disable mouse sensor. + */ +void mouse_sensor_disable(void); + +/** + * @brief Function for polling if the mouse sensor + * has data available for readout. + * + * @retval true If there is data available for reading. + * @retval false If no data is available for reading. + * + * @sa mouse_sensor_read(void) + */ +bool mouse_sensor_data_is_ready(void); + +/** + * @brief Function for reading motion samples from the the mouse + * sensor. + * + * The mouse sensor will generate a new sample at a rate given by + * mouse_sensor_init(). If multiple samples are generated by the mouse sensor + * between each call of this function, the samples will be accumulated. + * Thus, the mouse packet returned by this function will tell the relative + * movement of the mouse since the previous time this function was called. + * The internal accumulator is cleared whenever the mouse sensor is read. + * + * @param out_mouse_packet returns an assembled mouse movement packet + * (no buttons) as specified in "nrfdvl_params.h" . + * + * The length of the mouse packet is given by NRFR_MOUSE_MOV_PACKET_LENGTH. + * + * @retval true If a new packet was written to out_mouse_packet *. + * @retval false If no new mouse data was available. + */ +bool mouse_sensor_read(uint8_t * out_mouse_packet); + +// lint -save -esym(522,mouse_sensor_new_sample_generated_cb) +/** + * @brief Callback function called when a new sample is generated + * by the mouse sensor. When the mouse sensor is enabled, this + * function will be called at a rate as specified by mouse_sensor_init(). + */ +void mouse_sensor_new_sample_generated_cb(void); +// lint -restore + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif |