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 "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 LEDDRIVER15_REG_R0 0x00
70 #define LEDDRIVER15_REG_R1 0x01
71  // leddriver15_reg
73 
88 #define LEDDRIVER15_R0_EN 0x80
89 #define LEDDRIVER15_R0_REF_SET_MASK 0x7C
90 #define LEDDRIVER15_R0_REF_SET_OFFSET 2
91 
96 #define LEDDRIVER15_R1_DIMS_I2C 0x00
97 #define LEDDRIVER15_R1_DIMS_PWM 0x40
98 #define LEDDRIVER15_R1_DIMS_MASK 0x40
99 #define LEDDRIVER15_R1_SYNC_DISABLE 0x00
100 #define LEDDRIVER15_R1_SYNC_ENABLE 0x20
101 #define LEDDRIVER15_R1_SYNC_MASK 0x20
102 #define LEDDRIVER15_R1_OVP_13p5V 0x00
103 #define LEDDRIVER15_R1_OVP_24V 0x10
104 #define LEDDRIVER15_R1_OVP_35p5V 0x08
105 #define LEDDRIVER15_R1_OVP_MASK 0x18
106 #define LEDDRIVER15_R1_VOS 0x04
107 #define LEDDRIVER15_R1_LED0 0x02
108 #define LEDDRIVER15_R1_OTP 0x01
109 
114 #define LEDDRIVER15_I2C_DIMMING_MIN 0
115 #define LEDDRIVER15_I2C_DIMMING_MAX 31
116 
122 #define LEDDRIVER15_DEVICE_ADDRESS 0x17
123  // leddriver15_set
125 
140 #define LEDDRIVER15_MAP_MIKROBUS( cfg, mikrobus ) \
141  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
142  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
143  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );
144  // leddriver15_map // leddriver15
147 
152 typedef struct
153 {
154  digital_out_t en;
156  i2c_master_t i2c;
158  uint8_t slave_address;
160 } leddriver15_t;
161 
166 typedef struct
167 {
168  pin_name_t scl;
169  pin_name_t sda;
170  pin_name_t en;
172  uint32_t i2c_speed;
173  uint8_t i2c_address;
176 
181 typedef enum
182 {
184  LEDDRIVER15_ERROR = -1
185 
187 
204 
219 
233 
246 err_t leddriver15_write_register ( leddriver15_t *ctx, uint8_t reg, uint8_t data_in );
247 
260 err_t leddriver15_read_register ( leddriver15_t *ctx, uint8_t reg, uint8_t *data_out );
261 
271 
281 
293 err_t leddriver15_set_i2c_dimming ( leddriver15_t *ctx, uint8_t dimming );
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 #endif // LEDDRIVER15_H
299  // leddriver15
301 
302 // ------------------------------------------------------------------------ END
LEDDRIVER15_ERROR
@ LEDDRIVER15_ERROR
Definition: leddriver15.h:184
leddriver15_t::i2c
i2c_master_t i2c
Definition: leddriver15.h:156
leddriver15_return_value_t
leddriver15_return_value_t
LED Driver 15 Click return value data.
Definition: leddriver15.h:182
leddriver15_cfg_t::en
pin_name_t en
Definition: leddriver15.h:170
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:168
leddriver15_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: leddriver15.h:172
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 read register 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 write register function.
leddriver15_cfg_t::i2c_address
uint8_t i2c_address
Definition: leddriver15.h:173
leddriver15_t::en
digital_out_t en
Definition: leddriver15.h:154
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:167
leddriver15_t
LED Driver 15 Click context object.
Definition: leddriver15.h:153
LEDDRIVER15_OK
@ LEDDRIVER15_OK
Definition: leddriver15.h:183
leddriver15_t::slave_address
uint8_t slave_address
Definition: leddriver15.h:158
leddriver15_cfg_t::sda
pin_name_t sda
Definition: leddriver15.h:169