color17  2.1.0.0
color17.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 COLOR17_H
29 #define COLOR17_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define COLOR17_REG_CH0_EXP_RESMSB 0x00
60 #define COLOR17_REG_CH0_RESMSB_CNT_CRC 0x01
61 #define COLOR17_REG_CH1_EXP_RES_MSB 0x02
62 #define COLOR17_REG_CH1_RESMSB_CNT_CRC 0x03
63 #define COLOR17_REG_CH2_EXP_RES_MSB 0x04
64 #define COLOR17_REG_CH2_RESMSB_CNT_CRC 0x05
65 #define COLOR17_REG_CH3_EXP_RES_MSB 0x06
66 #define COLOR17_REG_CH4_RESMSB_CNT_CRC 0x07
67 #define COLOR17_REG_THLD_EXP_RES_L 0x08
68 #define COLOR17_REG_THLD_EXP_RES_H 0x09
69 #define COLOR17_REG_CONFIG_0 0x0A
70 #define COLOR17_REG_CONFIG_1 0x0B
71 #define COLOR17_REG_CONFIG_2 0x0C
72 #define COLOR17_REG_DEVICE_ID 0x11
73  // color17_reg
75 
90 #define COLOR17_DEVICE_ID 0x0821u
91 
96 #define COLOR17_CONFIG_0_QWAKE_DIS 0x00
97 #define COLOR17_CONFIG_0_QWAKE_EN 0x01
98 #define COLOR17_CONFIG_0_RANGE_2_2klux 0x00
99 #define COLOR17_CONFIG_0_RANGE_4_5klux 0x01
100 #define COLOR17_CONFIG_0_RANGE_9klux 0x02
101 #define COLOR17_CONFIG_0_RANGE_18klux 0x03
102 #define COLOR17_CONFIG_0_RANGE_36klux 0x04
103 #define COLOR17_CONFIG_0_RANGE_72klux 0x05
104 #define COLOR17_CONFIG_0_RANGE_144klux 0x06
105 #define COLOR17_CONFIG_0_RANGE_AUTO 0x0C
106 #define COLOR17_CONFIG_0_CONV_600us 0x00
107 #define COLOR17_CONFIG_0_CONV_1_ms 0x01
108 #define COLOR17_CONFIG_0_CONV_1_8ms 0x02
109 #define COLOR17_CONFIG_0_CONV_3_4ms 0x03
110 #define COLOR17_CONFIG_0_CONV_6_5ms 0x04
111 #define COLOR17_CONFIG_0_CONV_12_7ms 0x05
112 #define COLOR17_CONFIG_0_CONV_25ms 0x06
113 #define COLOR17_CONFIG_0_CONV_50ms 0x07
114 #define COLOR17_CONFIG_0_CONV_100ms 0x08
115 #define COLOR17_CONFIG_0_CONV_200ms 0x09
116 #define COLOR17_CONFIG_0_CONV_400ms 0x0A
117 #define COLOR17_CONFIG_0_CONV_800ms 0x0B
118 #define COLOR17_CONFIG_0_OP_MODE_PD 0x00
119 #define COLOR17_CONFIG_0_OP_MODE_F_ONESHOT 0x01
120 #define COLOR17_CONFIG_0_OP_MODE_ONESHOT 0x02
121 #define COLOR17_CONFIG_0_OP_MODE_CONTINUOUS 0x03
122 #define COLOR17_CONFIG_0_LATCH_DIS 0x00
123 #define COLOR17_CONFIG_0_LATCH_EN 0x01
124 #define COLOR17_CONFIG_0_INT_POL_LOW 0x00
125 #define COLOR17_CONFIG_0_INT_POL_HIGH 0x01
126 #define COLOR17_CONFIG_0_FAULT_COUNT_0 0x00
127 #define COLOR17_CONFIG_0_FAULT_COUNT_2 0x01
128 #define COLOR17_CONFIG_0_FAULT_COUNT_4 0x02
129 #define COLOR17_CONFIG_0_FAULT_COUNT_8 0x03
130 
135 #define COLOR17_CONFIG_1_MUST_READ_WRITE 0x8000u
136 #define COLOR17_CONFIG_1_THRESHOLD_CH0 0x00
137 #define COLOR17_CONFIG_1_THRESHOLD_CH1 0x01
138 #define COLOR17_CONFIG_1_THRESHOLD_CH2 0x02
139 #define COLOR17_CONFIG_1_THRESHOLD_CH3 0x03
140 #define COLOR17_CONFIG_1_INT_DIR_INPUT 0x00
141 #define COLOR17_CONFIG_1_INT_DIR_OUTPUT 0x01
142 #define COLOR17_CONFIG_1_INT_CFG_SMBUS_ALR 0x00
143 #define COLOR17_CONFIG_1_INT_CFG_NEXT_CH 0x01
144 #define COLOR17_CONFIG_1_INT_CFG_ALL_CH 0x03
145 #define COLOR17_CONFIG_1_I2C_BURST_DISABLE 0x00
146 #define COLOR17_CONFIG_1_I2C_BURST_ENABLE 0x01
147 
152 #define COLOR17_CONFIG_2_FLAG_DISABLE 0x00
153 #define COLOR17_CONFIG_2_FLAG_ENABLE 0x01
154 
159 #define COLOR17_SEL_CHANNEL_0 0x00
160 #define COLOR17_SEL_CHANNEL_1 0x01
161 #define COLOR17_SEL_CHANNEL_2 0x02
162 #define COLOR17_SEL_CHANNEL_3 0x03
163 
169 #define COLOR17_DEVICE_ADDRESS_GND 0x44
170 #define COLOR17_DEVICE_ADDRESS_VCC 0x45
171  // color17_set
173 
188 #define COLOR17_MAP_MIKROBUS( cfg, mikrobus ) \
189  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
190  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
191  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
192  // color17_map // color17
195 
200 typedef struct
201 {
202  // Input pins
203  digital_in_t int_pin;
205  // Modules
206  i2c_master_t i2c;
208  // I2C slave address
209  uint8_t slave_address;
211 } color17_t;
212 
217 typedef struct
218 {
219  pin_name_t scl;
220  pin_name_t sda;
222  pin_name_t int_pin;
224  uint32_t i2c_speed;
225  uint8_t i2c_address;
227 } color17_cfg_t;
228 
233 typedef struct
234 {
235  uint8_t qwake;
236  uint8_t range;
237  uint8_t conv_time;
238  uint8_t op_mode;
239  uint8_t latch;
240  uint8_t int_pol;
241  uint8_t fault_cnt;
242  uint8_t thld_ch_sel;
243  uint8_t int_dir;
244  uint8_t int_cfg;
245  uint8_t i2c_burst;
248 
253 typedef struct
254 {
255  uint8_t ovld_flag;
256  uint8_t conv_ready_flag;
257  uint8_t flag_h;
258  uint8_t flag_l;
261 
266 typedef enum
267 {
269  COLOR17_ERROR = -1
270 
272 
289 
303 err_t color17_init ( color17_t *ctx, color17_cfg_t *cfg );
304 
318 
333 err_t color17_generic_write ( color17_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
334 
349 err_t color17_generic_read ( color17_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
350 
365 err_t color17_write_reg ( color17_t *ctx, uint8_t reg, uint16_t data_in );
366 
381 err_t color17_read_reg ( color17_t *ctx, uint8_t reg, uint16_t *data_out );
382 
396 err_t color17_get_device_id ( color17_t *ctx, uint16_t *device_id );
397 
413 
429 
443 err_t color17_get_ch_measurement ( color17_t *ctx, uint8_t ch, uint32_t *adc_codes );
444 
459 err_t color17_get_measurement ( color17_t *ctx, uint32_t *adc_codes );
460 
476 err_t color17_get_cct ( color17_t *ctx, float *cct, float *light_intensity );
477 
490 
491 #ifdef __cplusplus
492 }
493 #endif
494 #endif // COLOR17_H
495  // color17
497 
498 // ------------------------------------------------------------------------ END
color17_config_t::int_cfg
uint8_t int_cfg
Definition: color17.h:244
COLOR17_ERROR
@ COLOR17_ERROR
Definition: color17.h:269
color17_get_device_id
err_t color17_get_device_id(color17_t *ctx, uint16_t *device_id)
Color 17 gets device ID function.
color17_cfg_setup
void color17_cfg_setup(color17_cfg_t *cfg)
Color 17 configuration object setup function.
color17_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: color17.h:224
color17_default_cfg
err_t color17_default_cfg(color17_t *ctx)
Color 17 default configuration function.
color17_cfg_t::sda
pin_name_t sda
Definition: color17.h:220
color17_cfg_t::scl
pin_name_t scl
Definition: color17.h:219
COLOR17_OK
@ COLOR17_OK
Definition: color17.h:268
color17_t::i2c
i2c_master_t i2c
Definition: color17.h:206
color17_t::int_pin
digital_in_t int_pin
Definition: color17.h:203
color17_generic_read
err_t color17_generic_read(color17_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Color 17 I2C reading function.
color17_config_t::thld_ch_sel
uint8_t thld_ch_sel
Definition: color17.h:242
color17_get_ch_measurement
err_t color17_get_ch_measurement(color17_t *ctx, uint8_t ch, uint32_t *adc_codes)
Color 17 gets the channel measurements data function.
color17_config_t::qwake
uint8_t qwake
Definition: color17.h:235
color17_status_flag_t::flag_l
uint8_t flag_l
Definition: color17.h:258
color17_status_flag_t::ovld_flag
uint8_t ovld_flag
Definition: color17.h:255
color17_t::slave_address
uint8_t slave_address
Definition: color17.h:209
color17_get_status_flag
err_t color17_get_status_flag(color17_t *ctx, color17_status_flag_t *status_flag)
Color 17 gets the status flag function.
color17_config_t::latch
uint8_t latch
Definition: color17.h:239
color17_status_flag_t::conv_ready_flag
uint8_t conv_ready_flag
Definition: color17.h:256
color17_get_measurement
err_t color17_get_measurement(color17_t *ctx, uint32_t *adc_codes)
Color 17 gets light and color measurement data function.
color17_set_config
err_t color17_set_config(color17_t *ctx, color17_config_t config)
Color 17 set the configuration function.
color17_get_cct
err_t color17_get_cct(color17_t *ctx, float *cct, float *light_intensity)
Color 17 gets correlated color temperature data function.
color17_generic_write
err_t color17_generic_write(color17_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Color 17 I2C writing function.
color17_config_t::int_dir
uint8_t int_dir
Definition: color17.h:243
color17_status_flag_t::flag_h
uint8_t flag_h
Definition: color17.h:257
color17_status_flag_t
Color 17 Click status flag object.
Definition: color17.h:254
color17_cfg_t::int_pin
pin_name_t int_pin
Definition: color17.h:222
color17_config_t::op_mode
uint8_t op_mode
Definition: color17.h:238
color17_get_int_pin
uint8_t color17_get_int_pin(color17_t *ctx)
Color 17 gets interrupt function.
color17_config_t
Color 17 Click configuration data object.
Definition: color17.h:234
color17_cfg_t::i2c_address
uint8_t i2c_address
Definition: color17.h:225
color17_config_t::fault_cnt
uint8_t fault_cnt
Definition: color17.h:241
color17_config_t::int_pol
uint8_t int_pol
Definition: color17.h:240
color17_t
Color 17 Click context object.
Definition: color17.h:201
color17_init
err_t color17_init(color17_t *ctx, color17_cfg_t *cfg)
Color 17 initialization function.
color17_config_t::conv_time
uint8_t conv_time
Definition: color17.h:237
color17_config_t::i2c_burst
uint8_t i2c_burst
Definition: color17.h:245
color17_config_t::range
uint8_t range
Definition: color17.h:236
color17_return_value_t
color17_return_value_t
Color 17 Click return value data.
Definition: color17.h:267
color17_read_reg
err_t color17_read_reg(color17_t *ctx, uint8_t reg, uint16_t *data_out)
Color 17 read register function.
color17_write_reg
err_t color17_write_reg(color17_t *ctx, uint8_t reg, uint16_t data_in)
Color 17write register function.
color17_cfg_t
Color 17 Click configuration object.
Definition: color17.h:218