color10 2.0.0.0
color10.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 COLOR10_H
36#define COLOR10_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define COLOR10_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
61#define COLOR10_RETVAL uint8_t
62
63#define COLOR10_OK 0x00
64#define COLOR10_INIT_ERROR 0xFF
67#define COLOR10_SLAVE_ADDR 0x10
68
69#define COLOR10_CMD_REG_CFG 0x00
70#define COLOR10_CMD_REG_C 0x04
71#define COLOR10_CMD_REG_R 0x05
72#define COLOR10_CMD_REG_G 0x06
73#define COLOR10_CMD_REG_B 0x07
74#define COLOR10_CMD_REG_IR 0x08
75#define COLOR10_CMD_REG_ID 0x0C
76
77#define COLOR10_DEVICE_ID 0x28
78
79#define COLOR10_COLOR_ORANGE 0x11
80#define COLOR10_COLOR_RED 0x22
81#define COLOR10_COLOR_PINK 0x33
82#define COLOR10_COLOR_PURPLE 0x44
83#define COLOR10_COLOR_BLUE 0x55
84#define COLOR10_COLOR_CYAN 0x66
85#define COLOR10_COLOR_GREEN 0x77
86#define COLOR10_COLOR_YELLOW 0x88
87#define COLOR10_COLOR_OTHER 0x99
88
89#define COLOR10_CFG_HIGH_DYNAMIC_RANGE_1_3 0x0040
90#define COLOR10_CFG_HIGH_DYNAMIC_RANGE_1 0x0000
91#define COLOR10_CFG_INTEGRATION_TIME_SETT_50_MS 0x0000
92#define COLOR10_CFG_INTEGRATION_TIME_SETT_100_MS 0x0010
93#define COLOR10_CFG_INTEGRATION_TIME_SETT_200_MS 0x0020
94#define COLOR10_CFG_INTEGRATION_TIME_SETT_400_MS 0x0030
95#define COLOR10_CFG_AUTO_MODE 0x0000
96#define COLOR10_CFG_FORCE_MODE 0x0008
97#define COLOR10_CFG_TRIGGER_NO 0x0000
98#define COLOR10_CFG_TRIGGER_ONE_TIME 0x0004
99#define COLOR10_CFG_POWER_ON 0x0000
100#define COLOR10_CFG_SHUT_DOWN 0x8001
101#define COLOR10_CFG_POWER_ON_G_C_IR 0x4000
102#define COLOR10_CFG_GAIN_1_X1 0x0000
103#define COLOR10_CFG_GAIN_1_X2 0x1000
104#define COLOR10_CFG_GAIN_1_X4 0x2000
105#define COLOR10_CFG_GAIN_2_X1_2 0x0C00
106#define COLOR10_CFG_GAIN_2_X1 0x0000
107#define COLOR10_CFG_GAIN_2_X2 0x0400
108#define COLOR10_CFG_GAIN_2_X4 0x0800
109 // End group macro
111// --------------------------------------------------------------- PUBLIC TYPES
120typedef struct
121{
122
123 // Modules
124
125 i2c_master_t i2c;
126
127 // ctx variable
128
130
131} color10_t;
132
136typedef struct
137{
138 // Communication gpio pins
139
140 pin_name_t scl;
141 pin_name_t sda;
142
143 // static variable
144
145 uint32_t i2c_speed;
146 uint8_t i2c_address;
147
149 // End types group
151// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
152
158#ifdef __cplusplus
159extern "C"{
160#endif
161
171
181
192void color10_generic_write ( color10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
193
204uint16_t color10_generic_read ( color10_t *ctx, uint8_t cmd_addr );
205
214void color10_config ( color10_t *ctx, uint16_t cfg_data );
215
225uint8_t color10_get_id ( color10_t *ctx );
226
237float color10_read_color_ratio ( color10_t *ctx, uint8_t color_cmd_reg );
238
249
259uint8_t color10_get_color ( float color_value );
260
261
262#ifdef __cplusplus
263}
264#endif
265#endif // _COLOR10_H_
266 // End public_function group
269
270// ------------------------------------------------------------------------- END
#define COLOR10_RETVAL
Definition: color10.h:61
void color10_cfg_setup(color10_cfg_t *cfg)
Config Object Initialization function.
COLOR10_RETVAL color10_init(color10_t *ctx, color10_cfg_t *cfg)
Initialization function.
uint8_t color10_get_color(float color_value)
Color retrieval function.
uint8_t color10_get_id(color10_t *ctx)
ID retrieval function.
uint16_t color10_generic_read(color10_t *ctx, uint8_t cmd_addr)
Generic read function.
void color10_config(color10_t *ctx, uint16_t cfg_data)
Configuration function.
void color10_generic_write(color10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
float color10_read_color_ratio(color10_t *ctx, uint8_t color_cmd_reg)
Color ratio function.
float color10_get_color_value(color10_t *ctx)
Color value function.
Click configuration structure definition.
Definition: color10.h:137
uint32_t i2c_speed
Definition: color10.h:145
pin_name_t scl
Definition: color10.h:140
pin_name_t sda
Definition: color10.h:141
uint8_t i2c_address
Definition: color10.h:146
Click ctx object definition.
Definition: color10.h:121
i2c_master_t i2c
Definition: color10.h:125
uint8_t slave_address
Definition: color10.h:129