color13  2.0.0.0
color13.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef COLOR13_H
29 #define COLOR13_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define COLOR13_REG_MAIN_CTRL 0x00
70 #define COLOR13_REG_PS_VCSEL 0x01
71 #define COLOR13_REG_PS_PULSES 0x02
72 #define COLOR13_REG_PS_MEASRATE 0x03
73 #define COLOR13_REG_LS_MEAS_RATE 0x04
74 #define COLOR13_REG_LS_GAIN 0x05
75 #define COLOR13_REG_PART_ID 0x06
76 #define COLOR13_REG_MAIN_STATUS 0x07
77 #define COLOR13_REG_PS_DATA_0 0x08
78 #define COLOR13_REG_PS_DATA_1 0x09
79 #define COLOR13_REG_LS_DATA_IR_0 0x0A
80 #define COLOR13_REG_LS_DATA_IR_1 0x0B
81 #define COLOR13_REG_LS_DATA_IR_2 0x0C
82 #define COLOR13_REG_LS_DATA_GREEN_0 0x0D
83 #define COLOR13_REG_LS_DATA_GREEN_1 0x0E
84 #define COLOR13_REG_LS_DATA_GREEN_2 0x0F
85 #define COLOR13_REG_LS_DATA_BLUE_0 0x10
86 #define COLOR13_REG_LS_DATA_BLUE_1 0x11
87 #define COLOR13_REG_LS_DATA_BLUE_2 0x12
88 #define COLOR13_REG_LS_DATA_RED_0 0x13
89 #define COLOR13_REG_LS_DATA_RED_1 0x14
90 #define COLOR13_REG_LS_DATA_RED_2 0x15
91 #define COLOR13_REG_INT_CFG 0x19
92 #define COLOR13_REG_INT_PST 0x1A
93 #define COLOR13_REG_PS_THRES_UP_0 0x1B
94 #define COLOR13_REG_PS_THRES_UP_1 0x1C
95 #define COLOR13_REG_PS_THRES_LOW_0 0x1D
96 #define COLOR13_REG_PS_THRES_LOW_1 0x1E
97 #define COLOR13_REG_PS_CAN_0 0x1F
98 #define COLOR13_REG_PS_CAN_1_ANA 0x20
99 #define COLOR13_REG_LS_THRES_UP_0 0x21
100 #define COLOR13_REG_LS_THRES_UP_1 0x22
101 #define COLOR13_REG_LS_THRES_UP_2 0x23
102 #define COLOR13_REG_LS_THRES_LOW_0 0x24
103 #define COLOR13_REG_LS_THRES_LOW_1 0x25
104 #define COLOR13_REG_LS_THRES_LOW_2 0x26
105 #define COLOR13_REG_LS_THRES_VAR 0x27
106  // color13_reg
108 
123 #define COLOR13_ID 0xC2
124 
125 
131 #define COLOR13_SET_DEV_ADDR 0x52
132  // color13_set
134 
149 #define COLOR13_MAP_MIKROBUS( cfg, mikrobus ) \
150  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
151  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
152  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
153  // color13_map // color13
156 
161 typedef struct
162 {
163  // Input pins
164  digital_in_t int_pin;
166  // Modules
167  i2c_master_t i2c;
169  // I2C slave address
170  uint8_t slave_address;
172  // ALS resolution
174 
175 } color13_t;
176 
181 typedef struct
182 {
183  pin_name_t scl;
184  pin_name_t sda;
186  pin_name_t int_pin;
188  uint32_t i2c_speed;
189  uint8_t i2c_address;
191 } color13_cfg_t;
192 
197 typedef struct
198 {
199  uint32_t red;
200  uint32_t green;
201  uint32_t blue;
202  uint32_t ir;
203 
205 
210 typedef enum
211 {
216  COLOR13_ERROR_CFG = -4
217 
219 
236 
250 err_t color13_init ( color13_t *ctx, color13_cfg_t *cfg );
251 
266 err_t color13_generic_write ( color13_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
267 
282 err_t color13_generic_read ( color13_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
283 
291 uint8_t color13_get_int ( color13_t *ctx );
292 
309 err_t color13_get_proximity ( color13_t *ctx, uint16_t *ps_data );
310 
330 err_t color13_get_als ( color13_t *ctx, float *als_data );
331 
351 err_t color13_ls_color ( color13_t *ctx, uint8_t ls_reg, uint32_t *ls_data );
352 
369 err_t color13_get_rgb_ir ( color13_t *ctx, color13_color_t *color_data );
370 
381 
382 #ifdef __cplusplus
383 }
384 #endif
385 #endif // COLOR13_H
386  // color13
388 
389 // ------------------------------------------------------------------------ END
color13_cfg_setup
void color13_cfg_setup(color13_cfg_t *cfg)
Color 13 configuration object setup function.
color13_ls_color
err_t color13_ls_color(color13_t *ctx, uint8_t ls_reg, uint32_t *ls_data)
Read ls data from color registers.
COLOR13_ERROR_PARAM
@ COLOR13_ERROR_PARAM
Definition: color13.h:215
color13_get_proximity
err_t color13_get_proximity(color13_t *ctx, uint16_t *ps_data)
Read proximity data from device.
color13_generic_read
err_t color13_generic_read(color13_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Color 13 I2C reading function.
color13_get_rgb_ir
err_t color13_get_rgb_ir(color13_t *ctx, color13_color_t *color_data)
Read color data from device.
COLOR13_ERROR_OVF
@ COLOR13_ERROR_OVF
Definition: color13.h:214
color13_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: color13.h:188
color13_t::slave_address
uint8_t slave_address
Definition: color13.h:170
color13_color_t::red
uint32_t red
Definition: color13.h:199
color13_get_int
uint8_t color13_get_int(color13_t *ctx)
Get interrupt pin state.
color13_color_t::blue
uint32_t blue
Definition: color13.h:201
color13_t::lux_resolution
float lux_resolution
Definition: color13.h:173
COLOR13_OK
@ COLOR13_OK
Definition: color13.h:212
color13_color_t
Color 13 color data object.
Definition: color13.h:198
color13_t::i2c
i2c_master_t i2c
Definition: color13.h:167
color13_t::int_pin
digital_in_t int_pin
Definition: color13.h:164
color13_init
err_t color13_init(color13_t *ctx, color13_cfg_t *cfg)
Color 13 initialization function.
color13_return_value_t
color13_return_value_t
Color 13 Click return value data.
Definition: color13.h:211
color13_get_als_resolution
float color13_get_als_resolution(color13_t *ctx)
Get resolution for the lux calculation.
color13_generic_write
err_t color13_generic_write(color13_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Color 13 I2C writing function.
color13_cfg_t::i2c_address
uint8_t i2c_address
Definition: color13.h:189
color13_get_als
err_t color13_get_als(color13_t *ctx, float *als_data)
Read lux data from device.
color13_cfg_t::int_pin
pin_name_t int_pin
Definition: color13.h:186
COLOR13_ERROR_CFG
@ COLOR13_ERROR_CFG
Definition: color13.h:216
color13_color_t::ir
uint32_t ir
Definition: color13.h:202
color13_color_t::green
uint32_t green
Definition: color13.h:200
COLOR13_ERROR
@ COLOR13_ERROR
Definition: color13.h:213
color13_t
Color 13 Click context object.
Definition: color13.h:162
color13_cfg_t::sda
pin_name_t sda
Definition: color13.h:184
color13_cfg_t::scl
pin_name_t scl
Definition: color13.h:183
color13_cfg_t
Color 13 Click configuration object.
Definition: color13.h:182