fml_imu.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. #ifndef __FML_IMU_H__
  2. #define __FML_IMU_H__
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. /*Includes ------------------------------------------------------*/
  7. #include <stdbool.h>
  8. #include <stdint.h>
  9. #include <string.h>
  10. #include "sdk_common.h"
  11. #include "SEGGER_RTT.h"
  12. #include "usr_config.h"
  13. /*Private macro ------------------------------------------------------------------------------------------------------------------------------------*/
  14. #define FML_IMU_CONFIG_FLOW_DONE 0xFFFFFFFF //配置流程完成标志
  15. /*STRUCTION ----------------------------------------------------*/
  16. typedef enum{
  17. FML_IMU_ACC_ODR_OFF = 0, //关闭加速度 优先级 - 0 优先级越大,级别越高
  18. FML_IMU_ACC_ODR_12HZ5 = 1, //采样频率 - 12.5赫兹 优先级 - 1
  19. FML_IMU_ACC_ODR_104HZ = 2, //采样频率 - 104赫兹 优先级 - 2
  20. FML_IMU_ACC_ODR_208HZ = 3, //采样频率 - 208赫兹 优先级 - 3
  21. FML_IMU_ACC_ODR_416HZ = 4, //采样频率 - 416赫兹 优先级 - 4
  22. FML_IMU_ACC_ODR_833HZ = 5, //采样频率 - 833赫兹 优先级 - 5
  23. } FML_IMU_ACC_ODR_e;
  24. typedef enum{
  25. FML_IMU_GRY_ODR_OFF = 0, //关闭陀螺仪 优先级 - 0 优先级越大,级别越高
  26. FML_IMU_GRY_ODR_12HZ5 = 1, //采样频率 - 12.5赫兹 优先级 - 1
  27. FML_IMU_GRY_ODR_104HZ = 2, //采样频率 - 104赫兹 优先级 - 2
  28. FML_IMU_GRY_ODR_208HZ = 3, //采样频率 - 208赫兹 优先级 - 3
  29. FML_IMU_GRY_ODR_416HZ = 4, //采样频率 - 416赫兹 优先级 - 4
  30. FML_IMU_GRY_ODR_833HZ = 5, //采样频率 - 833赫兹 优先级 - 5
  31. } FML_IMU_GRY_ODR_e;
  32. typedef enum{
  33. FML_IMU_MAG_ODR_OFF = 0, //关闭地磁计 优先级 - 0 优先级越大,级别越高
  34. FML_IMU_MAG_ODR_10HZ = 1, //采样频率 - 10赫兹 优先级 - 1
  35. FML_IMU_MAG_ODR_100HZ = 2, //采样频率 - 100赫兹 优先级 - 2
  36. FML_IMU_MAG_ODR_200HZ = 3, //采样频率 - 200赫兹 优先级 - 3
  37. } FML_IMU_MAG_ODR_e;
  38. typedef enum{
  39. FML_IMU_FIFO_ODR_OFF = 0, //关闭FIFO 优先级 - 0 优先级越大,级别越高
  40. FML_IMU_FIFO_ODR_12HZ5 = 1, //采样频率 - 12.5赫兹 优先级 - 1
  41. FML_IMU_FIFO_ODR_104HZ = 2, //采样频率 - 104赫兹 优先级 - 2
  42. FML_IMU_FIFO_ODR_208HZ = 3, //采样频率 - 208赫兹 优先级 - 3
  43. FML_IMU_FIFO_ODR_416HZ = 4, //采样频率 - 416赫兹 优先级 - 4
  44. FML_IMU_FIFO_ODR_833HZ = 5, //采样频率 - 833赫兹 优先级 - 5
  45. } FML_IMU_FIFO_ODR_e;
  46. typedef enum{
  47. FML_IMU_ACC_POWER_MODE_HIGH_PERFORMANCE = 0, //加速度工作模式 - 高性能 优先级 - 0 优先级越大,级别越高
  48. FML_IMU_ACC_POWER_MODE_NORMAL = 1, //加速度工作模式 - 正常 优先级 - 1
  49. } FML_IMU_ACC_POWER_MODE_e;
  50. typedef enum{
  51. FML_IMU_GRY_POWER_MODE_HIGH_PERFORMANCE = 0, //陀螺仪工作模式 - 高性能 优先级 - 0 优先级越大,级别越高
  52. FML_IMU_GRY_POWER_MODE_NORMAL = 1, //陀螺仪工作模式 - 正常 优先级 - 1
  53. } FML_IMU_GRY_POWER_MODE_e;
  54. typedef enum{
  55. FML_IMU_TIMESTAMP_6MS4 = 0, //时间戳精度 - 6.4毫秒 优先级 - 0 优先级越大,级别越高
  56. FML_IMU_TIMESTAMP_25US = 1, //时间戳精度 - 25微妙 优先级 - 1
  57. } FML_IMU_TIMESTAMP_RESOLUTION_e;
  58. typedef enum{
  59. FML_IMU_TIMESTAMP_OFF = 0, //时间戳关闭 优先级 - 0 优先级越大,级别越高
  60. FML_IMU_TIMESTAMP_ON = 1, //时间戳开启 优先级 - 1
  61. } FML_IMU_TIMESTAMP_SWITCH_e;
  62. typedef enum{
  63. FML_IMU_ACC_FS_2G = 0, //量程 - 2倍重力加速度 优先级 - 0 优先级越大,级别越高
  64. FML_IMU_ACC_FS_16G = 1, //量程 - 16倍重力加速度 优先级 - 1
  65. } FML_IMU_ACC_FS_e;
  66. typedef enum{
  67. FML_IMU_GRY_FS_250DPS = 0, //量程 - 250角速度/秒 优先级 - 0 优先级越大,级别越高
  68. FML_IMU_GRY_FS_2000DPS = 1, //量程 - 2000角速度/秒 优先级 - 1
  69. } FML_IMU_GRY_FS_e;
  70. typedef enum{
  71. FML_IMU_MAG_FS_30GS = 0, //量程 - 30高斯 优先级 - 0 优先级越大,级别越高
  72. } FML_IMU_MAG_FS_e;
  73. typedef enum{
  74. FML_IMU_DIR_FRONT = 0, //方向 - 前脚
  75. FML_IMU_DIR_BACK = 1, //方向 - 后脚
  76. FML_IMU_DIR_NUM = 2, //方向 - 方向数量
  77. } FML_IMU_DIR_e;
  78. typedef struct
  79. {
  80. FML_IMU_ACC_POWER_MODE_e acc_power_mode; //加速度工作模式
  81. FML_IMU_GRY_POWER_MODE_e gry_power_mode; //陀螺仪工作模式
  82. FML_IMU_FIFO_ODR_e fifo_odr; //FIFO采样频率
  83. FML_IMU_TIMESTAMP_RESOLUTION_e timestamp_resolution; //时间戳精度
  84. FML_IMU_TIMESTAMP_SWITCH_e timestamp_switch; //时间戳开关,注:时间戳采样率和FIFO采样率一致
  85. FML_IMU_ACC_ODR_e acc_odr; //加速度采样频率
  86. FML_IMU_GRY_ODR_e gry_odr; //陀螺仪采样频率
  87. FML_IMU_MAG_ODR_e mag_odr; //地磁计采样频率
  88. FML_IMU_ACC_FS_e acc_fs; //加速度量程
  89. FML_IMU_GRY_FS_e gry_fs; //陀螺仪量程
  90. FML_IMU_MAG_FS_e mag_fs; //地磁计量程
  91. } fml_imu_param_t;
  92. typedef struct
  93. {
  94. int16_t acc[3]; //加速度三轴
  95. int16_t gry[3]; //陀螺仪三轴
  96. int16_t mag[3]; //地磁计三轴
  97. int32_t fifo_timestamp; //fifo时间戳
  98. } fml_imu_data_t;
  99. typedef void (*fml_imu_config_cb)(uint32_t conf_result);
  100. typedef void (*fml_imu_data_notify_cb)(uint32_t dir_bit);
  101. /*API -------------------------------------------------------*/
  102. /**
  103. @brief 初始化IMU功能模块
  104. @param 无
  105. @return 错误代码 - [out] -1失败,0成功
  106. */
  107. int fml_imu_Init(void);
  108. /**
  109. @brief 设置需要配置IMU的参数
  110. @param param - [in] 设置IMU的参数
  111. @return 错误代码 - [out] -1失败,0成功
  112. */
  113. int fml_imu_config_param(FML_IMU_DIR_e dir, const fml_imu_param_t *param);
  114. /**
  115. @brief 获取配置IMU的参数
  116. @param param - [in] 返回的地址
  117. @return 错误代码 - [out] -1失败,0成功
  118. */
  119. int fml_imu_get_config_param(FML_IMU_DIR_e dir, fml_imu_param_t *param);
  120. /**
  121. @brief 注册IMU配置结果回调函数
  122. @param cb - [in] 回调函数
  123. @return 错误代码 - [out] -1失败,0成功
  124. */
  125. int fml_imu_register_config_callback(fml_imu_config_cb cb);
  126. /**
  127. @brief 注册IMU数据通知回调函数
  128. @param cb - [in] 回调函数
  129. @return 错误代码 - [out] -1失败,0成功
  130. */
  131. int fml_imu_register_data_notify_callback(fml_imu_data_notify_cb cb);
  132. /**
  133. @brief 开始配置IMU
  134. @param param 无
  135. @return 返回配置状态: - [out] -1不需要重新配置,0需要重新配置
  136. */
  137. int fml_imu_start_config(void);
  138. /**
  139. @brief 读取当前IMU数据的数量
  140. @param dir - [in] 方向
  141. @return 返回当前IMU数据的数量
  142. */
  143. int fml_imu_get_data_num(FML_IMU_DIR_e dir);
  144. /**
  145. @brief 获取当前IMU数据
  146. @param dir - [in] 方向
  147. @param index - [in] 数据索引
  148. @param pdata - [out] 返回的IMU数据指针
  149. @return 错误代码 - [out] -1失败,0成功
  150. */
  151. int fml_imu_get_data(FML_IMU_DIR_e dir, int index, fml_imu_data_t *pdata);
  152. /**
  153. @brief 关闭IMU
  154. @param dir - [in] 方向
  155. @return 错误代码 - [out] -1失败,0成功
  156. */
  157. int fml_imu_close(FML_IMU_DIR_e dir);
  158. #ifdef __cplusplus
  159. }
  160. #endif
  161. #endif