color3  2.0.0.0
color3.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 COLOR3_H
36 #define COLOR3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define COLOR3_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 )
57 
63 #define COLOR3_RETVAL uint8_t
64 
65 #define COLOR3_OK 0x00
66 #define COLOR3_INIT_ERROR 0xFF
67 
73 #define COLOR3_COMMAND_TYPE_SPECIAL (3 << 5)
74 #define COLOR3_COMMAND_TYPE_AUTOINC (0b01 << 5)
75 #define COLOR3_COMMAND_SELECT (1 << 7)
76 
82 #define COLOR3_I2C_SLAVE_ADDR 0x29
83 
89 #define COLOR3_ENABLE 0x00
90 #define COLOR3_ATIME 0x01
91 #define COLOR3_PTIME 0x02
92 #define COLOR3_WTIME 0x03
93 #define COLOR3_AILTL 0x04
94 #define COLOR3_AILTH 0x05
95 #define COLOR3_AIHTL 0x06
96 #define COLOR3_AIHTH 0x07
97 #define COLOR3_PILTL 0x08
98 #define COLOR3_PILTH 0x09
99 #define COLOR3_PIHTL 0x0A
100 #define COLOR3_PIHTH 0x0B
101 #define COLOR3_PERS 0x0C
102 #define COLOR3_CONFIG 0x0D
103 #define COLOR3_PPCOUNT 0x0E
104 #define COLOR3_CONTROL 0x0F
105 #define COLOR3_ID 0x12
106 #define COLOR3_STATUS 0x13
107 #define COLOR3_CDATA 0x14
108 #define COLOR3_CDATAH 0x15
109 #define COLOR3_RDATA 0x16
110 #define COLOR3_RDATAH 0x17
111 #define COLOR3_GDATA 0x18
112 #define COLOR3_GDATAH 0x19
113 #define COLOR3_BDATA 0x1A
114 #define COLOR3_BDATAH 0x1B
115 #define COLOR3_PDATA 0x1C
116 #define COLOR3_PDATAH 0x1D
117 
123 #define COLOR3_ENABLE_REG_DEFAULT 0x00
124 #define COLOR3_ENABLE_REG_PON 0x01
125 #define COLOR3_ENABLE_REG_AEN 0x02
126 #define COLOR3_ENABLE_REG_PEN 0x04
127 #define COLOR3_ENABLE_REG_WEN 0x08
128 #define COLOR3_ENABLE_REG_AIEN 0x10
129 #define COLOR3_ENABLE_REG_PIEN 0x20
130 
136 #define COLOR3_RGBC_TIMING_1_CYC 0xFF
137 #define COLOR3_RGBC_TIMING_4_CYC 0xFC
138 #define COLOR3_RGBC_TIMING_10_CYC 0xF6
139 #define COLOR3_RGBC_TIMING_42_CYC 0xD6
140 #define COLOR3_RGBC_TIMING_64_CYC 0xAD
141 #define COLOR3_RGBC_TIMING_256_CYC 0x00
142 
148 #define COLOR3_PROXY_PULSE_1 0xFF
149 #define COLOR3_PROXY_PULSE_10 0xF6
150 #define COLOR3_PROXY_PULSE_42 0xD6
151 #define COLOR3_PROXY_PULSE_64 0xAD
152 #define COLOR3_PROXY_PULSE_256 0x00
153 
159 #define COLOR3_WAIT_TIME_REG_1_CYC 0xFF
160 #define COLOR3_WAIT_TIME_REG_40_CYC 0xD8
161 #define COLOR3_WAIT_TIME_REG_85_CYC 0xAB
162 #define COLOR3_WAIT_TIME_REG_256_CYC 0x00
163 
169 #define COLOR3_LOW_THRESHOLD_VALUE 0x0130
170 #define COLOR3_HIGH_THRESHOLD_VALUE 0x0170
171 
177 #define COLOR3_EVERY_CYC_INTER 0x00
178 #define COLOR3_1_OR_INTER 0x01
179 #define COLOR3_2_OR_INTER 0x02
180 #define COLOR3_3_OR_INTER 0x03
181 #define COLOR3_5_OR_INTER 0x04
182 #define COLOR3_10_OR_INTER 0x05
183 #define COLOR3_15_OR_INTER 0x06
184 #define COLOR3_20_OR_INTER 0x07
185 #define COLOR3_25_OR_INTER 0x08
186 #define COLOR3_30_OR_INTER 0x09
187 #define COLOR3_35_OR_INTER 0x0A
188 #define COLOR3_40_OR_INTER 0x0B
189 #define COLOR3_45_OR_INTER 0x0C
190 #define COLOR3_50_OR_INTER 0x0D
191 #define COLOR3_55_OR_INTER 0x0E
192 #define COLOR3_60_OR_INTER 0x0F
193 
199 #define COLOR3_LONG_WAIT 0x02
200 
206 #define COLOR3_A_GAIN_1 0x00
207 #define COLOR3_A_GAIN_4 0x01
208 #define COLOR3_A_GAIN_16 0x02
209 #define COLOR3_A_GAIN_60 0x03
210 
216 #define COLOR3_CLEAR_DIODE 0x10
217 #define COLOR3_IR_DIODE 0x20
218 #define COLOR3_BOTH_DIODE 0x30
219 
225 #define COLOR3_LED_STR_100 0x00
226 #define COLOR3_LED_STR_50 0x40
227 #define COLOR3_LED_STR_25 0x80
228 #define COLOR3_LED_STR_12_5 0xC0
229 
235 #define COLOR3_ORANGE_COLOR_FLAG 1
236 #define COLOR3_RED_COLOR_FLAG 2
237 #define COLOR3_PINK_COLOR_FLAG 3
238 #define COLOR3_PURPLE_COLOR_FLAG 4
239 #define COLOR3_BLUE_COLOR_FLAG 5
240 #define COLOR3_CYAN_COLOR_FLAG 6
241 #define COLOR3_GREEN_COLOR_FLAG 7
242 #define COLOR3_YELLOW_COLOR_FLAG 8
243 #define COLOR3_NON_COLOR_FLAG 0
244  // End group macro
248 // --------------------------------------------------------------- PUBLIC TYPES
257 typedef struct
258 {
259  // Output pins
260 
261  // Input pins
262 
263  digital_in_t int_pin;
264 
265  // Modules
266 
267  i2c_master_t i2c;
268 
269  // ctx variable
270 
271  uint8_t slave_address;
272 
273  uint16_t *clear_data;
274  uint16_t *red_data;
275  uint16_t *green_data;
276  uint16_t *blue_data;
277 } color3_t;
278 
279 typedef struct
280 {
281  uint16_t *clear_data;
282  uint16_t *red_data;
283  uint16_t *green_data;
284  uint16_t *blue_data;
285 
287 
291 typedef struct
292 {
293  // Communication gpio pins
294 
295  pin_name_t scl;
296  pin_name_t sda;
297 
298  // Additional gpio pins
299 
300  pin_name_t int_pin;
301 
302  // static variable
303 
304  uint32_t i2c_speed;
305  uint8_t i2c_address;
306 
308 
309 } color3_cfg_t;
310  // End types group
312 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
313 
319 #ifdef __cplusplus
320 extern "C"{
321 #endif
322 
332 
341 
352 void color3_generic_write ( color3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
353 
365 void color3_generic_read ( color3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
366 
377 void color3_normal_wr_byte ( color3_t *ctx, uint8_t wr_addr, uint8_t wr_data );
378 
389  void color3_special_wr_byte ( color3_t *ctx, uint8_t wr_addr, uint8_t wr_data );
390 
400  uint8_t color3_read_byte ( color3_t *ctx, uint8_t rd_addr );
401 
412  void color3_normal_wr_data ( color3_t *ctx, uint8_t wr_addr, uint16_t wr_data );
413 
424  void color3_special_wr_data ( color3_t *ctx, uint8_t wr_addr, uint16_t wr_data );
425 
435  uint16_t color3_read_data ( color3_t *ctx, uint8_t rd_addr );
436 
446  void color3_write_enable_register ( color3_t *ctx, uint8_t wr_data );
447 
457 
467  void color3_write_rgbc_timing_register ( color3_t *ctx , uint8_t wr_data );
468 
481 
492 
505 
515  void color3_write_wait_time_register ( color3_t *ctx, uint8_t wr_data );
516 
526 
536  void color3_set_inter_trsh_lo_val( color3_t *ctx, uint16_t wr_data );
537 
547  void color3_set_inter_trsh_hi_val ( color3_t *ctx, uint16_t wr_data );
548 
558  void color3_set_proxy_inter_trsh_lo_val ( color3_t *ctx, uint16_t wr_data );
559 
569  void color3_set_proxy_inter_trsh_hi_val ( color3_t *ctx, uint16_t wr_data );
570 
580  void color3_set_interrupt_persistence ( color3_t *ctx, uint8_t int_pers );
581 
591 
601  void color3_setproxy_interrupt_persistence ( color3_t *ctx, uint8_t int_pers );
602 
612 
622  void color3_setLongWait ( color3_t *ctx, uint8_t lon_wait );
623 
632  uint8_t color3_read_long_wait ( color3_t *ctx );
633 
643  void color3_write_pulse_cnt ( color3_t *ctx, uint8_t pulse_cnt );
644 
653  uint8_t color3_read_pulse_cnt ( color3_t *ctx );
654 
664  void color3_write_rgbc_gain ( color3_t *ctx, uint8_t gain_val );
665 
674  uint8_t color3_read_rgbc_gain ( color3_t *ctx );
675 
685  void color3_set_diode_select ( color3_t *ctx, uint8_t dio_sel );
686 
696 
706  void color3_set_led_str ( color3_t *ctx, uint8_t led_str );
707 
716  uint8_t color3_read_led_str ( color3_t *ctx );
717 
726  uint8_t color3_read_dev_id ( color3_t *ctx );
727 
736  uint8_t color3_read_dev_stat ( color3_t *ctx );
737 
746  uint16_t color3_read_clear_data ( color3_t *ctx );
747 
756  uint16_t color3_read_red_data ( color3_t *ctx );
757 
766  uint16_t color3_read_green_data ( color3_t *ctx );
767 
776  uint16_t color3_read_blue_data ( color3_t *ctx );
777 
787 
796  uint8_t color3_get_inter_state ( color3_t *ctx );
797 
807 
819  void color3_get_rgb_data ( color3_t *ctx, uint16_t *red_data, uint16_t *green_data, uint16_t *blue_data );
820 
830  float color3_get_color_ratio ( color3_t *ctx, uint16_t color_data );
831 
841 
854  void color3_get_crgb_data ( color3_t *ctx, color3_const_t *data_const );
855 
867 static float color3_rgb_to_hsl( color3_t *ctx, float red, float green, float blue );
868 
893 uint8_t color3_get_color ( float color_value );
894 
895 #ifdef __cplusplus
896 }
897 #endif
898 #endif // _COLOR3_H_
899  // End public_function group
902 
903 // ------------------------------------------------------------------------- END
color3_read_pulse_cnt
uint8_t color3_read_pulse_cnt(color3_t *ctx)
Read Proximity Pulse Count function.
color3_t::blue_data
uint16_t * blue_data
Definition: color3.h:276
color3_set_diode_select
void color3_set_diode_select(color3_t *ctx, uint8_t dio_sel)
Set Diode Selection function.
color3_cfg_t
Click configuration structure definition.
Definition: color3.h:292
color3_get_color
uint8_t color3_get_color(float color_value)
Detect color.
color3_write_proxy_timing_register
void color3_write_proxy_timing_register(color3_t *ctx)
Write Proximity Timing Register function.
color3_t::i2c
i2c_master_t i2c
Definition: color3.h:267
color3_get_diode_select
uint8_t color3_get_diode_select(color3_t *ctx)
Get Diode Selection function.
color3_init
COLOR3_RETVAL color3_init(color3_t *ctx, color3_cfg_t *cfg)
Initialization function.
color3_cfg_t::scl
pin_name_t scl
Definition: color3.h:295
color3_normal_wr_data
void color3_normal_wr_data(color3_t *ctx, uint8_t wr_addr, uint16_t wr_data)
Normal write data function.
color3_write_rgbc_gain
void color3_write_rgbc_gain(color3_t *ctx, uint8_t gain_val)
Write RGBC Gain Value function.
color3_generic_read
void color3_generic_read(color3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
color3_read_rgbc_timing_register
uint8_t color3_read_rgbc_timing_register(color3_t *ctx)
Read RGBC Timing Register function.
color3_set_proxy_inter_trsh_hi_val
void color3_set_proxy_inter_trsh_hi_val(color3_t *ctx, uint16_t wr_data)
Proximity interrupt threshold high value function.
color3_write_wait_time_register
void color3_write_wait_time_register(color3_t *ctx, uint8_t wr_data)
Write Wait Time Register function.
COLOR3_RETVAL
#define COLOR3_RETVAL
Definition: color3.h:63
color3_set_proxy_inter_trsh_lo_val
void color3_set_proxy_inter_trsh_lo_val(color3_t *ctx, uint16_t wr_data)
Proximity interrupt threshold low value function.
color3_const_t::blue_data
uint16_t * blue_data
Definition: color3.h:284
color3_read_dev_id
uint8_t color3_read_dev_id(color3_t *ctx)
Read device ID function.
color3_cfg_t::sda
pin_name_t sda
Definition: color3.h:296
color3_cfg_t::int_pin
pin_name_t int_pin
Definition: color3.h:300
color3_set_inter_trsh_lo_val
void color3_set_inter_trsh_lo_val(color3_t *ctx, uint16_t wr_data)
RGBC interrupt threshold low value function.
color3_const_t::red_data
uint16_t * red_data
Definition: color3.h:282
color3_read_red_data
uint16_t color3_read_red_data(color3_t *ctx)
Read red data function.
color3_cfg_t::i2c_address
uint8_t i2c_address
Definition: color3.h:305
color3_read_wait_time_register
uint8_t color3_read_wait_time_register(color3_t *ctx)
Read Wait Time Register function.
color3_get_color_value
float color3_get_color_value(color3_t *ctx)
Get color value function.
color3_t::slave_address
uint8_t slave_address
Definition: color3.h:271
color3_set_interrupt_persistence
void color3_set_interrupt_persistence(color3_t *ctx, uint8_t int_pers)
Set Interrupt persistence persistence function.
color3_t::int_pin
digital_in_t int_pin
Definition: color3.h:263
color3_write_pulse_cnt
void color3_write_pulse_cnt(color3_t *ctx, uint8_t pulse_cnt)
Write Proximity Pulse Count function.
color3_get_inter_state
uint8_t color3_get_inter_state(color3_t *ctx)
Get Interrupt state function.
color3_read_enable_register
uint8_t color3_read_enable_register(color3_t *ctx)
Read Enable Register function.
color3_special_wr_data
void color3_special_wr_data(color3_t *ctx, uint8_t wr_addr, uint16_t wr_data)
Special write function.
color3_t::green_data
uint16_t * green_data
Definition: color3.h:275
color3_special_wr_byte
void color3_special_wr_byte(color3_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Special write byte function.
color3_const_t::clear_data
uint16_t * clear_data
Definition: color3.h:281
color3_read_led_str
uint8_t color3_read_led_str(color3_t *ctx)
Read LED Strength function.
color3_get_crgb_data
void color3_get_crgb_data(color3_t *ctx, color3_const_t *data_const)
Get CRBG data function.
color3_t
Click ctx object definition.
Definition: color3.h:258
color3_read_byte
uint8_t color3_read_byte(color3_t *ctx, uint8_t rd_addr)
Read byte function.
color3_generic_write
void color3_generic_write(color3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
color3_const_t::green_data
uint16_t * green_data
Definition: color3.h:283
color3_setproxy_interrupt_persistence
void color3_setproxy_interrupt_persistence(color3_t *ctx, uint8_t int_pers)
Set Proximity interrupt persistence function.
color3_read_proxy_interrupt_persistence
uint8_t color3_read_proxy_interrupt_persistence(color3_t *ctx)
Read Proximity interrupt persistence function.
color3_const_t
Definition: color3.h:280
color3_cfg_setup
void color3_cfg_setup(color3_cfg_t *cfg)
Config Object Initialization function.
color3_cfg_t::dev_const
color3_const_t dev_const
Definition: color3.h:307
color3_read_proxy_data
uint16_t color3_read_proxy_data(color3_t *ctx)
ead proximity data function.
color3_read_rgbc_gain
uint8_t color3_read_rgbc_gain(color3_t *ctx)
Read RGBC Gain Value function.
color3_read_blue_data
uint16_t color3_read_blue_data(color3_t *ctx)
Read blue data function.
color3_read_dev_stat
uint8_t color3_read_dev_stat(color3_t *ctx)
Read device status function.
color3_read_interrupt_persistence
uint8_t color3_read_interrupt_persistence(color3_t *ctx)
Read Interrupt persistence function.
color3_t::clear_data
uint16_t * clear_data
Definition: color3.h:273
color3_set_inter_trsh_hi_val
void color3_set_inter_trsh_hi_val(color3_t *ctx, uint16_t wr_data)
RGBC interrupt threshold high value function.
color3_read_data
uint16_t color3_read_data(color3_t *ctx, uint8_t rd_addr)
Read data function.
color3_write_rgbc_timing_register
void color3_write_rgbc_timing_register(color3_t *ctx, uint8_t wr_data)
Write RGBC Timing Register function.
color3_set_default_settings
void color3_set_default_settings(color3_t *ctx)
Default settings function.
color3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: color3.h:304
color3_t::red_data
uint16_t * red_data
Definition: color3.h:274
color3_write_enable_register
void color3_write_enable_register(color3_t *ctx, uint8_t wr_data)
Write Enable Register function.
color3_read_clear_data
uint16_t color3_read_clear_data(color3_t *ctx)
Read clear data function.
color3_read_long_wait
uint8_t color3_read_long_wait(color3_t *ctx)
Read long wait function.
color3_read_proxy_timing_register
uint8_t color3_read_proxy_timing_register(color3_t *ctx)
Read Proximity Timing Register function.
color3_normal_wr_byte
void color3_normal_wr_byte(color3_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Generic read function.
color3_set_led_str
void color3_set_led_str(color3_t *ctx, uint8_t led_str)
Set LED Strength function.
color3_get_rgb_data
void color3_get_rgb_data(color3_t *ctx, uint16_t *red_data, uint16_t *green_data, uint16_t *blue_data)
Get color data function.
color3_setLongWait
void color3_setLongWait(color3_t *ctx, uint8_t lon_wait)
Set long wait function.
color3_get_color_ratio
float color3_get_color_ratio(color3_t *ctx, uint16_t color_data)
Get color ratio function.
color3_read_green_data
uint16_t color3_read_green_data(color3_t *ctx)
Read green data function.