proximity11  2.0.0.0
proximity11.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 PROXIMITY11_H
36 #define PROXIMITY11_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define PROXIMITY11_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define PROXIMITY11_RETVAL uint8_t
77 
78 #define PROXIMITY11_OK 0x00
79 #define PROXIMITY11_INIT_ERROR 0xFF
80 
87 #define PROXIMITY11_DEVICE_ADDRESS 0x38
88 
95 #define PROXIMITY11_SYS_CTRL 0x40
96 #define PROXIMITY11_MODE_CTRL 0x41
97 #define PROXIMITY11_ALS_PS_CTRL 0x42
98 #define PROXIMITY11_PS_CTRL 0x43
99 #define PROXIMITY11_PS_DATA_LSB 0x44
100 #define PROXIMITY11_PS_DATA_MSB 0x45
101 #define PROXIMITY11_ALS_DATA0_LSB 0x46
102 #define PROXIMITY11_ALS_DATA0_MSB 0x47
103 #define PROXIMITY11_ALS_DATA1_LSB 0x48
104 #define PROXIMITY11_ALS_DATA1_MSB 0x49
105 #define PROXIMITY11_INTERRUPT 0x4A
106 #define PROXIMITY11_PS_TH_LSB 0x4B
107 #define PROXIMITY11_PS_TH_MSB 0x4C
108 #define PROXIMITY11_PS_TL_LSB 0x4D
109 #define PROXIMITY11_PS_TL_MSB 0x4E
110 #define PROXIMITY11_ALS_DATA0_TH_LSB 0x4F
111 #define PROXIMITY11_ALS_DATA0_TH_MSB 0x50
112 #define PROXIMITY11_ALS_DATA0_TL_LSB 0x51
113 #define PROXIMITY11_ALS_DATA0_TL_MSB 0x52
114 #define PROXIMITY11_PS_OFFSET_LSB 0x53
115 #define PROXIMITY11_PS_OFFSET_MSB 0x54
116 #define PROXIMITY11_MANUFACT_ID 0x92
117  // End group macro
120 // --------------------------------------------------------------- PUBLIC TYPES
127 typedef struct
128 {
129  uint8_t als_data0_gain;
130  uint8_t als_data1_gain;
132 
133 } als_data_t;
134 
138 typedef struct
139 {
140  // Input pins
141 
142  digital_in_t int_pin;
143 
144  // Modules
145 
146  i2c_master_t i2c;
147 
148  // ctx variable
149 
150  uint8_t slave_address;
151 
152  //als data object
153 
155 
156 } proximity11_t;
157 
161 typedef struct
162 {
163  // Communication gpio pins
164 
165  pin_name_t scl;
166  pin_name_t sda;
167 
168  // Additional gpio pins
169 
170  pin_name_t int_pin;
171 
172  // static variable
173 
174  uint32_t i2c_speed;
175  uint8_t i2c_address;
176 
177  // als_data default values
178 
182 
184 
185 
186  // End types group
188 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
189 
195 #ifdef __cplusplus
196 extern "C"{
197 #endif
198 
208 
218 
227 
238 void proximity11_generic_write ( proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
239 
250 void proximity11_generic_read ( proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
251 
262 
273 uint8_t proximity11_get ( proximity11_t *ctx, uint8_t register_address, uint8_t *output_buffer, uint8_t n_bytes );
274 
285 uint8_t proximity11_set ( proximity11_t *ctx, uint8_t register_address, uint8_t *input_buffer, uint8_t n_bytes );
286 
295 
306 float proximity11_convert_lx ( proximity11_t *ctx, uint16_t *input_data );
307 
316 void proximity11_get_raw_ps_als_values ( proximity11_t *ctx, uint8_t *data_buffer );
317 
327 void proximity11_get_ps_als_values ( proximity11_t *ctx, uint16_t *ps_value, float *als_value );
328 
340 uint8_t proximity11_set_ps_threshold_high ( proximity11_t *ctx, uint16_t threshold_value );
341 
353 uint8_t proximity11_set_ps_threshold_low ( proximity11_t *ctx, uint16_t threshold_value );
354 
363 void proximity11_set_als_threshold_high ( proximity11_t *ctx, uint16_t threshold_value );
364 
373 void proximity11_set_als_threshold_low ( proximity11_t *ctx, uint16_t threshold_value );
374 
386 uint8_t proximity11_set_ps_offset ( proximity11_t *ctx, uint16_t offset_value );
387 
388 #ifdef __cplusplus
389 }
390 #endif
391 #endif // _PROXIMITY11_H_
392  // End public_function group
395 
396 // ------------------------------------------------------------------------- END
proximity11_set_als_threshold_high
void proximity11_set_als_threshold_high(proximity11_t *ctx, uint16_t threshold_value)
Setting High Als threshold value.
proximity11_t::slave_address
uint8_t slave_address
Definition: proximity11.h:150
proximity11_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity11.h:170
proximity11_cfg_setup
void proximity11_cfg_setup(proximity11_cfg_t *cfg)
Config Object Initialization function.
als_data_t
Definition: proximity11.h:128
proximity11_set
uint8_t proximity11_set(proximity11_t *ctx, uint8_t register_address, uint8_t *input_buffer, uint8_t n_bytes)
Proximity value set function.
proximity11_default_cfg
uint8_t proximity11_default_cfg(proximity11_t *ctx)
Click Default Configuration function.
proximity11_t::int_pin
digital_in_t int_pin
Definition: proximity11.h:142
als_data_t::als_data1_gain
uint8_t als_data1_gain
Definition: proximity11.h:130
als_data_t::als_measure_time
uint16_t als_measure_time
Definition: proximity11.h:131
proximity11_set_ps_threshold_low
uint8_t proximity11_set_ps_threshold_low(proximity11_t *ctx, uint16_t threshold_value)
Setting Low PS threshold value.
proximity11_init
PROXIMITY11_RETVAL proximity11_init(proximity11_t *ctx, proximity11_cfg_t *cfg)
Initialization function.
proximity11_cfg_t
Click configuration structure definition.
Definition: proximity11.h:162
proximity11_update
void proximity11_update(proximity11_t *ctx)
Updating data for Lux calculation.
proximity11_set_ps_threshold_high
uint8_t proximity11_set_ps_threshold_high(proximity11_t *ctx, uint16_t threshold_value)
Setting High PS threshold value.
proximity11_cfg_t::als_data0_gain_cfg
uint8_t als_data0_gain_cfg
Definition: proximity11.h:179
proximity11_generic_write
void proximity11_generic_write(proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
proximity11_t::i2c
i2c_master_t i2c
Definition: proximity11.h:146
proximity11_cfg_t::scl
pin_name_t scl
Definition: proximity11.h:165
PROXIMITY11_RETVAL
#define PROXIMITY11_RETVAL
Definition: proximity11.h:76
proximity11_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity11.h:175
proximity11_set_als_threshold_low
void proximity11_set_als_threshold_low(proximity11_t *ctx, uint16_t threshold_value)
Setting Low Als threshold value.
proximity11_int_get
uint8_t proximity11_int_get(proximity11_t *ctx)
Int pin get functuin.
proximity11_cfg_t::als_data1_gain_cfg
uint8_t als_data1_gain_cfg
Definition: proximity11.h:180
proximity11_convert_lx
float proximity11_convert_lx(proximity11_t *ctx, uint16_t *input_data)
Converting raw data to Lux.
proximity11_cfg_t::als_measure_time_cfg
uint16_t als_measure_time_cfg
Definition: proximity11.h:181
proximity11_get
uint8_t proximity11_get(proximity11_t *ctx, uint8_t register_address, uint8_t *output_buffer, uint8_t n_bytes)
Proximity value get function.
proximity11_get_raw_ps_als_values
void proximity11_get_raw_ps_als_values(proximity11_t *ctx, uint8_t *data_buffer)
Getting raw ALS and PS data.
proximity11_t
Click ctx object definition.
Definition: proximity11.h:139
proximity11_t::als
als_data_t als
Definition: proximity11.h:154
proximity11_generic_read
void proximity11_generic_read(proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
proximity11_cfg_t::sda
pin_name_t sda
Definition: proximity11.h:166
proximity11_set_ps_offset
uint8_t proximity11_set_ps_offset(proximity11_t *ctx, uint16_t offset_value)
Setting PS offset value.
als_data_t::als_data0_gain
uint8_t als_data0_gain
Definition: proximity11.h:129
proximity11_get_ps_als_values
void proximity11_get_ps_als_values(proximity11_t *ctx, uint16_t *ps_value, float *als_value)
Getting ALS and PS values.
proximity11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity11.h:174