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 "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 BRUSHLESS17_DIR_CCW 0
70 #define BRUSHLESS17_DIR_CW 1
71 
76 #define BRUSHLESS17_DEF_FREQ 5000
77  // brushless17_cfg
79 
94 #define BRUSHLESS17_MAP_MIKROBUS( cfg, mikrobus ) \
95  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
96  cfg.brk = MIKROBUS( mikrobus, MIKROBUS_AN ); \
97  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
98  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
99  cfg.diag = MIKROBUS( mikrobus, MIKROBUS_INT );
100  // brushless17_map // brushless17
103 
113 typedef struct
114 {
115  // Output pins
116  digital_out_t brk;
117  digital_out_t dir;
118  digital_out_t en;
120  // Input pins
121  digital_in_t diag;
123  // Modules
124  pwm_t pwm;
126  // ctx variable
127  uint32_t pwm_freq;
129 } brushless17_t;
130 
135 typedef struct
136 {
137  // Communication gpio pins
138  pin_name_t pwm;
140  // Additional gpio pins
141  pin_name_t brk;
142  pin_name_t dir;
143  pin_name_t en;
144  pin_name_t diag;
146  // Static variable
147  uint32_t dev_pwm_freq;
150 
155 typedef enum
156 {
158  BRUSHLESS17_ERROR = -1
159 
161 
178 
194 
209 
222 err_t brushless17_set_duty_cycle ( brushless17_t *ctx, float duty_cycle );
223 
236 
249 
259 
269 
280 void brushless17_set_direction ( brushless17_t *ctx, uint8_t dir );
281 
291 
301 
311 
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 #endif // BRUSHLESS17_H
327  // brushless17
329 
330 // ------------------------------------------------------------------------ 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:136
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:118
brushless17_cfg_t::dir
pin_name_t dir
Definition: brushless17.h:142
brushless17_t::brk
digital_out_t brk
Definition: brushless17.h:116
brushless17_t
Brushless 17 Click driver selector.
Definition: brushless17.h:114
brushless17_return_value_t
brushless17_return_value_t
Brushless 17 Click return value data.
Definition: brushless17.h:156
BRUSHLESS17_OK
@ BRUSHLESS17_OK
Definition: brushless17.h:157
brushless17_t::dir
digital_out_t dir
Definition: brushless17.h:117
brushless17_t::diag
digital_in_t diag
Definition: brushless17.h:121
BRUSHLESS17_ERROR
@ BRUSHLESS17_ERROR
Definition: brushless17.h:158
brushless17_cfg_t::en
pin_name_t en
Definition: brushless17.h:143
brushless17_cfg_t::pwm
pin_name_t pwm
Definition: brushless17.h:138
brushless17_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless17.h:147
brushless17_cfg_t::brk
pin_name_t brk
Definition: brushless17.h:141
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:144
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:127
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:124