cgms_db.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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_cgms_db Continuous Glucose Monitoring Service database
  43. * @{
  44. * @ingroup ble_cgms
  45. *
  46. * @brief Continuous Glucose Monitoring Service database module.
  47. *
  48. * @details This module implements a database of stored glucose measurement values.
  49. * This database is meant as an example of a database that the @ref ble_cgms can use.
  50. * Replace this module if this implementation does not suit
  51. * your application. Any replacement implementation should follow the API below to ensure
  52. * that the qualification of the @ref ble_cgms is not compromised.
  53. */
  54. #ifndef BLE_CGMS_DB_H__
  55. #define BLE_CGMS_DB_H__
  56. #include "sdk_errors.h"
  57. #include "nrf_ble_cgms.h"
  58. #ifdef __cplusplus
  59. extern "C" {
  60. #endif
  61. #define CGMS_DB_MAX_RECORDS 100 // !< Number of records that can be stored in the database.
  62. /**@brief Function for initializing the glucose record database.
  63. *
  64. * @retval NRF_SUCCESS If the database was successfully initialized.
  65. */
  66. ret_code_t cgms_db_init(void);
  67. /**@brief Function for getting the number of records in the database.
  68. *
  69. * @return The number of records in the database.
  70. */
  71. uint16_t cgms_db_num_records_get(void);
  72. /**@brief Function for getting a specific record from the database.
  73. *
  74. * @param[in] record_num Index of the record to retrieve.
  75. * @param[out] p_rec Pointer to the record structure to which the retrieved record is copied.
  76. *
  77. * @retval NRF_SUCCESS If the record was successfully retrieved.
  78. */
  79. ret_code_t cgms_db_record_get(uint8_t record_num, ble_cgms_rec_t * p_rec);
  80. /**@brief Function for adding a record at the end of the database.
  81. *
  82. * @param[in] p_rec Pointer to the record to add to the database.
  83. *
  84. * @retval NRF_SUCCESS If the record was successfully added to the database.
  85. */
  86. ret_code_t cgms_db_record_add(ble_cgms_rec_t * p_rec);
  87. /**@brief Function for deleting a database entry.
  88. *
  89. * @details This call deletes an record from the database.
  90. *
  91. * @param[in] record_num Index of the record to delete.
  92. *
  93. * @retval NRF_SUCCESS If the record was successfully deleted from the database.
  94. */
  95. ret_code_t cgms_db_record_delete(uint8_t record_num);
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #endif // BLE_CGMS_DB_H__
  100. /** @} */