ble_gls_db.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. /**
  2. * Copyright (c) 2012 - 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_gls_db Glucose Database Service
  43. * @{
  44. * @ingroup ble_sdk_srv
  45. * @brief Glucose Service module.
  46. *
  47. * @details This module implements at database of stored glucose measurement values.
  48. *
  49. * @note Attention!
  50. * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile
  51. * qualification listings, These APIs must not be modified. However, the corresponding
  52. * functions' implementations can be modified.
  53. */
  54. #ifndef BLE_GLS_DB_H__
  55. #define BLE_GLS_DB_H__
  56. #include <stdint.h>
  57. #include "ble_gls.h"
  58. #ifdef __cplusplus
  59. extern "C" {
  60. #endif
  61. #define BLE_GLS_DB_MAX_RECORDS 20
  62. /**@brief Function for initializing the glucose record database.
  63. *
  64. * @details This call initializes the database holding glucose records.
  65. *
  66. * @return NRF_SUCCESS on success.
  67. */
  68. uint32_t ble_gls_db_init(void);
  69. /**@brief Function for getting the number of records in the database.
  70. *
  71. * @details This call returns the number of records in the database.
  72. *
  73. * @return Number of records in the database.
  74. */
  75. uint16_t ble_gls_db_num_records_get(void);
  76. /**@brief Function for getting a record from the database.
  77. *
  78. * @details This call returns a specified record from the database.
  79. *
  80. * @param[in] record_num Index of the record to retrieve.
  81. * @param[out] p_rec Pointer to record structure where retrieved record is copied to.
  82. *
  83. * @return NRF_SUCCESS on success.
  84. */
  85. uint32_t ble_gls_db_record_get(uint8_t record_num, ble_gls_rec_t * p_rec);
  86. /**@brief Function for adding a record at the end of the database.
  87. *
  88. * @details This call adds a record as the last record in the database.
  89. *
  90. * @param[in] p_rec Pointer to record to add to database.
  91. *
  92. * @return NRF_SUCCESS on success.
  93. */
  94. uint32_t ble_gls_db_record_add(ble_gls_rec_t * p_rec);
  95. /**@brief Function for deleting a database entry.
  96. *
  97. * @details This call deletes an record from the database.
  98. *
  99. * @param[in] record_num Index of record to delete.
  100. *
  101. * @return NRF_SUCCESS on success.
  102. */
  103. uint32_t ble_gls_db_record_delete(uint8_t record_num);
  104. #ifdef __cplusplus
  105. }
  106. #endif
  107. #endif // BLE_GLS_DB_H__
  108. /** @} */