uvclight  2.0.0.0
uvclight.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef UVCLIGHT_H
36 #define UVCLIGHT_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_pwm.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define UVCLIGHT_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.dim = MIKROBUS( mikrobus, MIKROBUS_PWM )
54 
60 #define UVCLIGHT_RETVAL uint8_t
61 
62 #define UVCLIGHT_OK 0x00
63 #define UVCLIGHT_INIT_ERROR 0xFF
64 
70 #define UVCLIGHT_DEF_FREQ 20000
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Modules
86 
87  pwm_t dim;
88 
89  // ctx variable
90 
91  uint32_t pwm_freq;
92 
93 } uvclight_t;
94 
98 typedef struct
99 {
100  // Communication gpio pins
101 
102  pin_name_t dim;
103 
104  // Static variable
105 
106  uint32_t dev_pwm_freq;
107 
109  // End types group
111 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
112 
118 #ifdef __cplusplus
119 extern "C"{
120 #endif
121 
131 
141 
150 void uvclight_set_duty_cycle ( uvclight_t *ctx, float duty_cycle );
151 
160 
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 #endif // _UVCLIGHT_H_
174  // End public_function group
177 
178 // ------------------------------------------------------------------------- END
uvclight_init
UVCLIGHT_RETVAL uvclight_init(uvclight_t *ctx, uvclight_cfg_t *cfg)
Initialization function.
uvclight_t::dim
pwm_t dim
Definition: uvclight.h:87
uvclight_pwm_stop
void uvclight_pwm_stop(uvclight_t *ctx)
Stop PWM module.
uvclight_pwm_start
void uvclight_pwm_start(uvclight_t *ctx)
Start PWM module.
uvclight_t
Click ctx object definition.
Definition: uvclight.h:84
uvclight_cfg_t::dim
pin_name_t dim
Definition: uvclight.h:102
uvclight_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: uvclight.h:106
uvclight_set_duty_cycle
void uvclight_set_duty_cycle(uvclight_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
uvclight_cfg_t
Click configuration structure definition.
Definition: uvclight.h:99
uvclight_cfg_setup
void uvclight_cfg_setup(uvclight_cfg_t *cfg)
Config Object Initialization function.
uvclight_t::pwm_freq
uint32_t pwm_freq
Definition: uvclight.h:91
UVCLIGHT_RETVAL
#define UVCLIGHT_RETVAL
Definition: uvclight.h:60