leddriver17  2.1.0.0
leddriver17.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 LEDDRIVER17_H
29 #define LEDDRIVER17_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_pwm.h"
38 
59 #define LEDDRIVER17_DEF_FREQ 20000
60  // leddriver17_cfg
62 
77 #define LEDDRIVER17_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT );
80  // leddriver17_map // leddriver17
83 
88 typedef struct
89 {
90  // Input pins
91  digital_in_t flt;
93  // Modules
94  pwm_t pwm;
96  // ctx variable
97  uint32_t pwm_freq;
100 
105 typedef struct
106 {
107  // Communication gpio pins
108  pin_name_t pwm;
110  // Additional gpio pins
111  pin_name_t flt;
113  // Static variable
114  uint32_t dev_pwm_freq;
117 
122 typedef enum
123 {
125  LEDDRIVER17_ERROR = -1
126 
128 
145 
160 
174 
186 err_t leddriver17_set_duty_cycle ( leddriver17_t *ctx, float duty_cycle );
187 
199 
211 
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // LEDDRIVER17_H
226  // leddriver17
228 
229 // ------------------------------------------------------------------------ END
leddriver17_cfg_t::flt
pin_name_t flt
Definition: leddriver17.h:111
leddriver17_get_fault_pin
uint8_t leddriver17_get_fault_pin(leddriver17_t *ctx)
LED Driver 17 get fault pin function.
leddriver17_pwm_stop
err_t leddriver17_pwm_stop(leddriver17_t *ctx)
LED Driver 17 stop PWM module.
leddriver17_t::pwm_freq
uint32_t pwm_freq
Definition: leddriver17.h:97
leddriver17_cfg_t::pwm
pin_name_t pwm
Definition: leddriver17.h:108
leddriver17_cfg_setup
void leddriver17_cfg_setup(leddriver17_cfg_t *cfg)
LED Driver 17 configuration object setup function.
leddriver17_pwm_start
err_t leddriver17_pwm_start(leddriver17_t *ctx)
LED Driver 17 start PWM module.
leddriver17_set_duty_cycle
err_t leddriver17_set_duty_cycle(leddriver17_t *ctx, float duty_cycle)
LED Driver 17 sets PWM duty cycle.
leddriver17_return_value_t
leddriver17_return_value_t
LED Driver 17 Click return value data.
Definition: leddriver17.h:123
leddriver17_t::flt
digital_in_t flt
Definition: leddriver17.h:91
leddriver17_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: leddriver17.h:114
leddriver17_default_cfg
err_t leddriver17_default_cfg(leddriver17_t *ctx)
LED Driver 17 default configuration function.
LEDDRIVER17_ERROR
@ LEDDRIVER17_ERROR
Definition: leddriver17.h:125
LEDDRIVER17_OK
@ LEDDRIVER17_OK
Definition: leddriver17.h:124
leddriver17_t::pwm
pwm_t pwm
Definition: leddriver17.h:94
leddriver17_cfg_t
LED Driver 17 Click configuration object.
Definition: leddriver17.h:106
leddriver17_init
err_t leddriver17_init(leddriver17_t *ctx, leddriver17_cfg_t *cfg)
LED Driver 17 initialization function.
leddriver17_t
LED Driver 17 Click context object.
Definition: leddriver17.h:89