brushless11  2.1.0.0
brushless11.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 BRUSHLESS11_H
29 #define BRUSHLESS11_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 BRUSHLESS11_DEF_FREQ 5000
70 
75 #define BRUSHLESS11_PIN_STATE_HIGH 0x01
76 #define BRUSHLESS11_PIN_STATE_LOW 0x00
77 
82 #define BRUSHLESS11_BRAKE_ON 0x01
83 #define BRUSHLESS11_BRAKE_OFF 0x00
84  // brushless11_cfg
86 
101 #define BRUSHLESS11_MAP_MIKROBUS( cfg, mikrobus ) \
102  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
103  cfg.fg1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
104  cfg.brk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
105  cfg.fg2 = MIKROBUS( mikrobus, MIKROBUS_INT );
106  // brushless11_map // brushless11
109 
114 typedef struct
115 {
116  // Output pins
117  digital_out_t brk;
119  // Input pins
120  digital_in_t fg1;
121  digital_in_t fg2;
123  // Modules
124  pwm_t pwm;
126  // ctx variable
127  uint32_t pwm_freq;
129 } brushless11_t;
130 
135 typedef struct
136 {
137  // Communication gpio pins
138  pin_name_t pwm;
140  // Additional gpio pins
141  pin_name_t fg1;
142  pin_name_t brk;
143  pin_name_t fg2;
145  // Static variable
146  uint32_t dev_pwm_freq;
149 
154 typedef enum
155 {
157  BRUSHLESS11_ERROR = -1
158 
160 
177 
192 
206 
218 err_t brushless11_set_duty_cycle ( brushless11_t *ctx, float duty_cycle );
219 
231 
243 
253 void brushless11_set_brk_pin ( brushless11_t *ctx, uint8_t pin_state );
254 
265 
276 
286 void brushless11_set_brake ( brushless11_t *ctx, uint8_t brake_state );
287 
299 err_t brushless11_set_speed ( brushless11_t *ctx, uint8_t speed );
300 
301 #ifdef __cplusplus
302 }
303 #endif
304 #endif // BRUSHLESS11_H
305  // brushless11
307 
308 // ------------------------------------------------------------------------ END
brushless11_get_fg2_pin
uint8_t brushless11_get_fg2_pin(brushless11_t *ctx)
Brushless 11 get FG2 pin state function.
brushless11_cfg_t
Brushless 11 Click configuration object.
Definition: brushless11.h:136
brushless11_cfg_t::brk
pin_name_t brk
Definition: brushless11.h:142
brushless11_t::pwm
pwm_t pwm
Definition: brushless11.h:124
brushless11_cfg_t::fg2
pin_name_t fg2
Definition: brushless11.h:143
brushless11_set_duty_cycle
err_t brushless11_set_duty_cycle(brushless11_t *ctx, float duty_cycle)
Brushless 11 sets PWM duty cycle.
brushless11_set_brk_pin
void brushless11_set_brk_pin(brushless11_t *ctx, uint8_t pin_state)
Brushless 11 set BRK pin state function.
brushless11_init
err_t brushless11_init(brushless11_t *ctx, brushless11_cfg_t *cfg)
Brushless 11 initialization function.
brushless11_pwm_start
err_t brushless11_pwm_start(brushless11_t *ctx)
Brushless 11 start PWM module.
brushless11_t::fg1
digital_in_t fg1
Definition: brushless11.h:120
brushless11_get_fg1_pin
uint8_t brushless11_get_fg1_pin(brushless11_t *ctx)
Brushless 11 get FG1 pin state function.
brushless11_cfg_t::pwm
pin_name_t pwm
Definition: brushless11.h:138
brushless11_cfg_setup
void brushless11_cfg_setup(brushless11_cfg_t *cfg)
Brushless 11 configuration object setup function.
brushless11_return_value_t
brushless11_return_value_t
Brushless 11 Click return value data.
Definition: brushless11.h:155
brushless11_pwm_stop
err_t brushless11_pwm_stop(brushless11_t *ctx)
Brushless 11 stop PWM module.
BRUSHLESS11_ERROR
@ BRUSHLESS11_ERROR
Definition: brushless11.h:157
brushless11_t::brk
digital_out_t brk
Definition: brushless11.h:117
brushless11_set_brake
void brushless11_set_brake(brushless11_t *ctx, uint8_t brake_state)
Brushless 11 set motor brake state function.
brushless11_default_cfg
err_t brushless11_default_cfg(brushless11_t *ctx)
Brushless 11 default configuration function.
brushless11_t::fg2
digital_in_t fg2
Definition: brushless11.h:121
BRUSHLESS11_OK
@ BRUSHLESS11_OK
Definition: brushless11.h:156
brushless11_t
Brushless 11 Click context object.
Definition: brushless11.h:115
brushless11_t::pwm_freq
uint32_t pwm_freq
Definition: brushless11.h:127
brushless11_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless11.h:146
brushless11_cfg_t::fg1
pin_name_t fg1
Definition: brushless11.h:141
brushless11_set_speed
err_t brushless11_set_speed(brushless11_t *ctx, uint8_t speed)
Brushless 11 set motor speed.