drv_lsm6ds3tr_c.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. #ifndef __DRV_LSM6DS3TR_C_H__
  2. #define __DRV_LSM6DS3TR_C_H__
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. /*Includes ------------------------------------------------------*/
  7. #include <stdint.h>
  8. #include <stdio.h>
  9. #include <stdbool.h>
  10. #include "lsm6ds3tr-c_reg.h"
  11. /*STRUCTION -----------------------------------------------------*/
  12. typedef enum{
  13. LSM_ACC_ODR_OFF = LSM6DS3TR_C_XL_ODR_OFF, //关闭加速度
  14. LSM_ACC_ODR_104HZ = LSM6DS3TR_C_XL_ODR_104Hz, //采样频率 - 104赫兹
  15. LSM_ACC_ODR_12HZ5 = LSM6DS3TR_C_XL_ODR_12Hz5, //采样频率 - 12.5赫兹
  16. } LSM_ACC_ODR_e;
  17. typedef enum{
  18. LSM_GRY_ODR_OFF = LSM6DS3TR_C_GY_ODR_OFF, //关闭陀螺仪
  19. LSM_GRY_ODR_104HZ = LSM6DS3TR_C_GY_ODR_104Hz, //采样频率 - 104赫兹
  20. LSM_GRY_ODR_12HZ5 = LSM6DS3TR_C_GY_ODR_12Hz5, //采样频率 - 12.5赫兹
  21. } LSM_GRY_ODR_e;
  22. typedef enum{
  23. LSM_MAG_ODR_OFF = 0x00, //关闭地磁计
  24. LSM_MAG_ODR_10HZ = 0x31, //采样频率 - 10赫兹
  25. LSM_MAG_ODR_100HZ = 0x39, //采样频率 - 100赫兹
  26. LSM_MAG_ODR_200HZ = 0x3D, //采样频率 - 200赫兹
  27. } LSM_MAG_ODR_e;
  28. typedef enum{
  29. LSM_FIFO_ODR_OFF = LSM6DS3TR_C_FIFO_DISABLE, //关闭FIFO
  30. LSM_FIFO_ODR_104HZ = LSM6DS3TR_C_FIFO_104Hz, //采样频率 - 104赫兹
  31. } LSM_FIFO_ODR_e;
  32. typedef enum{
  33. LSM_ACC_POWER_MODE_HIGH_PERFORMANCE = LSM6DS3TR_C_XL_HIGH_PERFORMANCE, //加速度工作模式 - 高性能
  34. LSM_ACC_POWER_MODE_NORMAL = LSM6DS3TR_C_XL_NORMAL, //加速度工作模式 - 正常
  35. } LSM_ACC_POWER_MODE_e;
  36. typedef enum{
  37. LSM_GRY_POWER_MODE_HIGH_PERFORMANCE = LSM6DS3TR_C_GY_HIGH_PERFORMANCE, //陀螺仪工作模式 - 高性能
  38. LSM_GRY_POWER_MODE_NORMAL = LSM6DS3TR_C_GY_NORMAL, //陀螺仪工作模式 - 正常
  39. } LSM_GRY_POWER_MODE_e;
  40. typedef enum{
  41. LSM_TIMESTAMP_6MS4 = LSM6DS3TR_C_LSB_6ms4, //时间戳精度 - 6.4毫秒
  42. LSM_TIMESTAMP_25US = LSM6DS3TR_C_LSB_25us, //时间戳精度 - 25微妙
  43. } LSM_TIMESTAMP_RESOLUTION_e;
  44. typedef enum{
  45. LSM_TIMESTAMP_OFF = 0, //时间戳关闭
  46. LSM_TIMESTAMP_ON = 1, //时间戳开启
  47. } LSM_TIMESTAMP_SWITCH_e;
  48. typedef enum{
  49. LSM_ACC_FS_2G = LSM6DS3TR_C_2g, //量程 - 2倍重力加速度
  50. LSM_ACC_FS_16G = LSM6DS3TR_C_16g, //量程 - 16倍重力加速度
  51. } LSM_ACC_FS_e;
  52. typedef enum{
  53. LSM_GRY_FS_250DPS = LSM6DS3TR_C_250dps, //量程 - 250角速度/秒
  54. LSM_GRY_FS_2000DPS = LSM6DS3TR_C_2000dps, //量程 - 2000角速度/秒
  55. } LSM_GRY_FS_e;
  56. typedef enum{
  57. LSM_MAG_FS_30GS = 0x00, //量程 - 30高斯
  58. } LSM_MAG_FS_e;
  59. typedef struct
  60. {
  61. LSM_ACC_POWER_MODE_e acc_power_mode; //加速度工作模式
  62. LSM_GRY_POWER_MODE_e gry_power_mode; //陀螺仪工作模式
  63. LSM_FIFO_ODR_e fifo_odr; //FIFO采样频率
  64. LSM_TIMESTAMP_RESOLUTION_e timestamp_resolution; //时间戳精度
  65. LSM_TIMESTAMP_SWITCH_e timestamp_switch; //时间戳开关,注:时间戳采样率和FIFO采样率一致
  66. LSM_ACC_ODR_e acc_odr; //加速度采样频率
  67. LSM_GRY_ODR_e gry_odr; //陀螺仪采样频率
  68. LSM_MAG_ODR_e mag_odr; //地磁计采样频率
  69. LSM_ACC_FS_e acc_fs; //加速度量程
  70. LSM_GRY_FS_e gry_fs; //陀螺仪量程
  71. LSM_MAG_FS_e mag_fs; //地磁计量程
  72. } drv_lsm_config_param_t;
  73. typedef struct
  74. {
  75. int16_t acc[3]; //加速度三轴
  76. int16_t gry[3]; //陀螺仪三轴
  77. int16_t mag[3]; //地磁计三轴
  78. int32_t fifo_timestamp; //fifo时间戳
  79. } lsm_data_t;
  80. /*API -------------------------------------------------------*/
  81. /**
  82. @brief 初始化LSM驱动
  83. @param 无
  84. @return 错误代码 - [out] -1失败,0成功
  85. */
  86. int drv_lsm_Init(void);
  87. /**
  88. @brief LSM断电
  89. @param 无
  90. @return 错误代码 - [out] -1失败,0成功
  91. */
  92. int drv_lsm_power_off(void);
  93. /**
  94. @brief LSM上电(默认配置挂起)
  95. @param 无
  96. @return 错误代码 - [out] -1失败,0成功
  97. */
  98. int drv_lsm_power_on(void);
  99. /**
  100. @brief 设置加速度工作模式
  101. @param acc_power_mode - [in] 加速度工作模式
  102. @return 错误代码 - [out] -1失败,0成功
  103. */
  104. int drv_lsm_set_acc_power_mode(LSM_ACC_POWER_MODE_e acc_power_mode);
  105. /**
  106. @brief 设置陀螺仪工作模式
  107. @param gry_power_mode - [in] 陀螺仪工作模式
  108. @return 错误代码 - [out] -1失败,0成功
  109. */
  110. int drv_lsm_set_gry_power_mode(LSM_GRY_POWER_MODE_e gry_power_mode);
  111. /**
  112. @brief 设置时间戳精度
  113. @param timestamp_resolution - [in] 时间戳精度
  114. @return 错误代码 - [out] -1失败,0成功
  115. */
  116. int drv_lsm_set_timestamp_resolution(LSM_TIMESTAMP_RESOLUTION_e timestamp_resolution);
  117. /**
  118. @brief 设置时间戳开关
  119. @param timestamp_switch - [in] 时间戳开关
  120. @return 错误代码 - [out] -1失败,0成功
  121. */
  122. int drv_lsm_set_timestamp_switch(LSM_TIMESTAMP_SWITCH_e timestamp_switch);
  123. /**
  124. @brief 设置FIFO采样频率
  125. @param fifo_odr - [in] FIFO采样频率
  126. @param acc_odr - [in] 加速度采样频率
  127. @param gry_odr - [in] 陀螺仪采样频率
  128. @param mag_odr - [in] 地磁计采样频率
  129. @param timestamp_switch - [in] 时间戳开关
  130. @return 错误代码 - [out] -1失败,0成功
  131. */
  132. int drv_lsm_set_fifo_odr(LSM_FIFO_ODR_e fifo_odr, LSM_ACC_ODR_e acc_odr, LSM_GRY_ODR_e gry_odr, LSM_MAG_ODR_e mag_odr, LSM_TIMESTAMP_SWITCH_e timestamp_switch);
  133. /**
  134. @brief 设置ACC量程
  135. @param acc_fs - [in] ACC量程
  136. @return 错误代码 - [out] -1失败,0成功
  137. */
  138. int drv_lsm_set_acc_fs(LSM_ACC_FS_e acc_fs);
  139. /**
  140. @brief 设置ACC采样频率
  141. @param acc_odr - [in] ACC采样频率
  142. @return 错误代码 - [out] -1失败,0成功
  143. */
  144. int drv_lsm_set_acc_odr(LSM_ACC_ODR_e acc_odr);
  145. /**
  146. @brief 设置GRY量程
  147. @param gry_fs - [in] GRY量程
  148. @return 错误代码 - [out] -1失败,0成功
  149. */
  150. int drv_lsm_set_gry_fs(LSM_GRY_FS_e gry_fs);
  151. /**
  152. @brief 设置GRY采样频率
  153. @param gry_odr - [in] GRY采样频率
  154. @return 错误代码 - [out] -1失败,0成功
  155. */
  156. int drv_lsm_set_gry_odr(LSM_GRY_ODR_e gry_odr);
  157. /**
  158. @brief 获取配置MAG量程需要的步骤数量
  159. @return 错误代码 - [out] 配置MAG量程需要的步骤数量
  160. */
  161. int drv_lsm_get_mag_fs_flow(void);
  162. /**
  163. @brief 设置MAG量程
  164. @param mag_fs - [in] MAG量程
  165. @param flow - [in] 当前需要处理的步骤
  166. @return 错误代码 - [out] -1失败,0成功
  167. */
  168. int drv_lsm_set_mag_fs(LSM_MAG_FS_e mag_fs, int flow);
  169. /**
  170. @brief 获取配置MAG采样频率需要的步骤数量
  171. @return 错误代码 - [out] 配置MAG采样频率需要的步骤数量
  172. */
  173. int drv_lsm_get_mag_odr_flow(void);
  174. /**
  175. @brief 设置MAG采样频率
  176. @param mag_odr - [in] MAG采样频率
  177. @param set_hub - [in] 是否配置hub
  178. @param flow - [in] 当前需要处理的步骤
  179. @return 错误代码 - [out] -1失败,0成功
  180. */
  181. int drv_lsm_set_mag_odr(LSM_MAG_ODR_e mag_odr, bool set_hub, int flow);
  182. /**
  183. @brief 获取LSM配置参数
  184. @param param - [in] LSM配置参数
  185. @return 错误代码 - [out] -1失败,0成功
  186. */
  187. int drv_lsm_get_config_param(drv_lsm_config_param_t *p_param);
  188. /**
  189. @brief 当前LSM的FIFO有几组数据
  190. @return 错误代码 - [out] FIFO当前有几组数据
  191. */
  192. int drv_lsm_get_fifo_group_num(void);
  193. /**
  194. @brief 获取LSM的FIFO数据
  195. @param p_data - [out] 返回的FIFO数据
  196. @return 错误代码 - [out] -1失败,0成功
  197. */
  198. int drv_lsm_get_fifo_data(lsm_data_t *p_data);
  199. /**
  200. @brief 获取LSM的ACC数据
  201. @param p_data - [out] 返回的ACC三轴数据
  202. @return 错误代码 - [out] -1失败,0成功
  203. */
  204. int drv_lsm_get_acc_data(lsm_data_t *p_data);
  205. /**
  206. @brief LSM自检步骤拆分——1,执行玩需等待100ms稳定输出才能执行步骤2
  207. @param 无
  208. @return 错误代码 - [out] -1失败,0成功
  209. */
  210. int drv_lsm_self_check_1(void);
  211. /**
  212. @brief LSM自检步骤拆分——2,执行玩需等待100ms稳定输出才能执行步骤3
  213. @param 无
  214. @return 错误代码 - [out] -1失败,0成功
  215. */
  216. int drv_lsm_self_check_2(void);
  217. /**
  218. @brief LSM自检步骤拆分——3,执行玩需等待150ms稳定输出才能执行步骤4
  219. @param 无
  220. @return 错误代码 - [out] -1失败,0成功
  221. */
  222. int drv_lsm_self_check_3(void);
  223. /**
  224. @brief LSM自检步骤拆分——4,执行玩需等待50ms稳定输出才能执行步骤5
  225. @param 无
  226. @return 错误代码 - [out] -1失败,0成功
  227. */
  228. int drv_lsm_self_check_4(void);
  229. /**
  230. @brief LSM自检步骤拆分——5,获取自检结果。
  231. @param 无
  232. @return 错误代码 - [out] -1失败,0成功
  233. */
  234. int drv_lsm_self_check_5(void);
  235. #ifdef __cplusplus
  236. }
  237. #endif
  238. #endif