ant_hrm_utils.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. /**
  2. * Copyright (c) 2015 - 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 ANT_HRM_UTILS_H__
  41. #define ANT_HRM_UTILS_H__
  42. #include "app_util.h"
  43. #include "nrf_assert.h"
  44. #include "nrf.h"
  45. #ifdef __cplusplus
  46. extern "C" {
  47. #endif
  48. /** @file
  49. *
  50. * @defgroup ant_sdk_profiles_hrm_utils Heart Rate Monitor profile utilities
  51. * @{
  52. * @ingroup ant_hrm
  53. * @brief This module implements utilities for the Heart Rate Monitor profile.
  54. *
  55. */
  56. /**@brief Unit for HRM operating time.
  57. *
  58. * @details According to the ANT HRM specification, the operating time unit is 2 seconds.
  59. */
  60. #define ANT_HRM_OPERATING_TIME_UNIT 2u
  61. /**@brief This macro should be used to get the seconds part of the operating time.
  62. */
  63. #define ANT_HRM_OPERATING_SECONDS(OPERATING_TIME) (((OPERATING_TIME) * ANT_HRM_OPERATING_TIME_UNIT) % 60)
  64. /**@brief This macro should be used to get the minutes part of the operating time.
  65. */
  66. #define ANT_HRM_OPERATING_MINUTES(OPERATING_TIME) ((((OPERATING_TIME) * ANT_HRM_OPERATING_TIME_UNIT) / 60) % 60)
  67. /**@brief This macro should be used to get the hours part of the operating time.
  68. */
  69. #define ANT_HRM_OPERATING_HOURS(OPERATING_TIME) ((((OPERATING_TIME) * ANT_HRM_OPERATING_TIME_UNIT) / (60 * 60)) % 24)
  70. /**@brief This macro should be used to get the days part of the operating time.
  71. */
  72. #define ANT_HRM_OPERATING_DAYS(OPERATING_TIME) ((((OPERATING_TIME) * ANT_HRM_OPERATING_TIME_UNIT) / (60 * 60)) / 24)
  73. /**@brief Number of HRM beat time counts per second.
  74. *
  75. * @details According to the ANT HRM specification, the beat time unit is 1/1024 of a second.
  76. */
  77. #define ANT_HRM_BEAT_TIME_COUNTS_PER_SEC 1024u
  78. /**@brief Beat time display required precision.
  79. *
  80. * @details This value is used to decode the number of milliseconds.
  81. */
  82. #define ANT_HRM_BEAT_TIME_PRECISION 1000u
  83. /**@brief This macro should be used to get the seconds part of the HRM beat time.
  84. */
  85. #define ANT_HRM_BEAT_TIME_SEC(BEAT_TIME) ((BEAT_TIME) / ANT_HRM_BEAT_TIME_COUNTS_PER_SEC)
  86. /**@brief This macro should be used to get the milliseconds part of the HRM beat time.
  87. */
  88. #define ANT_HRM_BEAT_TIME_MSEC(BEAT_TIME) (((((BEAT_TIME) % ANT_HRM_BEAT_TIME_COUNTS_PER_SEC) * ANT_HRM_BEAT_TIME_PRECISION) \
  89. + (ANT_HRM_BEAT_TIME_COUNTS_PER_SEC / 2)) \
  90. / ANT_HRM_BEAT_TIME_COUNTS_PER_SEC)
  91. /** @} */
  92. #ifdef __cplusplus
  93. }
  94. #endif
  95. #endif // ANT_HRM_UTILS_H__