es_adv_timing.h 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /**
  2. * Copyright (c) 2016 - 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 ES_ADV_TIMING_H__
  41. #define ES_ADV_TIMING_H__
  42. #include <stdint.h>
  43. /**
  44. * @file
  45. * @defgroup eddystone_adv_timing Timing
  46. * @brief Events and functions for advertisement timing.
  47. * @ingroup eddystone_adv
  48. * @{
  49. */
  50. /**@brief Eddystone advertisement timing event types. */
  51. typedef enum
  52. {
  53. ES_ADV_TIMING_EVT_ADV_SLOT, //!< Advertising non-eTLM slot.
  54. ES_ADV_TIMING_EVT_ADV_ETLM //!< Advertising eTLM slot.
  55. } es_adv_timing_evt_id_t;
  56. /**@brief Eddystone advertisement timing event. */
  57. typedef struct
  58. {
  59. es_adv_timing_evt_id_t evt_id; //!< Event type ID.
  60. uint8_t slot_no; /**< @brief Slot number.
  61. * @details For non-eTLM events: The slot number to advertise.
  62. *
  63. * For eTLM events: The slot number of the corresponding EID slot. */
  64. } es_adv_timing_evt_t;
  65. /**@brief Eddystone advertisement timing event callback.
  66. *
  67. * @param[in] p_evt Pointer to the Eddystone advertisement timing event.
  68. */
  69. typedef void (*es_adv_timing_callback_t)(const es_adv_timing_evt_t * p_evt);
  70. /**@brief Function for starting Eddystone advertisement timing event generation. */
  71. void es_adv_timing_start(uint16_t adv_interval);
  72. /**@brief Function for stopping Eddystone advertisement timing event generation. */
  73. void es_adv_timing_stop(void);
  74. /**@brief Function for initializing the Eddystone advertisement timers.
  75. */
  76. void es_adv_timing_timers_init(void);
  77. /**@brief Function for initializing the Eddystone advertisement timing module.
  78. *
  79. * @param[in] handler Eddystone advertisement timing event handler to register.
  80. */
  81. void es_adv_timing_init(es_adv_timing_callback_t handler);
  82. /**
  83. * @}
  84. */
  85. #endif // ES_ADV_TIMING_H__