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 
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_pwm.h"
48 
69 #define BRUSHLESS24_DEF_FREQ 25000
70  // brushless24_cfg
72 
87 #define BRUSHLESS24_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
89  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
90  // brushless24_map // brushless24
93 
98 typedef struct
99 {
100  // Input pins
101  digital_in_t int_pin;
103  // Modules
104  pwm_t pwm;
106  // ctx variable
107  uint32_t pwm_freq;
109 } brushless24_t;
110 
115 typedef struct
116 {
117  // Communication gpio pins
118  pin_name_t pwm;
120  // Additional gpio pins
121  pin_name_t int_pin;
123  // Static variable
124  uint32_t dev_pwm_freq;
127 
132 typedef enum
133 {
135  BRUSHLESS24_ERROR = -1
136 
138 
155 
170 
184 
196 err_t brushless24_set_duty_cycle ( brushless24_t *ctx, float duty_cycle );
197 
209 
221 
231 
232 #ifdef __cplusplus
233 }
234 #endif
235 #endif // BRUSHLESS24_H
236  // brushless24
238 
239 // ------------------------------------------------------------------------ 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:104
brushless24_t
Brushless 24 Click context object.
Definition: brushless24.h:99
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:116
brushless24_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless24.h:124
brushless24_cfg_t::int_pin
pin_name_t int_pin
Definition: brushless24.h:121
brushless24_t::int_pin
digital_in_t int_pin
Definition: brushless24.h:101
BRUSHLESS24_ERROR
@ BRUSHLESS24_ERROR
Definition: brushless24.h:135
brushless24_return_value_t
brushless24_return_value_t
Brushless 24 Click return value data.
Definition: brushless24.h:133
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:134
brushless24_t::pwm_freq
uint32_t pwm_freq
Definition: brushless24.h:107
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:118
brushless24_cfg_setup
void brushless24_cfg_setup(brushless24_cfg_t *cfg)
Brushless 24 configuration object setup function.