leddriver12  2.0.0.0
leddriver12.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 LEDDRIVER12_H
29 #define LEDDRIVER12_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 LEDDRIVER12_REG_INPUT0 0x00
70 #define LEDDRIVER12_REG_INPUT1 0x01
71 #define LEDDRIVER12_REG_PSC0 0x02
72 #define LEDDRIVER12_REG_PWM0 0x03
73 #define LEDDRIVER12_REG_PSC1 0x04
74 #define LEDDRIVER12_REG_PWM1 0x05
75 #define LEDDRIVER12_REG_LS0 0x06
76 #define LEDDRIVER12_REG_LS1 0x07
77 #define LEDDRIVER12_REG_LS2 0x08
78 #define LEDDRIVER12_REG_LS3 0x09
79  // leddriver12_reg
81 
96 #define LEDDRIVER12_AUTO_INCREMENT_BIT 0x10
97 
102 #define LEDDRIVER12_LED_OFF 0x00
103 #define LEDDRIVER12_LED_ON 0x01
104 #define LEDDRIVER12_LED_PWM0 0x02
105 #define LEDDRIVER12_LED_PWM1 0x03
106 #define LEDDRIVER12_LED0 0x00
107 #define LEDDRIVER12_LED1 0x01
108 #define LEDDRIVER12_LED2 0x02
109 #define LEDDRIVER12_LED3 0x03
110 #define LEDDRIVER12_LED4 0x04
111 #define LEDDRIVER12_LED5 0x05
112 #define LEDDRIVER12_LED6 0x06
113 #define LEDDRIVER12_LED7 0x07
114 #define LEDDRIVER12_LED8 0x08
115 #define LEDDRIVER12_LED9 0x09
116 #define LEDDRIVER12_LED10 0x0A
117 #define LEDDRIVER12_LED11 0x0B
118 #define LEDDRIVER12_LED12 0x0C
119 #define LEDDRIVER12_LED13 0x0D
120 #define LEDDRIVER12_LED14 0x0E
121 #define LEDDRIVER12_LED15 0x0F
122 #define LEDDRIVER12_LED0_TO_3 0x00
123 #define LEDDRIVER12_LED4_TO_7 0x01
124 #define LEDDRIVER12_LED8_TO_11 0x02
125 #define LEDDRIVER12_LED12_TO_15 0x03
126 #define LEDDRIVER12_ALL_LEDS 0xFF
127 
132 #define LEDDRIVER12_BLINK_PERIOD_MAX 1.68421
133 #define LEDDRIVER12_BLINK_PERIOD_MIN 0.00657
134 #define LEDDRIVER12_BLINK_PERIOD_ONE_SECOND 1.0
135 #define LEDDRIVER12_BLINK_PERIOD_HALF_SECOND 0.5
136 #define LEDDRIVER12_DUTY_CYCLE_MAX 0xFF
137 #define LEDDRIVER12_DUTY_CYCLE_HALF 0x80
138 #define LEDDRIVER12_DUTY_CYCLE_QUARTER 0x40
139 #define LEDDRIVER12_DUTY_CYCLE_MIN 0x00
140 
146 #define LEDDRIVER12_DEV_ADDR_A2A1A0_000 0x60
147 #define LEDDRIVER12_DEV_ADDR_A2A1A0_001 0x61
148 #define LEDDRIVER12_DEV_ADDR_A2A1A0_010 0x62
149 #define LEDDRIVER12_DEV_ADDR_A2A1A0_011 0x63
150 #define LEDDRIVER12_DEV_ADDR_A2A1A0_100 0x64
151 #define LEDDRIVER12_DEV_ADDR_A2A1A0_101 0x65
152 #define LEDDRIVER12_DEV_ADDR_A2A1A0_110 0x66
153 #define LEDDRIVER12_DEV_ADDR_A2A1A0_111 0x67
154  // leddriver12_set
156 
171 #define LEDDRIVER12_MAP_MIKROBUS( cfg, mikrobus ) \
172  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
173  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
174  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
175  // leddriver12_map // leddriver12
178 
183 typedef struct
184 {
185  // Output pins
186  digital_out_t rst;
188  // Modules
189  i2c_master_t i2c;
191  // I2C slave address
192  uint8_t slave_address;
194 } leddriver12_t;
195 
200 typedef struct
201 {
202  pin_name_t scl;
203  pin_name_t sda;
205  pin_name_t rst;
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
211 
216 typedef enum
217 {
219  LEDDRIVER12_ERROR = -1
220 
222 
239 
255 
270 
286 err_t leddriver12_generic_write ( leddriver12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
287 
303 err_t leddriver12_generic_read ( leddriver12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
304 
318 err_t leddriver12_write_register ( leddriver12_t *ctx, uint8_t reg, uint8_t data_in );
319 
333 err_t leddriver12_read_register ( leddriver12_t *ctx, uint8_t reg, uint8_t *data_out );
334 
344 void leddriver12_set_rst_pin ( leddriver12_t *ctx, uint8_t state );
345 
362 err_t leddriver12_set_led_config ( leddriver12_t *ctx, uint8_t led_number, uint8_t led_cfg );
363 
383 err_t leddriver12_set_led_port_config ( leddriver12_t *ctx, uint8_t led_port_number, uint8_t led_cfg );
384 
397 err_t leddriver12_read_input_0 ( leddriver12_t *ctx, uint8_t *data_out );
398 
411 err_t leddriver12_read_input_1 ( leddriver12_t *ctx, uint8_t *data_out );
412 
425 err_t leddriver12_set_blink_period_pwm_0 ( leddriver12_t *ctx, float blink_period );
426 
439 err_t leddriver12_set_blink_period_pwm_1 ( leddriver12_t *ctx, float blink_period );
440 
453 err_t leddriver12_set_duty_cycle_pwm_0 ( leddriver12_t *ctx, uint8_t duty_cycle );
454 
467 err_t leddriver12_set_duty_cycle_pwm_1 ( leddriver12_t *ctx, uint8_t duty_cycle );
468 
469 #ifdef __cplusplus
470 }
471 #endif
472 #endif // LEDDRIVER12_H
473  // leddriver12
475 
476 // ------------------------------------------------------------------------ END
leddriver12_set_blink_period_pwm_1
err_t leddriver12_set_blink_period_pwm_1(leddriver12_t *ctx, float blink_period)
LED Driver 12 set blink period pwm 1 function.
leddriver12_init
err_t leddriver12_init(leddriver12_t *ctx, leddriver12_cfg_t *cfg)
LED Driver 12 initialization function.
leddriver12_t
LED Driver 12 Click context object.
Definition: leddriver12.h:184
leddriver12_read_register
err_t leddriver12_read_register(leddriver12_t *ctx, uint8_t reg, uint8_t *data_out)
LED Driver 12 read register function.
leddriver12_set_led_port_config
err_t leddriver12_set_led_port_config(leddriver12_t *ctx, uint8_t led_port_number, uint8_t led_cfg)
LED Driver 12 set led port config function.
leddriver12_write_register
err_t leddriver12_write_register(leddriver12_t *ctx, uint8_t reg, uint8_t data_in)
LED Driver 12 write register function.
leddriver12_generic_write
err_t leddriver12_generic_write(leddriver12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
LED Driver 12 I2C writing function.
leddriver12_read_input_0
err_t leddriver12_read_input_0(leddriver12_t *ctx, uint8_t *data_out)
LED Driver 12 read input 0 function.
leddriver12_set_duty_cycle_pwm_1
err_t leddriver12_set_duty_cycle_pwm_1(leddriver12_t *ctx, uint8_t duty_cycle)
LED Driver 12 set duty cycle pwm 1 function.
leddriver12_t::slave_address
uint8_t slave_address
Definition: leddriver12.h:192
leddriver12_cfg_t::scl
pin_name_t scl
Definition: leddriver12.h:202
leddriver12_set_led_config
err_t leddriver12_set_led_config(leddriver12_t *ctx, uint8_t led_number, uint8_t led_cfg)
LED Driver 12 set led config function.
leddriver12_t::i2c
i2c_master_t i2c
Definition: leddriver12.h:189
leddriver12_cfg_t::rst
pin_name_t rst
Definition: leddriver12.h:205
leddriver12_cfg_t::sda
pin_name_t sda
Definition: leddriver12.h:203
leddriver12_read_input_1
err_t leddriver12_read_input_1(leddriver12_t *ctx, uint8_t *data_out)
LED Driver 12 read input 1 function.
leddriver12_cfg_t::i2c_address
uint8_t i2c_address
Definition: leddriver12.h:208
leddriver12_return_value_t
leddriver12_return_value_t
LED Driver 12 Click return value data.
Definition: leddriver12.h:217
leddriver12_default_cfg
err_t leddriver12_default_cfg(leddriver12_t *ctx)
LED Driver 12 default configuration function.
LEDDRIVER12_OK
@ LEDDRIVER12_OK
Definition: leddriver12.h:218
leddriver12_generic_read
err_t leddriver12_generic_read(leddriver12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
LED Driver 12 I2C reading function.
leddriver12_t::rst
digital_out_t rst
Definition: leddriver12.h:186
LEDDRIVER12_ERROR
@ LEDDRIVER12_ERROR
Definition: leddriver12.h:219
leddriver12_set_blink_period_pwm_0
err_t leddriver12_set_blink_period_pwm_0(leddriver12_t *ctx, float blink_period)
LED Driver 12 set blink period pwm 0 function.
leddriver12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: leddriver12.h:207
leddriver12_set_duty_cycle_pwm_0
err_t leddriver12_set_duty_cycle_pwm_0(leddriver12_t *ctx, uint8_t duty_cycle)
LED Driver 12 set duty cycle pwm 0 function.
leddriver12_set_rst_pin
void leddriver12_set_rst_pin(leddriver12_t *ctx, uint8_t state)
LED Driver 12 set rst pin function.
leddriver12_cfg_t
LED Driver 12 Click configuration object.
Definition: leddriver12.h:201
leddriver12_cfg_setup
void leddriver12_cfg_setup(leddriver12_cfg_t *cfg)
LED Driver 12 configuration object setup function.