ant_bsc_utils.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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_BSC_UTILS_H__
  41. #define ANT_BSC_UTILS_H__
  42. #include "nrf.h"
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /** @file
  47. *
  48. * @defgroup ant_sdk_profiles_bsc_utils Bicycle Speed and Cadence profile utilities
  49. * @{
  50. * @ingroup ant_bsc
  51. * @brief This module implements utilities for the Bicycle Speed and Cadence profile.
  52. *
  53. */
  54. /**@brief Unit for BSC operating time.
  55. *
  56. * @details According to the ANT BSC specification, the operating time unit is 2 seconds.
  57. */
  58. #define ANT_BSC_OPERATING_TIME_UNIT 2u
  59. /**@brief This macro should be used to get the seconds part of the operating time.
  60. */
  61. #define ANT_BSC_OPERATING_SECONDS(OPERATING_TIME) (((OPERATING_TIME) * ANT_BSC_OPERATING_TIME_UNIT) % 60)
  62. /**@brief This macro should be used to get the minutes part of the operating time.
  63. */
  64. #define ANT_BSC_OPERATING_MINUTES(OPERATING_TIME) ((((OPERATING_TIME) * ANT_BSC_OPERATING_TIME_UNIT) / 60) % 60)
  65. /**@brief This macro should be used to get the hours part of the operating time.
  66. */
  67. #define ANT_BSC_OPERATING_HOURS(OPERATING_TIME) ((((OPERATING_TIME) * ANT_BSC_OPERATING_TIME_UNIT) / (60 * 60)) % 24)
  68. /**@brief This macro should be used to get the days part of the operating time.
  69. */
  70. #define ANT_BSC_OPERATING_DAYS(OPERATING_TIME) ((((OPERATING_TIME) * ANT_BSC_OPERATING_TIME_UNIT) / (60 * 60)) / 24)
  71. /**@brief Number of Bicycle Speed or Cadence event time counts per second.
  72. *
  73. * @details According to the ANT BSC specification, the speed or cadence event time unit is 1/1024 of a second.
  74. */
  75. #define ANT_BSC_EVENT_TIME_COUNTS_PER_SEC 1024u
  76. /**@brief BSC event time display required precision.
  77. *
  78. * @details This value is used to decode the number of milliseconds.
  79. */
  80. #define ANT_BSC_EVENT_TIME_PRECISION 1000u
  81. /**@brief This macro should be used to get the seconds part of the BSC event time.
  82. */
  83. #define ANT_BSC_EVENT_TIME_SEC(EVENT_TIME) ((EVENT_TIME) / ANT_BSC_EVENT_TIME_COUNTS_PER_SEC)
  84. /**@brief This macro should be used to get the milliseconds part of the BSC event time.
  85. */
  86. #define ANT_BSC_EVENT_TIME_MSEC(EVENT_TIME) (((((EVENT_TIME) % ANT_BSC_EVENT_TIME_COUNTS_PER_SEC) * ANT_BSC_EVENT_TIME_PRECISION) \
  87. + ANT_BSC_EVENT_TIME_COUNTS_PER_SEC / 2) \
  88. / ANT_BSC_EVENT_TIME_COUNTS_PER_SEC)
  89. /**@brief Battery voltage display required precision.
  90. *
  91. * @details This value is used to decode the number of mV.
  92. */
  93. #define ANT_BSC_BAT_VOLTAGE_PRECISION 1000u
  94. /**@brief Bike Speed and Cadence profile, unit divisor of the fractional part of the battery voltage.
  95. *
  96. * @details According to the ANT BSC specification, the battery voltage fraction unit is (1/256) V.
  97. */
  98. #define ANT_BSC_BAT_VOLTAGE_FRACTION_PER_VOLT 256u
  99. /**@brief This macro should be used to get the mV part of the BSC battery voltage.
  100. */
  101. #define ANT_BSC_BAT_VOLTAGE_FRACTION_MV(VOLT_FRACT) ((((VOLT_FRACT) * ANT_BSC_BAT_VOLTAGE_PRECISION) \
  102. + ANT_BSC_BAT_VOLTAGE_FRACTION_PER_VOLT / 2) \
  103. / ANT_BSC_BAT_VOLTAGE_FRACTION_PER_VOLT)
  104. /** @} */
  105. #ifdef __cplusplus
  106. }
  107. #endif
  108. #endif // ANT_BSC_UTILS_H__