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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_pwm.h"
38
59#define BRUSHLESS11_DEF_FREQ 5000
60
65#define BRUSHLESS11_PIN_STATE_HIGH 0x01
66#define BRUSHLESS11_PIN_STATE_LOW 0x00
67
72#define BRUSHLESS11_BRAKE_ON 0x01
73#define BRUSHLESS11_BRAKE_OFF 0x00
74 // brushless11_cfg
76
91#define BRUSHLESS11_MAP_MIKROBUS( cfg, mikrobus ) \
92 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
93 cfg.fg1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
94 cfg.brk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
95 cfg.fg2 = MIKROBUS( mikrobus, MIKROBUS_INT );
96 // brushless11_map // brushless11
99
104typedef struct
105{
106 // Output pins
107 digital_out_t brk;
109 // Input pins
110 digital_in_t fg1;
111 digital_in_t fg2;
113 // Modules
114 pwm_t pwm;
116 // ctx variable
117 uint32_t pwm_freq;
120
125typedef struct
126{
127 // Communication gpio pins
128 pin_name_t pwm;
130 // Additional gpio pins
131 pin_name_t fg1;
132 pin_name_t brk;
133 pin_name_t fg2;
135 // Static variable
136 uint32_t dev_pwm_freq;
139
144typedef enum
145{
148
150
167
182
196
208err_t brushless11_set_duty_cycle ( brushless11_t *ctx, float duty_cycle );
209
221
233
243void brushless11_set_brk_pin ( brushless11_t *ctx, uint8_t pin_state );
244
255
266
276void brushless11_set_brake ( brushless11_t *ctx, uint8_t brake_state );
277
289err_t brushless11_set_speed ( brushless11_t *ctx, uint8_t speed );
290
291#ifdef __cplusplus
292}
293#endif
294#endif // BRUSHLESS11_H
295 // brushless11
297
298// ------------------------------------------------------------------------ END
brushless11_return_value_t
Brushless 11 Click return value data.
Definition: brushless11.h:145
@ BRUSHLESS11_ERROR
Definition: brushless11.h:147
@ BRUSHLESS11_OK
Definition: brushless11.h:146
uint8_t brushless11_get_fg2_pin(brushless11_t *ctx)
Brushless 11 get FG2 pin state function.
void brushless11_set_brk_pin(brushless11_t *ctx, uint8_t pin_state)
Brushless 11 set BRK pin state function.
err_t brushless11_set_speed(brushless11_t *ctx, uint8_t speed)
Brushless 11 set motor speed.
err_t brushless11_pwm_start(brushless11_t *ctx)
Brushless 11 start PWM module.
err_t brushless11_init(brushless11_t *ctx, brushless11_cfg_t *cfg)
Brushless 11 initialization function.
err_t brushless11_pwm_stop(brushless11_t *ctx)
Brushless 11 stop PWM module.
void brushless11_set_brake(brushless11_t *ctx, uint8_t brake_state)
Brushless 11 set motor brake state function.
err_t brushless11_default_cfg(brushless11_t *ctx)
Brushless 11 default configuration function.
void brushless11_cfg_setup(brushless11_cfg_t *cfg)
Brushless 11 configuration object setup function.
uint8_t brushless11_get_fg1_pin(brushless11_t *ctx)
Brushless 11 get FG1 pin state function.
err_t brushless11_set_duty_cycle(brushless11_t *ctx, float duty_cycle)
Brushless 11 sets PWM duty cycle.
Brushless 11 Click configuration object.
Definition: brushless11.h:126
uint32_t dev_pwm_freq
Definition: brushless11.h:136
pin_name_t pwm
Definition: brushless11.h:128
pin_name_t fg2
Definition: brushless11.h:133
pin_name_t brk
Definition: brushless11.h:132
pin_name_t fg1
Definition: brushless11.h:131
Brushless 11 Click context object.
Definition: brushless11.h:105
digital_in_t fg2
Definition: brushless11.h:111
digital_out_t brk
Definition: brushless11.h:107
uint32_t pwm_freq
Definition: brushless11.h:117
digital_in_t fg1
Definition: brushless11.h:110
pwm_t pwm
Definition: brushless11.h:114