leddriver15  2.1.0.0
leddriver15.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 LEDDRIVER15_H
29 #define LEDDRIVER15_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 LEDDRIVER15_REG_R0 0x00
60 #define LEDDRIVER15_REG_R1 0x01
61  // leddriver15_reg
63 
78 #define LEDDRIVER15_R0_EN 0x80
79 #define LEDDRIVER15_R0_REF_SET_MASK 0x7C
80 #define LEDDRIVER15_R0_REF_SET_OFFSET 2
81 
86 #define LEDDRIVER15_R1_DIMS_I2C 0x00
87 #define LEDDRIVER15_R1_DIMS_PWM 0x40
88 #define LEDDRIVER15_R1_DIMS_MASK 0x40
89 #define LEDDRIVER15_R1_SYNC_DISABLE 0x00
90 #define LEDDRIVER15_R1_SYNC_ENABLE 0x20
91 #define LEDDRIVER15_R1_SYNC_MASK 0x20
92 #define LEDDRIVER15_R1_OVP_13p5V 0x00
93 #define LEDDRIVER15_R1_OVP_24V 0x10
94 #define LEDDRIVER15_R1_OVP_35p5V 0x08
95 #define LEDDRIVER15_R1_OVP_MASK 0x18
96 #define LEDDRIVER15_R1_VOS 0x04
97 #define LEDDRIVER15_R1_LED0 0x02
98 #define LEDDRIVER15_R1_OTP 0x01
99 
104 #define LEDDRIVER15_I2C_DIMMING_MIN 0
105 #define LEDDRIVER15_I2C_DIMMING_MAX 31
106 
112 #define LEDDRIVER15_DEVICE_ADDRESS 0x17
113  // leddriver15_set
115 
130 #define LEDDRIVER15_MAP_MIKROBUS( cfg, mikrobus ) \
131  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
132  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
133  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );
134  // leddriver15_map // leddriver15
137 
142 typedef struct
143 {
144  digital_out_t en;
146  i2c_master_t i2c;
148  uint8_t slave_address;
150 } leddriver15_t;
151 
156 typedef struct
157 {
158  pin_name_t scl;
159  pin_name_t sda;
160  pin_name_t en;
162  uint32_t i2c_speed;
163  uint8_t i2c_address;
166 
171 typedef enum
172 {
174  LEDDRIVER15_ERROR = -1
175 
177 
194 
209 
223 
238 err_t leddriver15_write_register ( leddriver15_t *ctx, uint8_t reg, uint8_t data_in );
239 
254 err_t leddriver15_read_register ( leddriver15_t *ctx, uint8_t reg, uint8_t *data_out );
255 
265 
275 
287 err_t leddriver15_set_i2c_dimming ( leddriver15_t *ctx, uint8_t dimming );
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 #endif // LEDDRIVER15_H
293  // leddriver15
295 
296 // ------------------------------------------------------------------------ END
LEDDRIVER15_ERROR
@ LEDDRIVER15_ERROR
Definition: leddriver15.h:174
leddriver15_t::i2c
i2c_master_t i2c
Definition: leddriver15.h:146
leddriver15_return_value_t
leddriver15_return_value_t
LED Driver 15 Click return value data.
Definition: leddriver15.h:172
leddriver15_cfg_t::en
pin_name_t en
Definition: leddriver15.h:160
leddriver15_init
err_t leddriver15_init(leddriver15_t *ctx, leddriver15_cfg_t *cfg)
LED Driver 15 initialization function.
leddriver15_cfg_t::scl
pin_name_t scl
Definition: leddriver15.h:158
leddriver15_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: leddriver15.h:162
leddriver15_enable_device
void leddriver15_enable_device(leddriver15_t *ctx)
LED Driver 15 enable device function.
leddriver15_cfg_setup
void leddriver15_cfg_setup(leddriver15_cfg_t *cfg)
LED Driver 15 configuration object setup function.
leddriver15_read_register
err_t leddriver15_read_register(leddriver15_t *ctx, uint8_t reg, uint8_t *data_out)
LED Driver 15 I2C reading function.
leddriver15_set_i2c_dimming
err_t leddriver15_set_i2c_dimming(leddriver15_t *ctx, uint8_t dimming)
LED Driver 15 set i2c dimming function.
leddriver15_write_register
err_t leddriver15_write_register(leddriver15_t *ctx, uint8_t reg, uint8_t data_in)
LED Driver 15 I2C writing function.
leddriver15_cfg_t::i2c_address
uint8_t i2c_address
Definition: leddriver15.h:163
leddriver15_t::en
digital_out_t en
Definition: leddriver15.h:144
leddriver15_disable_device
void leddriver15_disable_device(leddriver15_t *ctx)
LED Driver 15 disable device function.
leddriver15_default_cfg
err_t leddriver15_default_cfg(leddriver15_t *ctx)
LED Driver 15 default configuration function.
leddriver15_cfg_t
LED Driver 15 Click configuration object.
Definition: leddriver15.h:157
leddriver15_t
LED Driver 15 Click context object.
Definition: leddriver15.h:143
LEDDRIVER15_OK
@ LEDDRIVER15_OK
Definition: leddriver15.h:173
leddriver15_t::slave_address
uint8_t slave_address
Definition: leddriver15.h:148
leddriver15_cfg_t::sda
pin_name_t sda
Definition: leddriver15.h:159