ant_sdm_utils.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  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_SDM_UTILS_H__
  41. #define ANT_SDM_UTILS_H__
  42. #include "nrf_assert.h"
  43. #include "nrf.h"
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47. /** @file
  48. *
  49. * @defgroup ant_sdk_profiles_sdm_utils Stride Based Speed and Distance Monitor profile utilities
  50. * @{
  51. * @ingroup ant_sdm
  52. * @brief This module implements utilities for the Stride Based Speed and Distance Monitor profile.
  53. *
  54. */
  55. /*@brief A reversal of time unit.
  56. *
  57. * @details According to the ANT SDM specification, the time unit (fractional part) is 1/200 of a second.
  58. */
  59. #define ANT_SDM_TIME_UNIT_REVERSAL 200
  60. #define ANT_SDM_TIME_DISP_PRECISION 1000
  61. #define ANT_SDM_TIME_RESCALE(VALUE) value_rescale((VALUE), ANT_SDM_TIME_UNIT_REVERSAL, \
  62. ANT_SDM_TIME_DISP_PRECISION)
  63. /*@brief A reversal of distance unit.
  64. *
  65. * @details According to the ANT SDM specification, the distance unit (page 1 - fractional part) is 1/16 of a meter.
  66. */
  67. #define ANT_SDM_DISTANCE_UNIT_REVERSAL 16
  68. #define ANT_SDM_DISTANCE_DISP_PRECISION 10
  69. #define ANT_SDM_DISTANCE_RESCALE(VALUE) value_rescale((VALUE), ANT_SDM_DISTANCE_UNIT_REVERSAL, \
  70. ANT_SDM_DISTANCE_DISP_PRECISION)
  71. /*@brief A reversal of speed unit.
  72. *
  73. * @details According to the ANT SDM specification, the speed unit (fractional part) is 1/256 of m/s.
  74. */
  75. #define ANT_SDM_SPEED_UNIT_REVERSAL 256
  76. #define ANT_SDM_SPEED_DISP_PRECISION 100
  77. #define ANT_SDM_SPEED_RESCALE(VALUE) value_rescale((VALUE), ANT_SDM_SPEED_UNIT_REVERSAL, \
  78. ANT_SDM_SPEED_DISP_PRECISION)
  79. /*@brief A reversal of update latency unit.
  80. *
  81. * @details According to the ANT SDM specification, the update latency unit (fractional part) is 1/32 of a second.
  82. */
  83. #define ANT_SDM_UPDATE_LATENCY_UNIT_REVERSAL 32
  84. #define ANT_SDM_UPDATE_LATENCY_DISP_PRECISION 1000
  85. #define ANT_SDM_UPDATE_LATENCY_RESCALE(VALUE) value_rescale((VALUE), ANT_SDM_UPDATE_LATENCY_UNIT_REVERSAL, \
  86. ANT_SDM_UPDATE_LATENCY_DISP_PRECISION)
  87. /*@brief A reversal of cadence unit.
  88. *
  89. * @details According to the ANT SDM specification, the cadence unit (fractional part) is 1/16 of strides/minute.
  90. */
  91. #define ANT_SDM_CADENCE_UNIT_REVERSAL 16
  92. #define ANT_SDM_CADENCE_DISP_PRECISION 10
  93. #define ANT_SDM_CADENCE_RESCALE(VALUE) value_rescale((VALUE), ANT_SDM_CADENCE_UNIT_REVERSAL, \
  94. ANT_SDM_CADENCE_DISP_PRECISION)
  95. /** @} */
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #endif // ANT_SDM_UTILS_H__