cgms_racp.h 3.7 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. /** @file
  41. *
  42. * @defgroup ble_sdk_srv_cgms_racp Record Access Control Point
  43. * @{
  44. * @ingroup ble_cgms
  45. * @brief Continuous Glucose Monitoring Service RACP module.
  46. *
  47. * @details This module implements parts of the Continuous Glucose Monitoring that relate to the
  48. * Record Access Control Point. Events are propagated to this module from @ref ble_cgms
  49. * using @ref cgms_racp_on_rw_auth_req and @ref cgms_racp_on_tx_complete.
  50. *
  51. */
  52. #ifndef NRF_BLE_CGMS_RACP_H__
  53. #define NRF_BLE_CGMS_RACP_H__
  54. #include "ble.h"
  55. #include "ble_srv_common.h"
  56. #include "sdk_errors.h"
  57. #include "nrf_ble_cgms.h"
  58. #ifdef __cplusplus
  59. extern "C" {
  60. #endif
  61. /**@brief Function for adding a characteristic for the Record Access Control Point.
  62. *
  63. * @param[in] p_cgms Instance of the CGM Service.
  64. *
  65. * @retval NRF_SUCCESS If the characteristic was successfully added.
  66. * @retval NRF_ERROR_NULL If any of the input parameters are NULL.
  67. * @return If functions from other modules return errors to this function,
  68. * the @ref nrf_error are propagated.
  69. */
  70. ret_code_t cgms_racp_char_add(nrf_ble_cgms_t * p_cgms);
  71. /**@brief Function for handling @ref BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST events.
  72. *
  73. * @param[in] p_cgms Instance of the CGM Service.
  74. * @param[in] p_auth_req Authorize request event to be handled.
  75. */
  76. void cgms_racp_on_rw_auth_req(nrf_ble_cgms_t * p_cgms,
  77. ble_gatts_evt_rw_authorize_request_t const * p_auth_req);
  78. /**@brief Function for handling @ref BLE_GATTS_EVT_HVN_TX_COMPLETE events.
  79. *
  80. * @param[in] p_cgms Instance of the CGM Service.
  81. */
  82. void cgms_racp_on_tx_complete(nrf_ble_cgms_t * p_cgms);
  83. #ifdef __cplusplus
  84. }
  85. #endif
  86. #endif // NRF_BLE_CGMS_RACP_H__
  87. /** @} */