Go to the documentation of this file.
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
53 #define TOUCHKEY4_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
63 #define TOUCHKEY4_RETVAL uint8_t
65 #define TOUCHKEY4_OK 0x00
66 #define TOUCHKEY4_INIT_ERROR 0xFF
73 #define TOUCHKEY4_MAIN_CONTROL_REG 0x00
74 #define TOUCHKEY4_GEN_STATUS_REG 0x02
75 #define TOUCHKEY4_SENS_IN_STATUS_REG 0x03
76 #define TOUCHKEY4_NOISE_FLAG_REG 0x0A
77 #define TOUCHKEY4_SENS_IN1_DELTA_CNT_REG 0x10
78 #define TOUCHKEY4_SENS_IN2_DELTA_CNT_REG 0x11
79 #define TOUCHKEY4_SENS_IN3_DELTA_CNT_REG 0x12
80 #define TOUCHKEY4_SENSITIVITY_CON_REG 0x1F
81 #define TOUCHKEY4_CONFIG_REG 0x20
82 #define TOUCHKEY4_SENS_IN_EN_REG 0x21
83 #define TOUCHKEY4_SENS_IN_CONFIG_REG 0x22
84 #define TOUCHKEY4_SENS_IN_CONFIG2_REG 0x23
85 #define TOUCHKEY4_AVRG_AND_SAMPL_CONFIG_REG 0x24
86 #define TOUCHKEY4_CALIB_ACTIVATE_REG 0x26
87 #define TOUCHKEY4_INTERR_EN_REG 0x27
88 #define TOUCHKEY4_REPEAT_RATE_EN_REG 0x28
89 #define TOUCHKEY4_SIGNAL_GUARD_EN_REG 0x29
90 #define TOUCHKEY4_MULTIPLE_TOUCH_CONFIG_REG 0x2A
91 #define TOUCHKEY4_MULTIPLE_TOUCH_PATTERN_CONFIG_REG 0x2B
92 #define TOUCHKEY4_MULTIPLE_TOUCH_PATTERN_REG 0x2D
93 #define TOUCHKEY4_BASE_CNT_LIMIT_REG 0x2E
94 #define TOUCHKEY4_RECALIB_CONFIG_REG 0x2F
95 #define TOUCHKEY4_SENS_IN1_THRESHOLD_REG 0x30
96 #define TOUCHKEY4_SENS_IN2_THRESHOLD_REG 0x31
97 #define TOUCHKEY4_SENS_IN3_THRESHOLD_REG 0x32
98 #define TOUCHKEY4_SENS_IN_NOISE_THRESHOLD_REG 0x38
99 #define TOUCHKEY4_STANDBY_CHANN_REG 0x40
100 #define TOUCHKEY4_STANDBY_CONFIG_REG 0x41
101 #define TOUCHKEY4_STANDBY_SENSITIVITY_REG 0x42
102 #define TOUCHKEY4_STANDBY_THRESHOLD_REG 0x43
103 #define TOUCHKEY4_CONFIG2_REG 0x44
104 #define TOUCHKEY4_SENS_IN1_BASE_CNT_REG 0x50
105 #define TOUCHKEY4_SENS_IN2_BASE_CNT_REG 0x51
106 #define TOUCHKEY4_SENS_IN3_BASE_CNT_REG 0x52
107 #define TOUCHKEY4_POWER_BUTTON_REG 0x60
108 #define TOUCHKEY4_POWER_BUTTON_CONFIG_REG 0x61
109 #define TOUCHKEY4_CALIB_SENSITIVITY_CONFIG_REG 0x80
110 #define TOUCHKEY4_SENS_IN1_CALIB_REG 0xB1
111 #define TOUCHKEY4_SENS_IN2_CALIB_REG 0xB2
112 #define TOUCHKEY4_SENS_IN3_CALIB_REG 0xB3
113 #define TOUCHKEY4_SENS_IN_CALIB_LSB1_REG 0xB9
114 #define TOUCHKEY4_PRODUCT_ID_REG 0xFD
115 #define TOUCHKEY4_MANUFACT_ID_REG 0xFE
116 #define TOUCHKEY4_REVISION_REG 0xFF
123 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_128X 0x00
124 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_64X 0x10
125 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_32X 0x20
126 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_16X 0x30
127 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_8X 0x40
128 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_4X 0x50
129 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_2X 0x60
130 #define TOUCHKEY4_SENSITIVITY_MULTIPLIER_1X 0x70
131 #define TOUCHKEY4_DATA_SCALING_FACTOR_1X 0x00
132 #define TOUCHKEY4_DATA_SCALING_FACTOR_2X 0x01
133 #define TOUCHKEY4_DATA_SCALING_FACTOR_4X 0x02
134 #define TOUCHKEY4_DATA_SCALING_FACTOR_8X 0x03
135 #define TOUCHKEY4_DATA_SCALING_FACTOR_16X 0x04
136 #define TOUCHKEY4_DATA_SCALING_FACTOR_32X 0x05
137 #define TOUCHKEY4_DATA_SCALING_FACTOR_64X 0x06
138 #define TOUCHKEY4_DATA_SCALING_FACTOR_128X 0x07
139 #define TOUCHKEY4_DATA_SCALING_FACTOR_256X 0x08
146 #define TOUCHKEY4_TIMEOUT_DIS 0x00
147 #define TOUCHKEY4_TIMEOUT_EN 0x80
148 #define TOUCHKEY4_DIG_NOISE_THRESHOLD_EN 0x00
149 #define TOUCHKEY4_DIG_NOISE_THRESHOLD_DIS 0x20
150 #define TOUCHKEY4_AN_NOISE_FILTER_EN 0x00
151 #define TOUCHKEY4_AN_NOISE_FILTER_DIS 0x10
152 #define TOUCHKEY4_MAX_DUR_RECALIB_DIS 0x00
153 #define TOUCHKEY4_MAX_DUR_RECALIB_EN 0x08
160 #define TOUCHKEY4_AN_CALIB_NO_RETRY 0x00
161 #define TOUCHKEY4_AN_CALIB_RETRY 0x40
162 #define TOUCHKEY4_POWER_CONSUMPTION_REDUCE_EN 0x00
163 #define TOUCHKEY4_POWER_CONSUMPTION_REDUCE_DIS 0x20
164 #define TOUCHKEY4_BASE_CNT_OUT_LIMIT_INTERR_DIS 0x00
165 #define TOUCHKEY4_BASE_CNT_OUT_LIMIT_INTERR_EN 0x10
166 #define TOUCHKEY4_SHOW_LOW_FREQ_NOISE 0x00
167 #define TOUCHKEY4_NOT_SHOW_LOW_FREQ_NOISE 0x08
168 #define TOUCHKEY4_RF_NOISE_FILTER_EN 0x00
169 #define TOUCHKEY4_RF_NOISE_FILTER_DIS 0x04
170 #define TOUCHKEY4_AN_CALIB_FAIL_INTERR_DIS 0x00
171 #define TOUCHKEY4_AN_CALIB_FAIL_INTERR_EN 0x02
172 #define TOUCHKEY4_DETECT_RELEASE_EN 0x00
173 #define TOUCHKEY4_DETECT_RELEASE_DIS 0x01
180 #define TOUCHKEY4_560MILISEC_BEFORE_RECALIB 0x00
181 #define TOUCHKEY4_840MILISEC_BEFORE_RECALIB 0x10
182 #define TOUCHKEY4_1120MILISEC_BEFORE_RECALIB 0x20
183 #define TOUCHKEY4_1400MILISEC_BEFORE_RECALIB 0x30
184 #define TOUCHKEY4_1680MILISEC_BEFORE_RECALIB 0x40
185 #define TOUCHKEY4_2240MILISEC_BEFORE_RECALIB 0x50
186 #define TOUCHKEY4_2800MILISEC_BEFORE_RECALIB 0x60
187 #define TOUCHKEY4_3360MILISEC_BEFORE_RECALIB 0x70
188 #define TOUCHKEY4_3920MILISEC_BEFORE_RECALIB 0x80
189 #define TOUCHKEY4_4480MILISEC_BEFORE_RECALIB 0x90
190 #define TOUCHKEY4_5600MILISEC_BEFORE_RECALIB 0xA0
191 #define TOUCHKEY4_6720MILISEC_BEFORE_RECALIB 0xB0
192 #define TOUCHKEY4_7840MILISEC_BEFORE_RECALIB 0xC0
193 #define TOUCHKEY4_8906MILISEC_BEFORE_RECALIB 0xD0
194 #define TOUCHKEY4_10080MILISEC_BEFORE_RECALIB 0xE0
195 #define TOUCHKEY4_11200MILISEC_BEFORE_RECALIB 0xF0
196 #define TOUCHKEY4_INTERR_REPEAT_RATE_35MILISEC 0x00
197 #define TOUCHKEY4_INTERR_REPEAT_RATE_70MILISEC 0x01
198 #define TOUCHKEY4_INTERR_REPEAT_RATE_105MILISEC 0x02
199 #define TOUCHKEY4_INTERR_REPEAT_RATE_140MILISEC 0x03
200 #define TOUCHKEY4_INTERR_REPEAT_RATE_175MILISEC 0x04
201 #define TOUCHKEY4_INTERR_REPEAT_RATE_210MILISEC 0x05
202 #define TOUCHKEY4_INTERR_REPEAT_RATE_245MILISEC 0x06
203 #define TOUCHKEY4_INTERR_REPEAT_RATE_280MILISEC 0x07
204 #define TOUCHKEY4_INTERR_REPEAT_RATE_315MILISEC 0x08
205 #define TOUCHKEY4_INTERR_REPEAT_RATE_350MILISEC 0x09
206 #define TOUCHKEY4_INTERR_REPEAT_RATE_385MILISEC 0x0A
207 #define TOUCHKEY4_INTERR_REPEAT_RATE_420MILISEC 0x0B
208 #define TOUCHKEY4_INTERR_REPEAT_RATE_455MILISEC 0x0C
209 #define TOUCHKEY4_INTERR_REPEAT_RATE_490MILISEC 0x0D
210 #define TOUCHKEY4_INTERR_REPEAT_RATE_525MILISEC 0x0E
211 #define TOUCHKEY4_INTERR_REPEAT_RATE_560MILISEC 0x0F
218 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_35MILISEC 0x00
219 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_70MILISEC 0x01
220 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_105MILISEC 0x02
221 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_140MILISEC 0x03
222 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_175MILISEC 0x04
223 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_210MILISEC 0x05
224 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_245MILISEC 0x06
225 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_280MILISEC 0x07
226 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_315MILISEC 0x08
227 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_350MILISEC 0x09
228 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_385MILISEC 0x0A
229 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_420MILISEC 0x0B
230 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_455MILISEC 0x0C
231 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_490MILISEC 0x0D
232 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_525MILISEC 0x0E
233 #define TOUCHKEY4_PRESS_AND_HOLD_EVENT_AFTER_560MILISEC 0x0F
240 #define TOUCHKEY4_1_SAMPLE 0x00
241 #define TOUCHKEY4_2_SAMPLES 0x10
242 #define TOUCHKEY4_4_SAMPLES 0x20
243 #define TOUCHKEY4_8_SAMPLES 0x30
244 #define TOUCHKEY4_16_SAMPLES 0x40
245 #define TOUCHKEY4_32_SAMPLES 0x50
246 #define TOUCHKEY4_64_SAMPLES 0x60
247 #define TOUCHKEY4_128_SAMPLES 0x70
248 #define TOUCHKEY4_SAMPLE_TIME_320MICROSEC 0x00
249 #define TOUCHKEY4_SAMPLE_TIME_640MICROSEC 0x04
250 #define TOUCHKEY4_SAMPLE_TIME_1280MICROSEC 0x08
251 #define TOUCHKEY4_SAMPLE_TIME_2560MICROSEC 0x0C
252 #define TOUCHKEY4_CYCLE_TIME_35MILISEC 0x00
253 #define TOUCHKEY4_CYCLE_TIME_70MILISEC 0x01
254 #define TOUCHKEY4_CYCLE_TIME_105MILISEC 0x02
255 #define TOUCHKEY4_CYCLE_TIME_140MILISEC 0x03
262 #define TOUCHKEY4_ALL_INPUTS_CALIB_DIS 0x00
263 #define TOUCHKEY4_INPUT1_CALIB_EN 0x01
264 #define TOUCHKEY4_INPUT2_CALIB_EN 0x02
265 #define TOUCHKEY4_INPUT3_CALIB_EN 0x04
272 #define TOUCHKEY4_ALL_INPUTS_INTERR_DIS 0x00
273 #define TOUCHKEY4_INPUT1_INTERR_EN 0x01
274 #define TOUCHKEY4_INPUT2_INTERR_EN 0x02
275 #define TOUCHKEY4_INPUT3_INTERR_EN 0x04
282 #define TOUCHKEY4_REPEAT_RATE_DIS 0x00
283 #define TOUCHKEY4_INPUT1_REPEAT_RATE_EN 0x01
284 #define TOUCHKEY4_INPUT2_REPEAT_RATE_EN 0x02
285 #define TOUCHKEY4_INPUT3_REPEAT_RATE_EN 0x04
292 #define TOUCHKEY4_SIGNAL_GUARD_DIS 0x00
293 #define TOUCHKEY4_INPUT1_SIGNAL_GUARD_EN 0x01
294 #define TOUCHKEY4_INPUT3_SIGNAL_GUARD_EN 0x04
301 #define TOUCHKEY4_MULTIPLE_BLOCK_DIS 0x00
302 #define TOUCHKEY4_MULTIPLE_BLOCK_EN 0x80
303 #define TOUCHKEY4_SIMUL_TOUCH_NUM_1 0x00
304 #define TOUCHKEY4_SIMUL_TOUCH_NUM_2 0x04
305 #define TOUCHKEY4_SIMUL_TOUCH_NUM_3 0x08
312 #define TOUCHKEY4_MULTIPLE_THRESHOLD_12_PERCENTS 0x00
313 #define TOUCHKEY4_MULTIPLE_THRESHOLD_25_PERCENTS 0x04
314 #define TOUCHKEY4_MULTIPLE_THRESHOLD_37_PERCENTS 0x08
315 #define TOUCHKEY4_MULTIPLE_THRESHOLD_100_PERCENTS 0x0C
316 #define TOUCHKEY4_MLTP_TOUCH_PATTERN 0x00
317 #define TOUCHKEY4_PATTERN_RECOGNITION 0x02
318 #define TOUCHKEY4_MLTP_EVENT_ALERT_DIS 0x00
319 #define TOUCHKEY4_MLTP_EVENT_ALERT_EN 0x01
326 #define TOUCHKEY4_MLTP_TOUCH_PATTERN_INPUTS_DIS 0x00
327 #define TOUCHKEY4_MLTP_TOUCH_PATTERN_INPUT1_EN 0x01
328 #define TOUCHKEY4_MLTP_TOUCH_PATTERN_INPUT2_EN 0x02
329 #define TOUCHKEY4_MLTP_TOUCH_PATTERN_INPUT3_EN 0x04
336 #define TOUCHKEY4_INPUTS_THRESHOLD_UPDT_INDIVIDUALY 0x00
337 #define TOUCHKEY4_INPUT1_THRESHOLD_OVERWRITE 0x80
338 #define TOUCHKEY4_ACC_INTER_DATA_CLEAR 0x00
339 #define TOUCHKEY4_ACC_INTER_DATA_NOT_CLEAR 0x40
340 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_CLEAR 0x00
341 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_NOT_CLEAR 0x20
342 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_8 0x00
343 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_16 0x08
344 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_32 0x10
345 #define TOUCHKEY4_CONS_NEG_DELTA_CNT_DIS 0x18
346 #define TOUCHKEY4_REC_SAMPLES_16_UPDT_TIME_16 0x00
347 #define TOUCHKEY4_REC_SAMPLES_32_UPDT_TIME_32 0x01
348 #define TOUCHKEY4_REC_SAMPLES_64_UPDT_TIME_64 0x02
349 #define TOUCHKEY4_REC_SAMPLES_128_UPDT_TIME_128 0x03
350 #define TOUCHKEY4_REC_SAMPLES_256_UPDT_TIME_256 0x04
351 #define TOUCHKEY4_REC_SAMPLES_256_UPDT_TIME_1024 0x05
352 #define TOUCHKEY4_REC_SAMPLES_256_UPDT_TIME_2048 0x06
353 #define TOUCHKEY4_REC_SAMPLES_256_UPDT_TIME_4096 0x07
360 #define TOUCHKEY4_AVERAGE_BASED 0x00
361 #define TOUCHKEY4_SUMMATION_BASED 0x80
368 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_128X 0x00
369 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_64X 0x01
370 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_32X 0x02
371 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_16X 0x03
372 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_8X 0x04
373 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_4X 0x05
374 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_2X 0x06
375 #define TOUCHKEY4_STBY_SENSE_MULTIPLIER_1X 0x07
382 #define TOUCHKEY4_INPUT1_POWER_BUTTON 0x00
383 #define TOUCHKEY4_INPUT2_POWER_BUTTON 0x01
384 #define TOUCHKEY4_INPUT3_POWER_BUTTON 0x02
391 #define TOUCHKEY4_STBY_POWER_BUTTON_DIS 0x00
392 #define TOUCHKEY4_STBY_POWER_BUTTON_EN 0x40
393 #define TOUCHKEY4_PWR_BUTT_TOUCH_HOLD_280MILISEC 0x00
394 #define TOUCHKEY4_PWR_BUTT_TOUCH_HOLD_560MILISEC 0x11
395 #define TOUCHKEY4_PWR_BUTT_TOUCH_HOLD_1120MILISEC 0x22
396 #define TOUCHKEY4_PWR_BUTT_TOUCH_HOLD_2240MILISEC 0x33
397 #define TOUCHKEY4_ACT_POWER_BUTTON_DIS 0x00
398 #define TOUCHKEY4_ACT_POWER_BUTTON_EN 0x04
405 #define TOUCHKEY4_GAIN_1 0x01
406 #define TOUCHKEY4_GAIN_2 0x02
407 #define TOUCHKEY4_GAIN_4 0x04
408 #define TOUCHKEY4_GAIN_8 0x08
409 #define TOUCHKEY4_SENS_INPUT_DIS 0x00
410 #define TOUCHKEY4_SENS_INPUT_EN 0x01
411 #define TOUCHKEY4_COMBO_SENS_IN_ACT_EN 0x03
412 #define TOUCHKEY4_COMBO_SENS_IN_STBY_EN 0x01
413 #define TOUCHKEY4_COMBO_SENS_IN_BOTH_MODES_EN 0x05
420 #define TOUCHKEY4_SLAVE_ADDRESS 0x28
524 const uint8_t transfer_data );
537 uint8_t *data_out,
const uint8_t n_bytes );
594 const uint8_t en_input2,
const uint8_t en_input3 );
642 #endif // _TOUCHKEY4_H_
uint8_t i2c_address
Definition: touchkey4.h:467
void touchkey4_default_cfg(touchkey4_t *ctx)
Click Default Configuration function.
void touchkey4_read_reg(touchkey4_t *ctx, const uint8_t register_address, uint8_t *data_out, const uint8_t n_bytes)
Generic Read function.
void touchkey4_set_active_mode(touchkey4_t *ctx, const uint8_t analog_gain, const uint8_t en_input1, const uint8_t en_input2, const uint8_t en_input3)
Active Mode Set function.
i2c_master_t i2c
Definition: touchkey4.h:442
uint32_t i2c_speed
Definition: touchkey4.h:466
#define TOUCHKEY4_RETVAL
Definition: touchkey4.h:63
void touchkey4_write_reg(touchkey4_t *ctx, const uint8_t register_address, const uint8_t transfer_data)
Generic Write function.
pin_name_t sda
Definition: touchkey4.h:458
uint8_t touchkey4_receive_byte(touchkey4_t *ctx, const uint8_t register_address)
Read byte function.
void touchkey4_cfg_setup(touchkey4_cfg_t *cfg)
Config Object Initialization function.
void touchkey4_set_deep_sleep_mode(touchkey4_t *ctx)
DeepSleep Mode Set function.
TOUCHKEY4_RETVAL touchkey4_init(touchkey4_t *ctx, touchkey4_cfg_t *cfg)
Initialization function.
Click ctx object definition.
Definition: touchkey4.h:435
void touchkey4_set_combo_mode(touchkey4_t *ctx, const uint8_t analog_gain, const uint8_t en_input1, const uint8_t en_input2, const uint8_t en_input3)
Combo Mode Set function.
uint8_t slave_address
Definition: touchkey4.h:446
Click configuration structure definition.
Definition: touchkey4.h:454
uint8_t touchkey4_check_interrupt(touchkey4_t *ctx)
Interrupt Check function.
void touchkey4_set_standby_mode(touchkey4_t *ctx, const uint8_t analog_gain, const uint8_t en_input1, const uint8_t en_input2, const uint8_t en_input3)
Standby Mode Set function.
pin_name_t int_pin
Definition: touchkey4.h:462
void touchkey4_detect_touch(touchkey4_t *ctx, uint8_t *input_sens)
Touch Detect function.
digital_in_t int_pin
Definition: touchkey4.h:438
pin_name_t scl
Definition: touchkey4.h:457