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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_pwm.h"
52 
73 #define LEDDRIVER17_DEF_FREQ 20000
74  // leddriver17_cfg
76 
91 #define LEDDRIVER17_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
93  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT );
94  // leddriver17_map // leddriver17
97 
102 typedef struct
103 {
104  // Input pins
105  digital_in_t flt;
107  // Modules
108  pwm_t pwm;
110  // ctx variable
111  uint32_t pwm_freq;
113 } leddriver17_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t pwm;
124  // Additional gpio pins
125  pin_name_t flt;
127  // Static variable
128  uint32_t dev_pwm_freq;
131 
136 typedef enum
137 {
139  LEDDRIVER17_ERROR = -1
140 
142 
159 
174 
188 
200 err_t leddriver17_set_duty_cycle ( leddriver17_t *ctx, float duty_cycle );
201 
213 
225 
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // LEDDRIVER17_H
240  // leddriver17
242 
243 // ------------------------------------------------------------------------ END
leddriver17_cfg_t::flt
pin_name_t flt
Definition: leddriver17.h:125
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:111
leddriver17_cfg_t::pwm
pin_name_t pwm
Definition: leddriver17.h:122
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:137
leddriver17_t::flt
digital_in_t flt
Definition: leddriver17.h:105
leddriver17_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: leddriver17.h:128
leddriver17_default_cfg
err_t leddriver17_default_cfg(leddriver17_t *ctx)
LED Driver 17 default configuration function.
LEDDRIVER17_ERROR
@ LEDDRIVER17_ERROR
Definition: leddriver17.h:139
LEDDRIVER17_OK
@ LEDDRIVER17_OK
Definition: leddriver17.h:138
leddriver17_t::pwm
pwm_t pwm
Definition: leddriver17.h:108
leddriver17_cfg_t
LED Driver 17 Click configuration object.
Definition: leddriver17.h:120
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:103