diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_state_indicator/ant_state_indicator.h')
| -rw-r--r-- | thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_state_indicator/ant_state_indicator.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_state_indicator/ant_state_indicator.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_state_indicator/ant_state_indicator.h new file mode 100644 index 0000000..a1745f5 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_state_indicator/ant_state_indicator.h @@ -0,0 +1,95 @@ +/** + * Copyright (c) 2015 - 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 __ANT_STATE_INDICATOR_H +#define __ANT_STATE_INDICATOR_H + +/** @file + * + * @defgroup ant_state_indicator ANT channel state indicator + * @{ + * @ingroup ant_sdk_utils + * @brief ANT channel state indicator module. + * + * @details This module provides functionality for indicating the ANT channel state. + */ + +#include <stdint.h> +#include "sdk_errors.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief Function for initializing the ANT channel state indicator. + * + * @details This function links the signaling procedure with a specific ANT channel. + * + * Before calling this function, you must initiate the @ref lib_bsp to be able to use the LEDs. + * + * @param[in] channel ANT channel number. + * @param[in] channel_type ANT channel type (see Assign Channel Parameters in ant_parameters.h: @ref ant_parameters). + * + * @retval NRF_SUCCESS If the module was initialized successfully. Otherwise, a propagated error + * code is returned. + */ +ret_code_t ant_state_indicator_init(uint8_t channel, uint8_t channel_type); + +/** + * @brief Function for indicating the channel opening. + * + * @details This function should be called after the opening of the channel. + * + * @retval NRF_SUCCESS If the state was successfully indicated. + * @retval NRF_ERROR_NO_MEM If the internal timer operations queue was full. + * @retval NRF_ERROR_INVALID_STATE If the application timer module has not been initialized + * or the internal timer has not been created. + * + * @retval NRF_SUCCESS If the state was indicated successfully. Otherwise, a propagated error + * code is returned. + */ +ret_code_t ant_state_indicator_channel_opened(void); + +#ifdef __cplusplus +} +#endif + +#endif // ANT_STATE_INDICATOR_H__ +/** @} */ |