brushless24  2.1.0.0
brushless24.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 BRUSHLESS24_H
29 #define BRUSHLESS24_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 BRUSHLESS24_DEF_FREQ 25000
74  // brushless24_cfg
76 
91 #define BRUSHLESS24_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
93  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
94  // brushless24_map // brushless24
97 
102 typedef struct
103 {
104  // Input pins
105  digital_in_t int_pin;
107  // Modules
108  pwm_t pwm;
110  // ctx variable
111  uint32_t pwm_freq;
113 } brushless24_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t pwm;
124  // Additional gpio pins
125  pin_name_t int_pin;
127  // Static variable
128  uint32_t dev_pwm_freq;
131 
136 typedef enum
137 {
139  BRUSHLESS24_ERROR = -1
140 
142 
159 
174 
188 
200 err_t brushless24_set_duty_cycle ( brushless24_t *ctx, float duty_cycle );
201 
213 
225 
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // BRUSHLESS24_H
240  // brushless24
242 
243 // ------------------------------------------------------------------------ END
brushless24_set_duty_cycle
err_t brushless24_set_duty_cycle(brushless24_t *ctx, float duty_cycle)
Brushless 24 sets PWM duty cycle.
brushless24_t::pwm
pwm_t pwm
Definition: brushless24.h:108
brushless24_t
Brushless 24 Click context object.
Definition: brushless24.h:103
brushless24_get_int_state
uint8_t brushless24_get_int_state(brushless24_t *ctx)
Brushless 24 get INT pin state.
brushless24_cfg_t
Brushless 24 Click configuration object.
Definition: brushless24.h:120
brushless24_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless24.h:128
brushless24_cfg_t::int_pin
pin_name_t int_pin
Definition: brushless24.h:125
brushless24_t::int_pin
digital_in_t int_pin
Definition: brushless24.h:105
BRUSHLESS24_ERROR
@ BRUSHLESS24_ERROR
Definition: brushless24.h:139
brushless24_return_value_t
brushless24_return_value_t
Brushless 24 Click return value data.
Definition: brushless24.h:137
brushless24_init
err_t brushless24_init(brushless24_t *ctx, brushless24_cfg_t *cfg)
Brushless 24 initialization function.
brushless24_default_cfg
err_t brushless24_default_cfg(brushless24_t *ctx)
Brushless 24 default configuration function.
brushless24_pwm_stop
err_t brushless24_pwm_stop(brushless24_t *ctx)
Brushless 24 stop PWM module.
BRUSHLESS24_OK
@ BRUSHLESS24_OK
Definition: brushless24.h:138
brushless24_t::pwm_freq
uint32_t pwm_freq
Definition: brushless24.h:111
brushless24_pwm_start
err_t brushless24_pwm_start(brushless24_t *ctx)
Brushless 24 start PWM module.
brushless24_cfg_t::pwm
pin_name_t pwm
Definition: brushless24.h:122
brushless24_cfg_setup
void brushless24_cfg_setup(brushless24_cfg_t *cfg)
Brushless 24 configuration object setup function.