leddriver18  2.1.0.0
leddriver18.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 LEDDRIVER18_H
29 #define LEDDRIVER18_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 LEDDRIVER18_WRITE_TO_RDAC 0x00
70 #define LEDDRIVER18_ONE_TIME_PROG 0x80
71  // leddriver18_reg
73 
88 #define LEDDRIVER18_PWM_MAX_VALUE 0x0FFF
89 #define LEDDRIVER18_MAX_OUTPUT_NUM 24
90 #define LEDDRIVER18_MAX_RES_BITS 12
91 #define LEDDRIVER18_CC_MASK 0x3F
92 #define LEDDRIVER18_CC_ERROR 0x80
93 
98 #define LEDDRIVER18_CURRENT_30_mA 0x00
99 #define LEDDRIVER18_CURRENT_20_mA 0x01
100 #define LEDDRIVER18_CURRENT_15_mA 0x02
101 #define LEDDRIVER18_CURRENT_10_mA 0x04
102 #define LEDDRIVER18_CURRENT_5_mA 0x0B
103 #define LEDDRIVER18_CURRENT_2_mA 0x1E
104 
110 #define LEDDRIVER18_DEVICE_ADDRESS 0x2C
111  // leddriver18_set
113 
128 #define LEDDRIVER18_MAP_MIKROBUS( cfg, mikrobus ) \
129  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
130  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
131  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
132  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
133  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
134  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
135  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
136  // leddriver18_map // leddriver18
139 
144 typedef struct
145 {
146  // Output pins
147  digital_out_t cs;
148  digital_out_t sck;
149  digital_out_t mosi;
150  digital_out_t rst;
151  digital_out_t en;
153  // Modules
154  i2c_master_t i2c;
156  // I2C slave address
157  uint8_t slave_address;
159 } leddriver18_t;
160 
165 typedef struct
166 {
167  pin_name_t scl;
168  pin_name_t sda;
170  pin_name_t cs;
171  pin_name_t sck;
172  pin_name_t mosi;
173  pin_name_t rst;
174  pin_name_t en;
176  uint32_t i2c_speed;
177  uint8_t i2c_address;
180 
185 typedef enum
186 {
188  LEDDRIVER18_ERROR = -1
189 
191 
208 
223 
237 
252 err_t leddriver18_generic_write ( leddriver18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
253 
268 err_t leddriver18_generic_read ( leddriver18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
269 
282 err_t leddriver18_set_output_pwm ( uint8_t out_num, float pwm_val );
283 
292 float leddriver18_get_output_pwm ( uint8_t out_num );
293 
304 
315 
326 
339 err_t leddriver18_set_cc_output ( leddriver18_t *ctx, uint8_t current_limit );
340 
353 err_t leddriver18_get_cc_output ( leddriver18_t *ctx, uint8_t *current_limit );
354 
355 #ifdef __cplusplus
356 }
357 #endif
358 #endif // LEDDRIVER18_H
359  // leddriver18
361 
362 // ------------------------------------------------------------------------ END
leddriver18_set_cc_output
err_t leddriver18_set_cc_output(leddriver18_t *ctx, uint8_t current_limit)
LED Driver 18 set constant current output function.
leddriver18_enable_output
void leddriver18_enable_output(leddriver18_t *ctx)
LED Driver 18 enable output function.
leddriver18_t
LED Driver 18 Click context object.
Definition: leddriver18.h:145
leddriver18_cfg_t::sda
pin_name_t sda
Definition: leddriver18.h:168
leddriver18_cfg_t::scl
pin_name_t scl
Definition: leddriver18.h:167
leddriver18_cfg_t::i2c_address
uint8_t i2c_address
Definition: leddriver18.h:177
leddriver18_return_value_t
leddriver18_return_value_t
LED Driver 18 Click return value data.
Definition: leddriver18.h:186
leddriver18_cfg_t::rst
pin_name_t rst
Definition: leddriver18.h:173
LEDDRIVER18_ERROR
@ LEDDRIVER18_ERROR
Definition: leddriver18.h:188
leddriver18_cfg_t::mosi
pin_name_t mosi
Definition: leddriver18.h:172
leddriver18_generic_write
err_t leddriver18_generic_write(leddriver18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
LED Driver 18 I2C writing function.
leddriver18_t::rst
digital_out_t rst
Definition: leddriver18.h:150
leddriver18_default_cfg
err_t leddriver18_default_cfg(leddriver18_t *ctx)
LED Driver 18 default configuration function.
leddriver18_get_cc_output
err_t leddriver18_get_cc_output(leddriver18_t *ctx, uint8_t *current_limit)
LED Driver 18 get constant current output function.
LEDDRIVER18_OK
@ LEDDRIVER18_OK
Definition: leddriver18.h:187
leddriver18_cfg_t::sck
pin_name_t sck
Definition: leddriver18.h:171
leddriver18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: leddriver18.h:176
leddriver18_init
err_t leddriver18_init(leddriver18_t *ctx, leddriver18_cfg_t *cfg)
LED Driver 18 initialization function.
leddriver18_get_output_pwm
float leddriver18_get_output_pwm(uint8_t out_num)
LED Driver 18 get output channel PWM value function.
leddriver18_t::i2c
i2c_master_t i2c
Definition: leddriver18.h:154
leddriver18_write_config
void leddriver18_write_config(leddriver18_t *ctx)
LED Driver 18 write config function.
leddriver18_set_output_pwm
err_t leddriver18_set_output_pwm(uint8_t out_num, float pwm_val)
LED Driver 18 set output channel PWM value function.
leddriver18_disable_output
void leddriver18_disable_output(leddriver18_t *ctx)
LED Driver 18 disable output function.
leddriver18_t::sck
digital_out_t sck
Definition: leddriver18.h:148
leddriver18_cfg_setup
void leddriver18_cfg_setup(leddriver18_cfg_t *cfg)
LED Driver 18 configuration object setup function.
leddriver18_t::slave_address
uint8_t slave_address
Definition: leddriver18.h:157
leddriver18_t::mosi
digital_out_t mosi
Definition: leddriver18.h:149
leddriver18_cfg_t::cs
pin_name_t cs
Definition: leddriver18.h:170
leddriver18_t::cs
digital_out_t cs
Definition: leddriver18.h:147
leddriver18_cfg_t
LED Driver 18 Click configuration object.
Definition: leddriver18.h:166
leddriver18_generic_read
err_t leddriver18_generic_read(leddriver18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
LED Driver 18 I2C reading function.
leddriver18_cfg_t::en
pin_name_t en
Definition: leddriver18.h:174
leddriver18_t::en
digital_out_t en
Definition: leddriver18.h:151