brushless22  2.0.0.0
brushless22.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 BRUSHLESS22_H
29 #define BRUSHLESS22_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_i2c_master.h"
38 #include "drv_pwm.h"
39 
60 #define BRUSHLESS22_DIGIPOT_MAX_VALUE 100000ul
61 #define BRUSHLESS22_DIGIPOT_RESOLUTION 257
62 #define BRUSHLESS22_ROUND_TO_NEAREST_INT 0.5
63 #define BRUSHLESS22_SLEW_RATE_RES_MAX 47000
64 #define BRUSHLESS22_SLEW_RATE_RES_DEFAULT 10000
65 #define BRUSHLESS22_SLEW_RATE_RES_MIN 4700
66 #define BRUSHLESS22_RPROG_3900 3900
67 #define BRUSHLESS22_RPROG_24000 24000
68 #define BRUSHLESS22_RPROG_ADDRESS 0x10
69 
75 #define BRUSHLESS22_ADDR_A2A1A0_000 0x28
76 #define BRUSHLESS22_ADDR_A2A1A0_001 0x29
77 #define BRUSHLESS22_ADDR_A2A1A0_010 0x2A
78 #define BRUSHLESS22_ADDR_A2A1A0_011 0x2B
79 #define BRUSHLESS22_ADDR_A2A1A0_100 0x2C
80 #define BRUSHLESS22_ADDR_A2A1A0_101 0x2D
81 #define BRUSHLESS22_ADDR_A2A1A0_110 0x2E
82 #define BRUSHLESS22_ADDR_A2A1A0_111 0x2F
83 
88 #define BRUSHLESS22_DIR_FORWARD 0
89 #define BRUSHLESS22_DIR_REVERSE 1
90 
95 #define BRUSHLESS22_DEF_FREQ 50000
96  // brushless22_cfg
98 
113 #define BRUSHLESS22_MAP_MIKROBUS( cfg, mikrobus ) \
114  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
115  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
116  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
117  cfg.rt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
118  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
119  cfg.ss = MIKROBUS( mikrobus, MIKROBUS_CS ); \
120  cfg.fg = MIKROBUS( mikrobus, MIKROBUS_INT );
121  // brushless22_map // brushless22
124 
134 typedef struct
135 {
136  // Output pins
137  digital_out_t dir;
138  digital_out_t ss;
139  digital_out_t rt;
141  // Input pins
142  digital_in_t fg;
144  // Modules
145  i2c_master_t i2c;
146  pwm_t pwm;
148  // ctx variable
149  uint8_t slave_address;
150  uint32_t pwm_freq;
152 } brushless22_t;
153 
158 typedef struct
159 {
160  // Communication gpio pins
161  pin_name_t scl;
162  pin_name_t sda;
163  pin_name_t pwm;
165  // Additional gpio pins
166  pin_name_t dir;
167  pin_name_t ss;
168  pin_name_t fg;
169  pin_name_t rt;
171  // Static variable
172  uint32_t i2c_speed;
173  uint8_t i2c_address;
174  uint32_t dev_pwm_freq;
177 
182 typedef enum
183 {
185  BRUSHLESS22_ERROR = -1
186 
188 
205 
221 
236 
249 err_t brushless22_set_slew_rate_resistance ( brushless22_t *ctx, uint16_t res_ohm );
250 
263 err_t brushless22_set_rprog ( brushless22_t *ctx, uint16_t res_ohm );
264 
277 err_t brushless22_set_duty_cycle ( brushless22_t *ctx, float duty_cycle );
278 
291 
304 
314 
324 
335 void brushless22_set_direction ( brushless22_t *ctx, uint8_t dir );
336 
346 
356 
366 
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 #endif // BRUSHLESS22_H
381  // brushless22
383 
384 // ------------------------------------------------------------------------ END
brushless22_set_normal_regulation
void brushless22_set_normal_regulation(brushless22_t *ctx)
Brushless 22 set normal regulation function.
brushless22_t::i2c
i2c_master_t i2c
Definition: brushless22.h:145
brushless22_t::rt
digital_out_t rt
Definition: brushless22.h:139
brushless22_cfg_t
Brushless 22 Click configuration object.
Definition: brushless22.h:159
brushless22_init
err_t brushless22_init(brushless22_t *ctx, brushless22_cfg_t *cfg)
Brushless 22 initialization function.
brushless22_t::slave_address
uint8_t slave_address
Definition: brushless22.h:149
brushless22_t::ss
digital_out_t ss
Definition: brushless22.h:138
brushless22_pwm_start
err_t brushless22_pwm_start(brushless22_t *ctx)
Brushless 22 start PWM module.
brushless22_t::dir
digital_out_t dir
Definition: brushless22.h:137
brushless22_switch_direction
void brushless22_switch_direction(brushless22_t *ctx)
Brushless 22 switch direction function.
brushless22_cfg_setup
void brushless22_cfg_setup(brushless22_cfg_t *cfg)
Brushless 22 configuration object setup function.
brushless22_set_soft_start
void brushless22_set_soft_start(brushless22_t *ctx)
Brushless 22 set soft start function.
brushless22_pwm_stop
err_t brushless22_pwm_stop(brushless22_t *ctx)
Brushless 22 stop PWM module.
brushless22_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: brushless22.h:172
brushless22_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless22.h:174
brushless22_get_fg_pin
uint8_t brushless22_get_fg_pin(brushless22_t *ctx)
Brushless 22 get fd pin function.
brushless22_cfg_t::sda
pin_name_t sda
Definition: brushless22.h:162
brushless22_t
Brushless 22 Click driver selector.
Definition: brushless22.h:135
brushless22_set_low_load_regulation
void brushless22_set_low_load_regulation(brushless22_t *ctx)
Brushless 22 set low load regulation function.
brushless22_cfg_t::scl
pin_name_t scl
Definition: brushless22.h:161
brushless22_cfg_t::i2c_address
uint8_t i2c_address
Definition: brushless22.h:173
brushless22_set_direction
void brushless22_set_direction(brushless22_t *ctx, uint8_t dir)
Brushless 22 set direction function.
brushless22_return_value_t
brushless22_return_value_t
Brushless 22 Click return value data.
Definition: brushless22.h:183
brushless22_set_strong_start
void brushless22_set_strong_start(brushless22_t *ctx)
Brushless 22 set strong start function.
brushless22_t::fg
digital_in_t fg
Definition: brushless22.h:142
brushless22_cfg_t::dir
pin_name_t dir
Definition: brushless22.h:166
brushless22_set_slew_rate_resistance
err_t brushless22_set_slew_rate_resistance(brushless22_t *ctx, uint16_t res_ohm)
Brushless 22 set slew rate resistance function.
BRUSHLESS22_ERROR
@ BRUSHLESS22_ERROR
Definition: brushless22.h:185
BRUSHLESS22_OK
@ BRUSHLESS22_OK
Definition: brushless22.h:184
brushless22_cfg_t::pwm
pin_name_t pwm
Definition: brushless22.h:163
brushless22_t::pwm_freq
uint32_t pwm_freq
Definition: brushless22.h:150
brushless22_set_duty_cycle
err_t brushless22_set_duty_cycle(brushless22_t *ctx, float duty_cycle)
Brushless 22 sets PWM duty cycle.
brushless22_cfg_t::rt
pin_name_t rt
Definition: brushless22.h:169
brushless22_set_rprog
err_t brushless22_set_rprog(brushless22_t *ctx, uint16_t res_ohm)
Brushless 22 set rprog function.
brushless22_default_cfg
err_t brushless22_default_cfg(brushless22_t *ctx)
Brushless 22 default configuration function.
brushless22_t::pwm
pwm_t pwm
Definition: brushless22.h:146
brushless22_cfg_t::ss
pin_name_t ss
Definition: brushless22.h:167
brushless22_cfg_t::fg
pin_name_t fg
Definition: brushless22.h:168