首頁 探索 說明
註冊 登入
JingYun
/
ATY_LIB
1
0
複刻 0
Files 問題管理 0 合併請求 0 Wiki
分支: master
分支列表 標籤列表
ATY_LIB
/
Doing
/
VL6180X_ATY.h

VL6180X_ATY.h 8.1 KB
永久連結 文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170 
  1. /**
    2. 

  2. * @file VL6180X_ATY.h
    3. 

  3. *
    4. 

  4. * @param Project DEVICE_GENERAL_ATY_LIB
    5. 

  5. *
    6. 

  6. * @author ATY
    7. 

  7. *
    8. 

  8. * @copyright
    9. 

  9. *       - Copyright 2017 - 2026 MZ-ATY
    10. 

  10. *       - This code follows:
    11. 

  11. *           - MZ-ATY Various Contents Joint Statement -
    12. 

  12. *               <a href="https://mengze.top/MZ-ATY_VCJS">
    13. 

  13. *                        https://mengze.top/MZ-ATY_VCJS</a>
    14. 

  14. *           - CC 4.0 BY-NC-SA -
    15. 

  15. *               <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">
    16. 

  16. *                        https://creativecommons.org/licenses/by-nc-sa/4.0/</a>
    17. 

  17. *       - Your use will be deemed to have accepted the terms of this statement.
    18. 

  18. *
    19. 

  19. * @brief functions of VL6180 for C platform
    20. 

  20. *
    21. 

  21. * @version
    22. 

  22. *       - 1_01_230828 > ATY
    23. 

  23. *           -# Preliminary version, first Release
    24. 

  24. *       - 1_01_240104 > ATY
    25. 

  25. *           -# base tested VL6180
    26. 

  26. *       - 1_01_240111 > ATY
    27. 

  27. *           -# add lock
    28. 

  28. ********************************************************************************
    29. 

  29. */
    30. 

  30. 

  31. #ifndef __VL6180X_ATY_H
    32. 

  32. #define __VL6180X_ATY_H
    33. 

  33. 

  34. #include "INCLUDE_ATY.h"
    35. 

  35. 

  36. /******************************* For user *************************************/
    37. 

  37. // 0 1 0 1 0 0 1 R/W    // can edit by program
    38. 

  38. #define VL6180X_ADDRESS (0x29)
    39. 

  39. 

  40. /******************************************************************************/
    41. 

  41. 

  42. struct VL6180X_ATY_Dev
    43. 

  43. {
    44. 

  44.     uint8_t addr;
    45. 

  45. 

  46.     uint8_t(*i2cProcess)(uint8_t addr, uint8_t* data_t, uint8_t len, uint8_t rw);
    47. 

  47. 

  48.     uint8_t lock;
    49. 

  49.     uint8_t debugEnable;
    50. 

  50.     int (*LOG)();
    51. 

  51. };
    52. 

  52. 

  53. 

  54. uint8_t VL6180X_WriteByte(uint16_t reg, uint8_t data, struct VL6180X_ATY_Dev* dev);
    55. 

  55. uint8_t VL6180X_WriteBytes(uint16_t reg, uint8_t* data, uint8_t bytes, struct VL6180X_ATY_Dev* dev);
    56. 

  56. uint8_t VL6180X_ReadByte(uint16_t reg, uint8_t* data, struct VL6180X_ATY_Dev* dev);
    57. 

  57. uint8_t VL6180X_ReadBytes(uint16_t reg, uint8_t* data, uint8_t bytes, struct VL6180X_ATY_Dev* dev);
    58. 

  58. 

  59. uint8_t VL6180X_GetId(uint8_t* id, struct VL6180X_ATY_Dev* dev);
    60. 

  60. uint8_t VL6180X_SetOffset(uint8_t offset, struct VL6180X_ATY_Dev* dev);
    61. 

  61. uint8_t VL6180X_SetAddress(uint8_t newAddr, struct VL6180X_ATY_Dev* dev);
    62. 

  62. uint8_t VL6180X_Clear_Interrupts(struct VL6180X_ATY_Dev* dev);
    63. 

  63. uint8_t VL6180X_IsDeviceReady(struct VL6180X_ATY_Dev* dev);
    64. 

  64. uint8_t VL6180X_WaitDeviceReady(struct VL6180X_ATY_Dev* dev);
    65. 

  65. uint8_t VL6180X_IsRangeComplete(struct VL6180X_ATY_Dev* dev);
    66. 

  66. uint8_t VL6180X_WaitRangeComplete(struct VL6180X_ATY_Dev* dev);
    67. 

  67. uint8_t VL6180X_ReadRangeStatus(uint8_t* status, struct VL6180X_ATY_Dev* dev);
    68. 

  68. uint8_t VL6180X_ReadRangeResult(uint8_t* range, struct VL6180X_ATY_Dev* dev);
    69. 

  69. uint8_t VL6180X_StartRange(struct VL6180X_ATY_Dev* dev);
    70. 

  70. uint8_t VL6180X_StartRangeContinuous(uint16_t period_ms, struct VL6180X_ATY_Dev* dev);
    71. 

  71. uint8_t VL6180X_StopRangeContinuous(struct VL6180X_ATY_Dev* dev);
    72. 

  72. uint8_t VL6180X_Init(struct VL6180X_ATY_Dev* dev);
    73. 

  73. 

  74. uint8_t VL6180X_MeasureRangeOnce(uint8_t* range, struct VL6180X_ATY_Dev* dev);
    75. 

  75. uint8_t VL6180X_MeasureRangeOnceFast(uint8_t* range, struct VL6180X_ATY_Dev* dev);
    76. 

  76. uint8_t VL6180X_ReadLux(uint8_t gain, float* lux, struct VL6180X_ATY_Dev* dev);
    77. 

  77. 

  78. uint8_t VL6180X_Config(struct VL6180X_ATY_Dev* dev);
    79. 

  79. 

  80. // device model identification number
    81. 

  81. #define VL6180X_REG_IDENTIFICATION_MODEL_ID                 0x000
    82. 

  82. #define VL6180X_REG_IDENTIFICATION_MODEL_REV_MAJOR          0x001
    83. 

  83. #define VL6180X_REG_IDENTIFICATION_MODEL_REV_MINOR          0x002
    84. 

  84. #define VL6180X_REG_IDENTIFICATION_MODULE_REV_MAJOR         0x003
    85. 

  85. #define VL6180X_REG_IDENTIFICATION_MODULE_REV_MINOR         0x004
    86. 

  86. #define VL6180X_REG_IDENTIFICATION_DATE_HI                  0x006
    87. 

  87. #define VL6180X_REG_IDENTIFICATION_DATE_LO                  0x007
    88. 

  88. #define VL6180X_REG_IDENTIFICATION_TIME                     0x008 // 8~9
    89. 

  89. #define VL6180X_REG_SYSTEM_MODE_GPIO0                       0x010
    90. 

  90. #define VL6180X_REG_SYSTEM_MODE_GPIO1                       0x011
    91. 

  91. #define VL6180X_REG_SYSTEM_HISTORY_CTRL                     0x012
    92. 

  92. #define VL6180X_REG_SYSTEM_INTERRUPT_CONFIG                 0x014
    93. 

  93. #define VL6180X_REG_SYSTEM_INTERRUPT_CLEAR                  0x015
    94. 

  94. #define VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET               0x016
    95. 

  95. #define VL6180X_REG_SYSTEM_GROUPED_PARAMETER_HOLD           0x017
    96. 

  96. #define VL6180X_REG_SYSRANGE_START                          0x018
    97. 

  97. #define VL6180X_REG_SYSRANGE_THRESH_HIGH                    0x019
    98. 

  98. #define VL6180X_REG_SYSRANGE_THRESH_LOW                     0x01A
    99. 

  99. #define VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD        0x01B
    100. 

  100. #define VL6180X_REG_SYSRANGE_MAX_CONVERGENCE_TIME           0x01C
    101. 

  101. #define VL6180X_REG_SYSRANGE_CROSSTALK_COMPENSATION_RATE    0x01E
    102. 

  102. #define VL6180X_REG_SYSRANGE_CROSSTALK_VALID_HEIGHT         0x021
    103. 

  103. #define VL6180X_REG_SYSRANGE_EARLY_CONVERGENCE_ESTIMATE     0x022
    104. 

  104. #define VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET      0x024
    105. 

  105. #define VL6180X_REG_SYSRANGE_RANGE_IGNORE_VALID_HEIGHT      0x025
    106. 

  106. #define VL6180X_REG_SYSRANGE_RANGE_IGNORE_THRESHOLD         0x026
    107. 

  107. #define VL6180X_REG_SYSRANGE_MAX_AMBIENT_LEVEL_MULT         0x02C
    108. 

  108. #define VL6180X_REG_SYSRANGE_RANGE_CHECK_ENABLES            0x02D
    109. 

  109. #define VL6180X_REG_SYSRANGE_VHV_RECALIBRATE                0x02E
    110. 

  110. #define VL6180X_REG_SYSRANGE_VHV_REPEAT_RATE                0x031
    111. 

  111. #define VL6180X_REG_RESULT_RANGE_STATUS                     0x04D
    112. 

  112. #define VL6180X_REG_RESULT_ALS_STATUS                       0x04E
    113. 

  113. #define VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO            0x04F
    114. 

  114. #define VL6180X_REG_RESULT_HISTORY_BUFFER_x                 0x052 // 52~60
    115. 

  115. #define VL6180X_REG_RESULT_RANGE_VAL                        0x062
    116. 

  116. #define VL6180X_REG_RESULT_RANGE_RAW                        0x064
    117. 

  117. #define VL6180X_REG_RESULT_RANGE_RETURN_RATE                0x066
    118. 

  118. #define VL6180X_REG_RESULT_RANGE_REFERENCE_RATE             0x068
    119. 

  119. #define VL6180X_REG_RESULT_RANGE_RETURN_SIGNAL_COUNT        0x06C
    120. 

  120. #define VL6180X_REG_RESULT_RANGE_REFERENCE_SIGNAL_COUNT     0x070
    121. 

  121. #define VL6180X_REG_RESULT_RANGE_RETURN_AMB_COUNT           0x074
    122. 

  122. #define VL6180X_REG_RESULT_RANGE_REFERENCE_AMB_COUNT        0x078
    123. 

  123. #define VL6180X_REG_RESULT_RANGE_RETURN_CONV_TIME           0x07C
    124. 

  124. #define VL6180X_REG_RESULT_RANGE_REFERENCE_CONV_TIME        0x080
    125. 

  125. #define VL6180X_REG_READOUT_AVERAGING_SAMPLE_PERIOD         0x10A
    126. 

  126. #define VL6180X_REG_FIRMWARE_BOOTUP                         0x119
    127. 

  127. #define VL6180X_REG_SLAVE_DEVICE_ADDRESS                    0x212
    128. 

  128. 

  129. // only for VL6180X below reg
    130. 

  130. #define VL6180X_REG_SYSALS_START                            0x038
    131. 

  131. #define VL6180X_REG_SYSALS_THRESH_HIGH                      0x03A
    132. 

  132. #define VL6180X_REG_SYSALS_THRESH_LOW                       0x03C
    133. 

  133. #define VL6180X_REG_SYSALS_INTERMEASUREMENT_PERIOD          0x03E
    134. 

  134. #define VL6180X_REG_SYSALS_ANALOGUE_GAIN                    0x03F
    135. 

  135. #define VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI            0x040
    136. 

  136. #define VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO            0x041
    137. 

  137. #define VL6180X_REG_RESULT_ALS_VAL                          0x050
    138. 

  138. #define VL6180X_REG_FIRMWARE_RESULT_SCALER                  0x120
    139. 

  139. #define VL6180X_REG_INTERLEAVED_MODE_ENABLE                 0x2A3
    140. 

  140. 

  141. 

  142. 

  143. #define VL6180X_ALS_GAIN_1          0x06
    144. 

  144. #define VL6180X_ALS_GAIN_1_25       0x05
    145. 

  145. #define VL6180X_ALS_GAIN_1_67       0x04
    146. 

  146. #define VL6180X_ALS_GAIN_2_5        0x03
    147. 

  147. #define VL6180X_ALS_GAIN_5          0x02
    148. 

  148. #define VL6180X_ALS_GAIN_10         0x01
    149. 

  149. #define VL6180X_ALS_GAIN_20         0x00
    150. 

  150. #define VL6180X_ALS_GAIN_40         0x07
    151. 

  151. 

  152. #define VL6180X_ERROR_NONE          0   // Success!
    153. 

  153. #define VL6180X_ERROR_SYSERR_1      1   // System error
    154. 

  154. #define VL6180X_ERROR_SYSERR_5      5   // Sysem error
    155. 

  155. #define VL6180X_ERROR_ECEFAIL       6   // Early convergence estimate fail
    156. 

  156. #define VL6180X_ERROR_NOCONVERGE    7   // No target detected
    157. 

  157. #define VL6180X_ERROR_RANGEIGNORE   8   // Ignore threshold check failed
    158. 

  158. #define VL6180X_ERROR_SNR           11  // Ambient conditions too high
    159. 

  159. #define VL6180X_ERROR_RAWUFLOW      12  // Raw range algo underflow
    160. 

  160. #define VL6180X_ERROR_RAWOFLOW      13  // Raw range algo overflow
    161. 

  161. #define VL6180X_ERROR_RANGEUFLOW    14  // Raw range algo underflow
    162. 

  162. #define VL6180X_ERROR_RANGEOFLOW    15  // Raw range algo overflow
    163. 

  163. 

  164. // Define some additional registers mentioned in application notes and we use
    165. 

  165. // period between each measurement when in continuous mode
    166. 

  166. #define SYSRANGE__INTERMEASUREMENT_PERIOD 0x001b // P19 application notes
    167. 

  167. 

  168. #endif /* __VL6180X_ATY_H */
    169. 

  169. 

  170. /******************************** End Of File *********************************/
    171.