Go to the documentation of this file.
39 #include "mikrosdk_version.h"
42 #if mikroSDK_GET_VERSION < 20800ul
43 #include "rcu_delays.h"
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
63 #define PROXIMITY10_MAP_MIKROBUS( cfg, mikrobus ) \
64 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
73 #define PROXIMITY10_RETVAL uint8_t
75 #define PROXIMITY10_OK 0x00
76 #define PROXIMITY10_INIT_ERROR 0xFF
83 #define PROXIMITY10_DEFAULT_DEV_ADDR 0x5A
90 #define PROXIMITY10_PART_ID_REG 0x00
91 #define PROXIMITY10_REV_ID_REG 0x01
92 #define PROXIMITY10_SEQ_ID_REG 0x02
93 #define PROXIMITY10_INT_CFG_REG 0x03
94 #define PROXIMITY10_IRQ_EN_REG 0x04
95 #define PROXIMITY10_IRQ_MODE1_REG 0x05
96 #define PROXIMITY10_IRQ_MODE2_REG 0x06
97 #define PROXIMITY10_HW_KEY_REG 0x07
98 #define PROXIMITY10_MEAS_RATE_REG 0x08
99 #define PROXIMITY10_ALS_RATE_REG 0x09
100 #define PROXIMITY10_PS_RATE_REG 0x0A
101 #define PROXIMITY10_ALS_LOW_TH_REG 0x0B
102 #define PROXIMITY10_ALS_HIGH_TH_REG 0x0D
103 #define PROXIMITY10_PS_LED21_REG 0x0F
104 #define PROXIMITY10_PS_LED3_REG 0x10
105 #define PROXIMITY10_PS1_TH_REG 0x11
106 #define PROXIMITY10_PS2_TH_REG 0x13
107 #define PROXIMITY10_PS3_TH_REG 0x15
108 #define PROXIMITY10_PARAM_WR_REG 0x17
109 #define PROXIMITY10_COMMAND_REG 0x18
110 #define PROXIMITY10_RESPONSE_REG 0x20
111 #define PROXIMITY10_IRQ_STATUS_REG 0x21
112 #define PROXIMITY10_ALS_VIS_DATA_REG 0x22
113 #define PROXIMITY10_ALS_IR_DATA_REG 0x24
114 #define PROXIMITY10_PS1_DATA_REG 0x26
115 #define PROXIMITY10_PS2_DATA_REG 0x28
116 #define PROXIMITY10_PS3_DATA_REG 0x2A
117 #define PROXIMITY10_AUX_DATA_REG 0x2C
118 #define PROXIMITY10_PARAM_RD_REG 0x2E
119 #define PROXIMITY10_CHIP_STATUS_REG 0x30
120 #define PROXIMITY10_ANA_IN_KEY_REG 0x3B
127 #define PROXIMITY10_INT_HOST_CLEAR 0x00
128 #define PROXIMITY10_INT_AUTO_CLEAR 0x02
129 #define PROXIMITY10_INT_PIN_EN 0x01
131 #define PROXIMITY10_CMD_INT_EN 0x20
132 #define PROXIMITY10_PS3_INT_EN 0x10
133 #define PROXIMITY10_PS2_INT_EN 0x08
134 #define PROXIMITY10_PS1_INT_EN 0x04
135 #define PROXIMITY10_ALS_INT1_EN 0x02
136 #define PROXIMITY10_ALS_INT0_EN 0x01
137 #define PROXIMITY10_ALL_INT_DIS 0x00
139 #define PROXIMITY10_PS2_INT_MEAS_COMPLETE 0x00
140 #define PROXIMITY10_PS2_INT_MEAS_CROSS_TH 0x40
141 #define PROXIMITY10_PS2_INT_MEAS_GREATER_TH 0xC0
142 #define PROXIMITY10_PS1_INT_MEAS_COMPLETE 0x00
143 #define PROXIMITY10_PS1_INT_MEAS_CROSS_TH 0x10
144 #define PROXIMITY10_PS1_INT_MEAS_GREATER_TH 0x30
145 #define PROXIMITY10_CMD_INT_RESP_WRITTEN 0x00
146 #define PROXIMITY10_CMD_INT_RESP_ERROR 0x04
147 #define PROXIMITY10_PS3_INT_MEAS_COMPLETE 0x00
148 #define PROXIMITY10_PS3_INT_MEAS_CROSS_TH 0x01
149 #define PROXIMITY10_PS3_INT_MEAS_GREATER_TH 0x03
151 #define PROXIMITY10_HW_KEY 0x17
153 #define PROXIMITY10_DEV_WAKEUP_EVERY_10MS 0x84
154 #define PROXIMITY10_DEV_WAKEUP_EVERY_20MS 0x94
155 #define PROXIMITY10_DEV_WAKEUP_EVERY_100MS 0xB9
156 #define PROXIMITY10_DEV_WAKEUP_EVERY_496MS 0xDF
157 #define PROXIMITY10_DEV_WAKEUP_EVERY_1984MS 0xFF
159 #define PROXIMITY10_AUTONOM_MEAS_DIS 0x00
160 #define PROXIMITY10_MEAS_AFTER_EVERY_WAKEUP 0x08
161 #define PROXIMITY10_MEAS_AFTER_10_TIMES_WAKEUP 0x32
162 #define PROXIMITY10_MEAS_AFTER_100_TIMES_WAKEUP 0x69
164 #define PROXIMITY10_LED_NO_CURRENT 0x00
165 #define PROXIMITY10_LED_MIN_CURRENT 0x01
166 #define PROXIMITY10_LED_MAX_CURRENT 0x0F
173 #define PROXIMITY10_INVALID_CMD_ENCOUNT 0x80
174 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS1 0x88
175 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS2 0x89
176 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS3 0x8A
177 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_ALS_VIS 0x8C
178 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_ALS_IR 0x8D
179 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_AUX 0x8E
186 #define PROXIMITY10_CMD_INT_FLAG 0x20
187 #define PROXIMITY10_PS3_INT_FLAG 0x10
188 #define PROXIMITY10_PS2_INT_FLAG 0x08
189 #define PROXIMITY10_PS1_INT_FLAG 0x04
190 #define PROXIMITY10_ALS_INT_FLAG 0x03
191 #define PROXIMITY10_INT_CLEARED 0x00
193 #define PROXIMITY10_RUNNING_FLAG 0x04
194 #define PROXIMITY10_SUSPEND_FLAG 0x02
195 #define PROXIMITY10_SLEEP_FLAG 0x01
202 #define PROXIMITY10_I2C_ADDR_PARAM 0x00
203 #define PROXIMITY10_CHLIST_PARAM 0x01
204 #define PROXIMITY10_PSLED12_SEL_PARAM 0x02
205 #define PROXIMITY10_PSLED3_SEL_PARAM 0x03
206 #define PROXIMITY10_PS_ENCODING_PARAM 0x05
207 #define PROXIMITY10_ALS_ENCODING_PARAM 0x06
208 #define PROXIMITY10_PS1_ADCMUX_PARAM 0x07
209 #define PROXIMITY10_PS2_ADCMUX_PARAM 0x08
210 #define PROXIMITY10_PS3_ADCMUX_PARAM 0x09
211 #define PROXIMITY10_PS_ADC_COUNT_PARAM 0x0A
212 #define PROXIMITY10_PS_ADC_GAIN_PARAM 0x0B
213 #define PROXIMITY10_PS_ADC_MISC_PARAM 0x0C
214 #define PROXIMITY10_ALS_IR_ADCMUX_PARAM 0x0E
215 #define PROXIMITY10_AUX_ADCMUX_PARAM 0x0F
216 #define PROXIMITY10_ALS_VIS_ADC_COUNT_PARAM 0x10
217 #define PROXIMITY10_ALS_VIS_ADC_GAIN_PARAM 0x11
218 #define PROXIMITY10_ALS_VIS_ADC_MISC_PARAM 0x12
219 #define PROXIMITY10_ALS_HYST_PARAM 0x16
220 #define PROXIMITY10_PS_HYST_PARAM 0x17
221 #define PROXIMITY10_PS_HISTORY_PARAM 0x18
222 #define PROXIMITY10_ALS_HISTORY_PARAM 0x19
223 #define PROXIMITY10_ADC_OFFSET_PARAM 0x1A
224 #define PROXIMITY10_LED_REC_PARAM 0x1C
225 #define PROXIMITY10_ALS_IR_ADC_COUNT_PARAM 0x1D
226 #define PROXIMITY10_ALS_IR_ADC_GAIN_PARAM 0x1E
227 #define PROXIMITY10_ALS_IR_ADC_MISC_PARAM 0x1F
234 #define PROXIMITY10_EN_AUX 0x40
235 #define PROXIMITY10_EN_ALS_IR 0x20
236 #define PROXIMITY10_EN_ALS_VIS 0x10
237 #define PROXIMITY10_EN_PS3 0x04
238 #define PROXIMITY10_EN_PS2 0x02
239 #define PROXIMITY10_EN_PS1 0x01
241 #define PROXIMITY10_NO_LED_DRIVE 0x00
242 #define PROXIMITY10_LED1_DRIVE_EN 0x01
243 #define PROXIMITY10_LED2_DRIVE_EN 0x02
244 #define PROXIMITY10_LED3_DRIVE_EN 0x04
246 #define PROXIMITY10_ADC_REC_1_CLOCK 0x00
247 #define PROXIMITY10_ADC_REC_7_CLOCK 0x10
248 #define PROXIMITY10_ADC_REC_15_CLOCK 0x20
249 #define PROXIMITY10_ADC_REC_31_CLOCK 0x30
250 #define PROXIMITY10_ADC_REC_63_CLOCK 0x40
251 #define PROXIMITY10_ADC_REC_127_CLOCK 0x50
252 #define PROXIMITY10_ADC_REC_255_CLOCK 0x60
253 #define PROXIMITY10_ADC_REC_511_CLOCK 0x70
255 #define PROXIMITY10_ADC_CLOCK_DIV_1 0x00
256 #define PROXIMITY10_ADC_CLOCK_DIV_2 0x01
257 #define PROXIMITY10_ADC_CLOCK_DIV_4 0x02
258 #define PROXIMITY10_ADC_CLOCK_DIV_8 0x03
259 #define PROXIMITY10_ADC_CLOCK_DIV_16 0x04
260 #define PROXIMITY10_ADC_CLOCK_DIV_32 0x05
261 #define PROXIMITY10_ADC_CLOCK_DIV_64 0x06
262 #define PROXIMITY10_ADC_CLOCK_DIV_128 0x07
264 #define PROXIMITY10_NORMAL_SIGNAL_RANGE 0x00
265 #define PROXIMITY10_HIGH_SIGNAL_RANGE 0x20
266 #define PROXIMITY10_RAW_ADC_MEAS_MODE 0x00
267 #define PROXIMITY10_NORMAL_PROX_MEAS_MODE 0x04
269 #define PROXIMITY10_ADC_INPUT_SMALL_IR 0x00
270 #define PROXIMITY10_ADC_INPUT_LARGE_IR 0x03
271 #define PROXIMITY10_ADC_INPUT_VIS_PHOTODIODE 0x02
272 #define PROXIMITY10_ADC_INPUT_NO_PHOTODIODE 0x06
273 #define PROXIMITY10_ADC_INPUT_GND 0x25
274 #define PROXIMITY10_ADC_INPUT_TEMP 0x65
275 #define PROXIMITY10_ADC_INPUT_VDD 0x75
277 #define PROXIMITY10_2_CONS_SAMPLES 0x03
278 #define PROXIMITY10_3_CONS_SAMPLES 0x07
279 #define PROXIMITY10_8_CONS_SAMPLES 0xFF
286 #define PROXIMITY10_PARAM_QUERY_CMD 0x80
287 #define PROXIMITY10_PARAM_SET_CMD 0xA0
288 #define PROXIMITY10_PARAM_AND_CMD 0xC0
289 #define PROXIMITY10_PARAM_OR_CMD 0xE0
290 #define PROXIMITY10_NOP_CMD 0x00
291 #define PROXIMITY10_RESET_CMD 0x01
292 #define PROXIMITY10_BUSADDR_CMD 0x02
293 #define PROXIMITY10_PS_FORCE_CMD 0x05
294 #define PROXIMITY10_ALS_FORCE_CMD 0x06
295 #define PROXIMITY10_PSALS_FORCE_CMD 0x07
296 #define PROXIMITY10_PS_PAUSE_CMD 0x09
297 #define PROXIMITY10_ALS_PAUSE_CMD 0x0A
298 #define PROXIMITY10_PSALS_PAUSE_CMD 0x0B
299 #define PROXIMITY10_PS_AUTO_CMD 0x0D
300 #define PROXIMITY10_ALS_AUTO_CMD 0x0E
301 #define PROXIMITY10_PSALS_AUTO_CMD 0x0F
308 #define PROXIMITY10_INT_CLEAR_DIS 0x00
309 #define PROXIMITY10_INT_CLEAR_EN 0x01
310 #define PROXIMITY10_CLEAR_INT_CMD 0xFF
317 #define PROXIMITY10_OK 0x00
318 #define PROXIMITY10_INVALID_REG_ADDR 0x01
319 #define PROXIMITY10_INVALID_PARAM_ADDR 0x02
320 #define PROXIMITY10_INVALID_CMD 0x03
544 #endif // _PROXIMITY10_H_
pin_name_t scl
Definition: proximity10.h:356
uint8_t proximity10_param_or(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter OR function.
uint8_t proximity10_check_chip_status(proximity10_t *ctx, uint8_t bit_mask)
Check Chip Status function.
i2c_master_t i2c
Definition: proximity10.h:341
uint8_t proximity10_generic_read(proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void proximity10_cfg_setup(proximity10_cfg_t *cfg)
Config Object Initialization function.
#define PROXIMITY10_RETVAL
Definition: proximity10.h:73
uint8_t proximity10_param_and(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter AND function.
uint8_t proximity10_param_query(proximity10_t *ctx, uint8_t param_addr)
Parameter Query function.
Click configuration structure definition.
Definition: proximity10.h:353
uint8_t proximity10_generic_write(proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
digital_in_t int_pin
Definition: proximity10.h:337
uint32_t i2c_speed
Definition: proximity10.h:365
uint8_t i2c_address
Definition: proximity10.h:366
pin_name_t int_pin
Definition: proximity10.h:361
uint8_t slave_address
Definition: proximity10.h:345
PROXIMITY10_RETVAL proximity10_init(proximity10_t *ctx, proximity10_cfg_t *cfg)
Initialization function.
uint8_t proximity10_check_int_status(proximity10_t *ctx, uint8_t bit_mask, uint8_t clear_en)
Check INT Flags function.
uint8_t proximity10_check_int_pin(proximity10_t *ctx)
Check INT Pin function.
uint8_t proximity10_param_set(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter Set function.
void proximity10_default_cfg(proximity10_t *ctx)
Click Default Configuration function.
Click ctx object definition.
Definition: proximity10.h:334
uint8_t proximity10_send_command(proximity10_t *ctx, uint8_t prox_command)
Command Send function.
pin_name_t sda
Definition: proximity10.h:357