nrf_ble_es.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  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 NRF_ES_H__
  41. #define NRF_ES_H__
  42. #include <stdint.h>
  43. #include "ble.h"
  44. /**
  45. * @file
  46. * @defgroup eddystone Eddystone library
  47. * @ingroup app_common
  48. * @{
  49. *
  50. * @brief Library for Eddystone beacons. This library is used in the @ref ble_sdk_app_es.
  51. *
  52. * @note The API documentation is provided for reference only. You should
  53. * not modify this library, and you should not use any functions
  54. * except for the main level functions defined in @c nrf_ble_es.h
  55. * in different contexts.
  56. */
  57. /** @brief Eddystone event types. */
  58. typedef enum
  59. {
  60. NRF_BLE_ES_EVT_ADVERTISEMENT_SENT, //!< A non-connectable Eddystone frame advertisement was sent.
  61. NRF_BLE_ES_EVT_CONNECTABLE_ADV_STARTED, //!< Advertising in connectable mode was started.
  62. NRF_BLE_ES_EVT_CONNECTABLE_ADV_STOPPED, //!< Advertising in connectable mode was stopped.
  63. } nrf_ble_es_evt_t;
  64. /**@brief Eddystone event handler type. */
  65. typedef void (*nrf_ble_es_evt_handler_t)(nrf_ble_es_evt_t evt);
  66. /**@brief Function for handling the application's BLE stack events.
  67. *
  68. * @details This function handles all events from the BLE stack that are of
  69. * interest to the Eddystone library.
  70. *
  71. * @param[in] p_ble_evt Event received from the BLE stack.
  72. * @param[in] p_context User parameter.
  73. */
  74. void nrf_ble_es_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
  75. /**@brief Function for putting the beacon in connectable mode.
  76. *
  77. * @details This function makes the beacon advertise connectable advertisements.
  78. * If the beacon is in a connected state, the request is ignored.
  79. */
  80. void nrf_ble_es_on_start_connectable_advertising(void);
  81. /** @brief Function for initializing the Eddystone library.
  82. *
  83. * @param[in] evt_handler Event handler to be called for handling BLE events.
  84. */
  85. void nrf_ble_es_init(nrf_ble_es_evt_handler_t evt_handler);
  86. /**
  87. * @}
  88. */
  89. #endif