brushless17  2.0.0.0
brushless17.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 BRUSHLESS17_H
29 #define BRUSHLESS17_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 BRUSHLESS17_DIR_CCW 0
60 #define BRUSHLESS17_DIR_CW 1
61 
66 #define BRUSHLESS17_DEF_FREQ 5000
67  // brushless17_cfg
69 
84 #define BRUSHLESS17_MAP_MIKROBUS( cfg, mikrobus ) \
85  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
86  cfg.brk = MIKROBUS( mikrobus, MIKROBUS_AN ); \
87  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
88  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
89  cfg.diag = MIKROBUS( mikrobus, MIKROBUS_INT );
90  // brushless17_map // brushless17
93 
103 typedef struct
104 {
105  // Output pins
106  digital_out_t brk;
107  digital_out_t dir;
108  digital_out_t en;
110  // Input pins
111  digital_in_t diag;
113  // Modules
114  pwm_t pwm;
116  // ctx variable
117  uint32_t pwm_freq;
119 } brushless17_t;
120 
125 typedef struct
126 {
127  // Communication gpio pins
128  pin_name_t pwm;
130  // Additional gpio pins
131  pin_name_t brk;
132  pin_name_t dir;
133  pin_name_t en;
134  pin_name_t diag;
136  // Static variable
137  uint32_t dev_pwm_freq;
140 
145 typedef enum
146 {
148  BRUSHLESS17_ERROR = -1
149 
151 
168 
184 
199 
212 err_t brushless17_set_duty_cycle ( brushless17_t *ctx, float duty_cycle );
213 
226 
239 
249 
259 
270 void brushless17_set_direction ( brushless17_t *ctx, uint8_t dir );
271 
281 
291 
301 
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // BRUSHLESS17_H
317  // brushless17
319 
320 // ------------------------------------------------------------------------ END
brushless17_switch_direction
void brushless17_switch_direction(brushless17_t *ctx)
Brushless 17 switch direction function.
brushless17_pull_brake
void brushless17_pull_brake(brushless17_t *ctx)
Brushless 17 pull brake function.
brushless17_disable_chip
void brushless17_disable_chip(brushless17_t *ctx)
Brushless 17 disable chip function.
brushless17_cfg_t
Brushless 17 Click configuration object.
Definition: brushless17.h:126
brushless17_cfg_setup
void brushless17_cfg_setup(brushless17_cfg_t *cfg)
Brushless 17 configuration object setup function.
brushless17_get_diagnostic_pin
uint8_t brushless17_get_diagnostic_pin(brushless17_t *ctx)
Brushless 17 get diagnostic pin function.
brushless17_enable_chip
void brushless17_enable_chip(brushless17_t *ctx)
Brushless 17 enable chip function.
brushless17_t::en
digital_out_t en
Definition: brushless17.h:108
brushless17_cfg_t::dir
pin_name_t dir
Definition: brushless17.h:132
brushless17_t::brk
digital_out_t brk
Definition: brushless17.h:106
brushless17_t
Brushless 17 Click driver selector.
Definition: brushless17.h:104
brushless17_return_value_t
brushless17_return_value_t
Brushless 17 Click return value data.
Definition: brushless17.h:146
BRUSHLESS17_OK
@ BRUSHLESS17_OK
Definition: brushless17.h:147
brushless17_t::dir
digital_out_t dir
Definition: brushless17.h:107
brushless17_t::diag
digital_in_t diag
Definition: brushless17.h:111
BRUSHLESS17_ERROR
@ BRUSHLESS17_ERROR
Definition: brushless17.h:148
brushless17_cfg_t::en
pin_name_t en
Definition: brushless17.h:133
brushless17_cfg_t::pwm
pin_name_t pwm
Definition: brushless17.h:128
brushless17_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless17.h:137
brushless17_cfg_t::brk
pin_name_t brk
Definition: brushless17.h:131
brushless17_default_cfg
err_t brushless17_default_cfg(brushless17_t *ctx)
Brushless 17 default configuration function.
brushless17_pwm_stop
err_t brushless17_pwm_stop(brushless17_t *ctx)
Brushless 17 stop PWM module.
brushless17_pwm_start
err_t brushless17_pwm_start(brushless17_t *ctx)
Brushless 17 start PWM module.
brushless17_cfg_t::diag
pin_name_t diag
Definition: brushless17.h:134
brushless17_release_brake
void brushless17_release_brake(brushless17_t *ctx)
Brushless 17 release brake function.
brushless17_set_direction
void brushless17_set_direction(brushless17_t *ctx, uint8_t dir)
Brushless 17 set direction function.
brushless17_t::pwm_freq
uint32_t pwm_freq
Definition: brushless17.h:117
brushless17_set_duty_cycle
err_t brushless17_set_duty_cycle(brushless17_t *ctx, float duty_cycle)
Brushless 17 sets PWM duty cycle.
brushless17_init
err_t brushless17_init(brushless17_t *ctx, brushless17_cfg_t *cfg)
Brushless 17 initialization function.
brushless17_t::pwm
pwm_t pwm
Definition: brushless17.h:114