brushless9  2.0.0.0
brushless9.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 BRUSHLESS9_H
29 #define BRUSHLESS9_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_pwm.h"
38 
59 #define BRUSHLESS9_DEF_FREQ 5000
60  // brushless9_cfg
62 
77 #define BRUSHLESS9_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79  cfg.fg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
80  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
81  cfg.brk = MIKROBUS( mikrobus, MIKROBUS_CS ); \
82  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
83  // brushless9_map // brushless9
86 
96 typedef struct
97 {
98  // Output pins
99  digital_out_t dir;
100  digital_out_t brk;
102  // Input pins
103  digital_in_t fg;
104  digital_in_t int_pin;
106  // Modules
107  pwm_t pwm;
109  // ctx variable
110  uint32_t pwm_freq;
112 } brushless9_t;
113 
118 typedef struct
119 {
120  // Communication gpio pins
121  pin_name_t pwm;
123  // Additional gpio pins
124  pin_name_t fg;
125  pin_name_t dir;
126  pin_name_t brk;
127  pin_name_t int_pin;
129  // Static variable
130  uint32_t dev_pwm_freq;
133 
150 
165 
177 err_t brushless9_set_duty_cycle ( brushless9_t *ctx, float duty_cycle );
178 
190 
202 
213 void brushless9_set_dir ( brushless9_t *ctx, uint8_t state );
214 
225 void brushless9_set_brk ( brushless9_t *ctx, uint8_t state );
226 
236 
246 
247 #ifdef __cplusplus
248 }
249 #endif
250 #endif // BRUSHLESS9_H
251  // brushless9
253 
254 // ------------------------------------------------------------------------ END
brushless9_t
Brushless 9 Click driver selector.
Definition: brushless9.h:97
brushless9_init
err_t brushless9_init(brushless9_t *ctx, brushless9_cfg_t *cfg)
Brushless 9 initialization function.
brushless9_cfg_t::brk
pin_name_t brk
Definition: brushless9.h:126
brushless9_cfg_t::int_pin
pin_name_t int_pin
Definition: brushless9.h:127
brushless9_t::pwm_freq
uint32_t pwm_freq
Definition: brushless9.h:110
brushless9_t::pwm
pwm_t pwm
Definition: brushless9.h:107
brushless9_cfg_t::pwm
pin_name_t pwm
Definition: brushless9.h:121
brushless9_t::fg
digital_in_t fg
Definition: brushless9.h:103
brushless9_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless9.h:130
brushless9_cfg_t::fg
pin_name_t fg
Definition: brushless9.h:124
brushless9_pwm_start
err_t brushless9_pwm_start(brushless9_t *ctx)
Brushless 9 start PWM module.
brushless9_set_brk
void brushless9_set_brk(brushless9_t *ctx, uint8_t state)
Brushless 9 brk pin setting.
brushless9_cfg_t::dir
pin_name_t dir
Definition: brushless9.h:125
brushless9_t::brk
digital_out_t brk
Definition: brushless9.h:100
brushless9_set_dir
void brushless9_set_dir(brushless9_t *ctx, uint8_t state)
Brushless 9 dir pin setting.
brushless9_pwm_stop
err_t brushless9_pwm_stop(brushless9_t *ctx)
Brushless 9 stop PWM module.
brushless9_get_fg
uint8_t brushless9_get_fg(brushless9_t *ctx)
Brushless 9 fg state.
brushless9_cfg_setup
void brushless9_cfg_setup(brushless9_cfg_t *cfg)
Brushless 9 configuration object setup function.
brushless9_t::int_pin
digital_in_t int_pin
Definition: brushless9.h:104
brushless9_set_duty_cycle
err_t brushless9_set_duty_cycle(brushless9_t *ctx, float duty_cycle)
Brushless 9 sets PWM duty cycle.
brushless9_cfg_t
Brushless 9 Click configuration object.
Definition: brushless9.h:119
brushless9_t::dir
digital_out_t dir
Definition: brushless9.h:99
brushless9_get_int_pin
uint8_t brushless9_get_int_pin(brushless9_t *ctx)
Brushless 9 int_pin state.