ant_state_indicator.h 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /**
  2. * Copyright (c) 2015 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef __ANT_STATE_INDICATOR_H
  41. #define __ANT_STATE_INDICATOR_H
  42. /** @file
  43. *
  44. * @defgroup ant_state_indicator ANT channel state indicator
  45. * @{
  46. * @ingroup ant_sdk_utils
  47. * @brief ANT channel state indicator module.
  48. *
  49. * @details This module provides functionality for indicating the ANT channel state.
  50. */
  51. #include <stdint.h>
  52. #include "sdk_errors.h"
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  56. /**
  57. * @brief Function for initializing the ANT channel state indicator.
  58. *
  59. * @details This function links the signaling procedure with a specific ANT channel.
  60. *
  61. * Before calling this function, you must initiate the @ref lib_bsp to be able to use the LEDs.
  62. *
  63. * @param[in] channel ANT channel number.
  64. * @param[in] channel_type ANT channel type (see Assign Channel Parameters in ant_parameters.h: @ref ant_parameters).
  65. *
  66. * @retval NRF_SUCCESS If the module was initialized successfully. Otherwise, a propagated error
  67. * code is returned.
  68. */
  69. ret_code_t ant_state_indicator_init(uint8_t channel, uint8_t channel_type);
  70. /**
  71. * @brief Function for indicating the channel opening.
  72. *
  73. * @details This function should be called after the opening of the channel.
  74. *
  75. * @retval NRF_SUCCESS If the state was successfully indicated.
  76. * @retval NRF_ERROR_NO_MEM If the internal timer operations queue was full.
  77. * @retval NRF_ERROR_INVALID_STATE If the application timer module has not been initialized
  78. * or the internal timer has not been created.
  79. *
  80. * @retval NRF_SUCCESS If the state was indicated successfully. Otherwise, a propagated error
  81. * code is returned.
  82. */
  83. ret_code_t ant_state_indicator_channel_opened(void);
  84. #ifdef __cplusplus
  85. }
  86. #endif
  87. #endif // ANT_STATE_INDICATOR_H__
  88. /** @} */