proximity8 2.0.0.0
proximity8.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef PROXIMITY8_H
36#define PROXIMITY8_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define PROXIMITY8_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62#define PROXIMITY8_RETVAL uint8_t
63
64#define PROXIMITY8_OK 0x00
65#define PROXIMITY8_INIT_ERROR 0xFF
72#define PROXIMITY8_REG_PS_CONFIG_12 0x03
73#define PROXIMITY8_REG_PS_CONFIG_34 0x04
74#define PROXIMITY8_REG_THRESHOLD_LOW 0x05
75#define PROXIMITY8_REG_THRESHOLD_HIGH 0x06
76#define PROXIMITY8_REG_CANCELLATION_LEVEL 0x07
77#define PROXIMITY8_REG_PS_CONFIG_5 0x08
78#define PROXIMITY8_REG_PROX_DATA 0xF2
79#define PROXIMITY8_REG_INTERRUPT_FLAG 0xF3
80#define PROXIMITY8_REG_DEVICE_ID 0xF4
87#define PROXIMITY8_CFG12_PS_IT_1T 0x0000
88#define PROXIMITY8_CFG12_PS_IT_2T 0x4000
89#define PROXIMITY8_CFG12_PS_IT_4T 0x8000
90#define PROXIMITY8_CFG12_PS_IT_8T 0xC000
91#define PROXIMITY8_CFG12_MPS_1 0x0000
92#define PROXIMITY8_CFG12_MPS_2 0x1000
93#define PROXIMITY8_CFG12_MPS_4 0x2000
94#define PROXIMITY8_CFG12_MPS_8 0x3000
95#define PROXIMITY8_CFG12_ITB_25us 0x0000
96#define PROXIMITY8_CFG12_ITB_50us 0x0800
97#define PROXIMITY8_CFG12_PERIOD_8ms 0x0000
98#define PROXIMITY8_CFG12_PERIOD_16ms 0x0040
99#define PROXIMITY8_CFG12_PERIOD_32ms 0x0080
100#define PROXIMITY8_CFG12_PERIOD_64ms 0x00C0
101#define PROXIMITY8_CFG12_PERS_1 0x0000
102#define PROXIMITY8_CFG12_PERS_2 0x0010
103#define PROXIMITY8_CFG12_PERS_3 0x0020
104#define PROXIMITY8_CFG12_PERS_4 0x0030
105#define PROXIMITY8_CFG12_INT_ENABLE 0x0008
106#define PROXIMITY8_CFG12_INT_DISABLE 0x0004
107#define PROXIMITY8_CFG12_SMART_PERS_DISABLE 0x0000
108#define PROXIMITY8_CFG12_SMART_PERS_ENABLE 0x0002
109#define PROXIMITY8_CFG12_SD_POWER_ON 0x0000
110#define PROXIMITY8_CFG12_SD_SHUT_DOWN 0x0001
117#define PROXIMITY8_CFG34_OFF_SUNLIGHT_CANCEL 0x0000
118#define PROXIMITY8_CFG34_ON_SUNLIGHT_CANCEL 0x8000
119#define PROXIMITY8_CFG34_SC_CUR_X1 0x0000
120#define PROXIMITY8_CFG34_SC_CUR_X2 0x2000
121#define PROXIMITY8_CFG34_SC_CUR_X4 0x4000
122#define PROXIMITY8_CFG34_SC_CUR_X8 0x6000
123#define PROXIMITY8_CFG34_PS_OUTPUT_12bit 0x0000
124#define PROXIMITY8_CFG34_PS_OUTPUT_16bit 0x1000
125#define PROXIMITY8_CFG34_VCSEL_I_7mA 0x0000
126#define PROXIMITY8_CFG34_VCSEL_I_11mA 0x0100
127#define PROXIMITY8_CFG34_VCSEL_I_14mA 0x0200
128#define PROXIMITY8_CFG34_VCSEL_I_17mA 0x0300
129#define PROXIMITY8_CFG34_VCSEL_I_20mA 0x0400
130#define PROXIMITY8_CFG34_AF_MODE_AUTO 0x0000
131#define PROXIMITY8_CFG34_AF_MODE_FORCE 0x0040
132#define PROXIMITY8_CFG34_FOR_TRIG_ACTIVE 0x0000
133#define PROXIMITY8_CFG34_FOR_TRIG_ONE_TIME 0x0020
140#define PROXIMITY8_DEVICE_ID 0x0588
141#define PROXIMITY8_DEVICE_SLAVE_ADDRESS 0x60 // End group macro
145// --------------------------------------------------------------- PUBLIC TYPES
154typedef struct
155{
156 // Input pins
157
158 digital_in_t int_pin;
159
160 // Modules
161
162 i2c_master_t i2c;
163
164 // ctx variable
165
167
169
173typedef struct
174{
175 // Communication gpio pins
176
177 pin_name_t scl;
178 pin_name_t sda;
179
180 // Additional gpio pins
181
182 pin_name_t int_pin;
183
184 // static variable
185
186 uint32_t i2c_speed;
187 uint8_t i2c_address;
188
190 // End types group
192// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
193
199#ifdef __cplusplus
200extern "C"{
201#endif
202
212
222
231
242void proximity8_generic_write ( proximity8_t *ctx, uint8_t reg, uint16_t *data_buf, uint8_t len );
243
253void proximity8_generic_read ( proximity8_t *ctx, uint8_t reg, uint16_t *data_buf );
254
265
266#ifdef __cplusplus
267}
268#endif
269#endif // _PROXIMITY8_H_
270 // End public_function group
273
274// ------------------------------------------------------------------------- END
#define PROXIMITY8_RETVAL
Definition: proximity8.h:62
void proximity8_generic_read(proximity8_t *ctx, uint8_t reg, uint16_t *data_buf)
Generic read function.
void proximity8_cfg_setup(proximity8_cfg_t *cfg)
Config Object Initialization function.
void proximity8_default_cfg(proximity8_t *ctx)
Click Default Configuration function.
uint8_t proximity8_get_interrupt_state(proximity8_t *ctx)
Get interrupt state on the INT pin.
void proximity8_generic_write(proximity8_t *ctx, uint8_t reg, uint16_t *data_buf, uint8_t len)
Generic write function.
PROXIMITY8_RETVAL proximity8_init(proximity8_t *ctx, proximity8_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: proximity8.h:174
uint32_t i2c_speed
Definition: proximity8.h:186
pin_name_t scl
Definition: proximity8.h:177
pin_name_t int_pin
Definition: proximity8.h:182
pin_name_t sda
Definition: proximity8.h:178
uint8_t i2c_address
Definition: proximity8.h:187
Click ctx object definition.
Definition: proximity8.h:155
digital_in_t int_pin
Definition: proximity8.h:158
i2c_master_t i2c
Definition: proximity8.h:162
uint8_t slave_address
Definition: proximity8.h:166