leddriver11  2.0.0.0
leddriver11.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 LEDDRIVER11_H
29 #define LEDDRIVER11_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 #include "drv_analog_in.h"
39 #include "drv_pwm.h"
40 
61 #define LEDDRIVER11_MAX_CURRENT 0x0000
62 #define LEDDRIVER11_MIN_CURRENT 0x0FFF
63 
68 #define LEDDRIVER11_DEF_FREQ 5000
69 
74 #define LEDDRIVER11_SET_DEV_ADDR 0x60
75  // leddriver11_set
77 
92 #define LEDDRIVER11_MAP_MIKROBUS( cfg, mikrobus ) \
93  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
94  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
97  // leddriver11_map // leddriver11
100 
105 typedef struct
106 {
107  // Modules
108  analog_in_t adc;
109  i2c_master_t i2c;
110  pwm_t pwm;
112  // ctx variable
113  uint32_t pwm_freq;
115  // I2C slave address
116  uint8_t slave_address;
118 } leddriver11_t;
119 
124 typedef struct
125 {
126  pin_name_t scl;
127  pin_name_t sda;
128  pin_name_t an;
129  pin_name_t pwm;
131  analog_in_resolution_t resolution;
132  float vref;
133  uint32_t i2c_speed;
134  uint8_t i2c_address;
135  uint32_t dev_pwm_freq;
138 
143 typedef enum
144 {
146  LEDDRIVER11_ERROR = -1
147 
149 
166 
182 
197 
212 err_t leddriver11_set_current ( leddriver11_t *ctx, uint16_t curr );
213 
226 err_t leddriver11_read_dac_memory( leddriver11_t *ctx, uint8_t *data_out );
227 
240 err_t leddriver11_read_an_pin_value ( leddriver11_t *ctx, uint16_t *data_out );
241 
256 err_t leddriver11_read_an_pin_voltage ( leddriver11_t *ctx, float *data_out );
257 
270 err_t leddriver11_set_duty_cycle ( leddriver11_t *ctx, float duty_cycle );
271 
283 err_t leddriver11_pwm_stop ( leddriver11_t *ctx );
284 
296 err_t leddriver11_pwm_start ( leddriver11_t *ctx );
297 
298 #ifdef __cplusplus
299 }
300 #endif
301 #endif // LEDDRIVER11_H
302  // leddriver11
304 
305 // ------------------------------------------------------------------------ END
leddriver11_read_an_pin_voltage
err_t leddriver11_read_an_pin_voltage(leddriver11_t *ctx, float *data_out)
LED Driver 11 read AN pin voltage level function.
LEDDRIVER11_ERROR
Definition: leddriver11.h:145
leddriver11_pwm_start
err_t leddriver11_pwm_start(leddriver11_t *ctx)
LED Driver 11 start PWM module.
leddriver11_init
err_t leddriver11_init(leddriver11_t *ctx, leddriver11_cfg_t *cfg)
LED Driver 11 initialization function.
leddriver11_pwm_stop
err_t leddriver11_pwm_stop(leddriver11_t *ctx)
LED Driver 11 stop PWM module.
leddriver11_read_an_pin_value
err_t leddriver11_read_an_pin_value(leddriver11_t *ctx, uint16_t *data_out)
LED Driver 11 read AN pin value function.
leddriver11_t
LED Driver 11 Click context object.
Definition: leddriver11.h:104
leddriver11_set_duty_cycle
err_t leddriver11_set_duty_cycle(leddriver11_t *ctx, float duty_cycle)
LED Driver 11 sets PWM duty cycle.
LEDDRIVER11_OK
Definition: leddriver11.h:144
leddriver11_default_cfg
err_t leddriver11_default_cfg(leddriver11_t *ctx)
LED Driver 11 default configuration function.
leddriver11_set_current
err_t leddriver11_set_current(leddriver11_t *ctx, uint16_t curr)
LED Driver 11 set current function.
leddriver11_read_dac_memory
err_t leddriver11_read_dac_memory(leddriver11_t *ctx, uint8_t *data_out)
LED Driver 11 read DAC memory.
leddriver11_cfg_setup
void leddriver11_cfg_setup(leddriver11_cfg_t *cfg)
LED Driver 11 configuration object setup function.
leddriver11_return_value_t
leddriver11_return_value_t
LED Driver 11 Click return value data.
Definition: leddriver11.h:142
leddriver11_cfg_t
LED Driver 11 Click configuration object.
Definition: leddriver11.h:123