color  2.0.0.0
color.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 COLOR_H
36 #define COLOR_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define COLOR_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66  cfg.rd = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.gr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.bl = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define COLOR_RETVAL uint8_t
77 
78 #define COLOR_OK 0x00
79 #define COLOR_INIT_ERROR 0xFF
80 
86 #define COLOR_SLAVE_ADDRESS 0x29
87 
94 #define COLOR_REG_ENABLE 0x00
95 #define COLOR_REG_RGBC_TIME 0x01
96 #define COLOR_REG_WAIT_TIME 0x02
97 #define COLOR_REG_AILTL 0x03
98 #define COLOR_REG_AILTH 0x04
99 #define COLOR_REG_AIHTL 0x05
100 #define COLOR_REG_AIHTH 0x06
101 #define COLOR_REG_PERS 0x0C
102 #define COLOR_REG_CONFIGURATION 0x0D
103 #define COLOR_REG_CONTROL 0x0F
104 #define COLOR_REG_DEVICE_ID 0x12
105 #define COLOR_REG_DEVICE_STATUS 0x13
106 #define COLOR_REG_CLEAR_DATA_LOW 0x14
107 #define COLOR_REG_CLEAR_DATA_HIGH 0x15
108 #define COLOR_REG_RED_DATA_LOW 0x16
109 #define COLOR_REG_RED_DATA_HIGH 0x17
110 #define COLOR_REG_GREEN_DATA_LOW 0x18
111 #define COLOR_REG_GREEN_DATA_HIGH 0x19
112 #define COLOR_REG_BLUE_DATA_LOW 0x1A
113 #define COLOR_REG_BLUE_DATA_HIGH 0x1B
114 
120 #define COLOR_CMD_SELECT 0x80
121 #define COLOR_CMD_REPEATED_BYTE_PROTOCOL 0x00
122 #define COLOR_CMD_AUTO_INCREMENT_PROTOCOL 0x20
123 
129 #define COLOR_ENABLE_RGBC_INTERRUPT 0x10
130 #define COLOR_ENABLE_WAIT 0x08
131 #define COLOR_ENABLE_RGBC 0x02
132 #define COLOR_POWER_ON 0x01
133 
139 #define COLOR_RGBC_TIME_2_4ms 0xFF
140 #define COLOR_RGBC_TIME_24ms 0xF6
141 #define COLOR_RGBC_TIME_101ms 0xD5
142 #define COLOR_RGBC_TIME_154ms 0xC0
143 #define COLOR_RGBC_TIME_700ms 0x00
144 
150 #define COLOR_WAIT_TIME_W0_2_4ms 0xFF
151 #define COLOR_WAIT_TIME_W0_204ms 0xAB
152 #define COLOR_WAIT_TIME_W0_614ms 0xFF
153 #define COLOR_WAIT_TIME_W1_0_029sec 0xFF
154 #define COLOR_WAIT_TIME_W1_2_45sec 0xAB
155 #define COLOR_WAIT_TIME_W1_7_4sec 0xFF
156 
162 #define COLOR_PERS_EVERY_RGBC 0x00
163 #define COLOR_PERS_CLEAR_CH_1 0x01
164 #define COLOR_PERS_CLEAR_CH_2 0x02
165 #define COLOR_PERS_CLEAR_CH_3 0x03
166 #define COLOR_PERS_CLEAR_CH_5 0x04
167 #define COLOR_PERS_CLEAR_CH_10 0x05
168 #define COLOR_PERS_CLEAR_CH_15 0x06
169 #define COLOR_PERS_CLEAR_CH_20 0x07
170 #define COLOR_PERS_CLEAR_CH_25 0x08
171 #define COLOR_PERS_CLEAR_CH_30 0x09
172 #define COLOR_PERS_CLEAR_CH_35 0x0A
173 #define COLOR_PERS_CLEAR_CH_40 0x0B
174 #define COLOR_PERS_CLEAR_CH_45 0x0C
175 #define COLOR_PERS_CLEAR_CH_50 0x0D
176 #define COLOR_PERS_CLEAR_CH_55 0x0E
177 #define COLOR_PERS_CLEAR_CH_60 0x0F
178 
184 #define COLOR_CFG_WAIT_LONG 0x01
185 
191 #define COLOR_CTRL_GAIN_x1 0x00
192 #define COLOR_CTRL_GAIN_x4 0x01
193 #define COLOR_CTRL_GAIN_x16 0x02
194 #define COLOR_CTRL_GAIN_x60 0x03
195 
201 #define COLOR_COLOR_DATA_CLEAR 0x14
202 #define COLOR_COLOR_DATA_RED 0x16
203 #define COLOR_COLOR_DATA_GREEN 0x18
204 #define COLOR_COLOR_DATA_BLUE 0x1A
205 
211 #define COLOR_LED_RED_ENABLE 0x01
212 #define COLOR_LED_GREEN_ENABLE 0x01
213 #define COLOR_LED_BLUE_ENABLE 0x01
214 #define COLOR_LED_RED_DISABLE 0x00
215 #define COLOR_LED_GREEN_DISABLE 0x00
216 #define COLOR_LED_BLUE_DISABLE 0x00
217 
223 #define ORANGE_COLOR_FLAG 1
224 #define RED_COLOR_FLAG 2
225 #define PINK_COLOR_FLAG 3
226 #define PURPLE_COLOR_FLAG 4
227 #define BLUE_COLOR_FLAG 5
228 #define CYAN_COLOR_FLAG 6
229 #define GREEN_COLOR_FLAG 7
230 #define YELLOW_COLOR_FLAG 8
231 #define NON_COLOR_FLAG 0
232  // End group macro
236 // --------------------------------------------------------------- PUBLIC TYPES
245 typedef struct
246 {
247  // Output pins
248 
249  digital_out_t rd;
250  digital_out_t gr;
251  digital_out_t bl;
252 
253  // Input pins
254 
255  digital_in_t int_pin;
256 
257  // Modules
258 
259  i2c_master_t i2c;
260 
261  // ctx variable
262 
263  uint8_t slave_address;
264 
265 } color_t;
266 
270 typedef struct
271 {
272  // Communication gpio pins
273 
274  pin_name_t scl;
275  pin_name_t sda;
276 
277  // Additional gpio pins
278 
279  pin_name_t rd;
280  pin_name_t gr;
281  pin_name_t bl;
282  pin_name_t int_pin;
283 
284  // static variable
285 
286  uint32_t i2c_speed;
287  uint8_t i2c_address;
288 
289 } color_cfg_t;
290  // End types group
292 
293 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
294 
300 #ifdef __cplusplus
301 extern "C"{
302 #endif
303 
313 
323 
332 
343 void color_generic_write ( color_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
344 
356 void color_generic_read ( color_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
357 
367 void color_write_byte ( color_t *ctx, uint8_t reg, uint8_t data_to_write );
368 
379 uint16_t color_read_data ( color_t *ctx, uint8_t reg );
380 
391 float color_read_color_ratio ( color_t *ctx, uint8_t color );
392 
405 
430 uint8_t color_get_color ( float color_value );
431 
441 uint8_t color_get_interrupt ( color_t *ctx );
442 
453 void color_set_led ( color_t *ctx, uint8_t red, uint8_t green, uint8_t blue );
454 
455 
456 #ifdef __cplusplus
457 }
458 #endif
459 #endif // _COLOR_H_
460  // End public_function group
463 
464 // ------------------------------------------------------------------------- END
color_cfg_t::rd
pin_name_t rd
Definition: color.h:279
color_cfg_t::int_pin
pin_name_t int_pin
Definition: color.h:282
color_cfg_t::sda
pin_name_t sda
Definition: color.h:275
color_get_color
uint8_t color_get_color(float color_value)
Detect color.
color_cfg_t::i2c_address
uint8_t i2c_address
Definition: color.h:287
color_t::rd
digital_out_t rd
Definition: color.h:249
color_read_color_ratio
float color_read_color_ratio(color_t *ctx, uint8_t color)
Read color ratio from register.
color_read_data
uint16_t color_read_data(color_t *ctx, uint8_t reg)
Read 16-bit data from register.
color_generic_read
void color_generic_read(color_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
color_default_cfg
void color_default_cfg(color_t *ctx)
Click Default Configuration function.
color_generic_write
void color_generic_write(color_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
color_cfg_t::gr
pin_name_t gr
Definition: color.h:280
color_t::i2c
i2c_master_t i2c
Definition: color.h:259
color_t
Click ctx object definition.
Definition: color.h:246
color_t::gr
digital_out_t gr
Definition: color.h:250
color_t::slave_address
uint8_t slave_address
Definition: color.h:263
color_cfg_t
Click configuration structure definition.
Definition: color.h:271
color_t::bl
digital_out_t bl
Definition: color.h:251
color_write_byte
void color_write_byte(color_t *ctx, uint8_t reg, uint8_t data_to_write)
Write one byte to register.
color_init
COLOR_RETVAL color_init(color_t *ctx, color_cfg_t *cfg)
Initialization function.
color_t::int_pin
digital_in_t int_pin
Definition: color.h:255
color_cfg_setup
void color_cfg_setup(color_cfg_t *cfg)
Config Object Initialization function.
color_get_interrupt
uint8_t color_get_interrupt(color_t *ctx)
Get interrupt pin state.
color_get_color_value
float color_get_color_value(color_t *ctx)
Functions for read color value.
COLOR_RETVAL
#define COLOR_RETVAL
Definition: color.h:76
color_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: color.h:286
color_cfg_t::bl
pin_name_t bl
Definition: color.h:281
color_set_led
void color_set_led(color_t *ctx, uint8_t red, uint8_t green, uint8_t blue)
Functions for set Led lights.
color_cfg_t::scl
pin_name_t scl
Definition: color.h:274