brushless7  2.0.0.0
brushless7.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef BRUSHLESS7_H
36 #define BRUSHLESS7_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 #include "drv_pwm.h"
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define BRUSHLESS7_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.cmo = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.sby = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define BRUSHLESS7_RETVAL uint8_t
68 
69 #define BRUSHLESS7_OK 0x00
70 #define BRUSHLESS7_INIT_ERROR 0xFF
71 
77 #define BRUSHLESS7_SLAVE_ADDR_ID2_LOW_ID1_LOW 0x29
78 #define BRUSHLESS7_SLAVE_ADDR_ID2_LOW_ID1_HIGH 0x29
79 #define BRUSHLESS7_SLAVE_ADDR_ID2_HIGH_ID1_LOW 0x2D
80 #define BRUSHLESS7_SLAVE_ADDR_ID2_HIGH_ID1_HIGH 0x32
81 
87 #define BRUSHLESS7_REG_0 0
88 #define BRUSHLESS7_REG_1 1
89 #define BRUSHLESS7_REG_2 2
90 #define BRUSHLESS7_REG_3 3
91 #define BRUSHLESS7_REG_4 4
92 #define BRUSHLESS7_REG_5 5
93 #define BRUSHLESS7_REG_6 6
94 #define BRUSHLESS7_REG_7 7
95 #define BRUSHLESS7_REG_8 8
96 #define BRUSHLESS7_REG_9 9
97 #define BRUSHLESS7_REG_10 10
98 #define BRUSHLESS7_REG_11 11
99 #define BRUSHLESS7_REG_12 12
100 #define BRUSHLESS7_REG_13 13
101 #define BRUSHLESS7_REG_14 14
102 #define BRUSHLESS7_REG_15 15
103 #define BRUSHLESS7_REG_16 16
104 #define BRUSHLESS7_REG_17 17
105 #define BRUSHLESS7_REG_18 18
106 #define BRUSHLESS7_REG_19 19
107 #define BRUSHLESS7_REG_20 20
108 #define BRUSHLESS7_REG_21 21
109 #define BRUSHLESS7_REG_22 22
110 #define BRUSHLESS7_REG_23 23
111 #define BRUSHLESS7_REG_24 24
112 #define BRUSHLESS7_REG_25 25
113 #define BRUSHLESS7_REG_26 26
114 #define BRUSHLESS7_REG_27 27
115 #define BRUSHLESS7_REG_28 28
116 #define BRUSHLESS7_REG_29 29
117 #define BRUSHLESS7_REG_30 30
118 #define BRUSHLESS7_REG_86 86
119 #define BRUSHLESS7_REG_87 87
120 
126 #define BRUSHLESS7_DEV_ERROR 0xFF
127 #define BRUSHLESS7_DEV_OK 0x00
128 
134 #define BRUSHLESS7_MAX_SPEED_4096 0x00
135 #define BRUSHLESS7_MAX_SPEED_8192 0x02
136 #define BRUSHLESS7_MAX_SPEED_16384 0x04
137 #define BRUSHLESS7_MAX_SPEED_32768 0x06
138 
144 #define BRUSHLESS7_CTRL_TYPE_RPM 0xAA
145 #define BRUSHLESS7_CTRL_TYPE_DUTY 0xBB
146 #define BRUSHLESS7_CTRL_TYPE_STOP 0xCC
147 
153 #define BRUSHLESS7_DIR_CW 0xDD
154 #define BRUSHLESS7_DIR_CCW 0xEE
155 
161 #define BRUSHLESS7_ZERO 0
162 
168 #define BRUSHLESS7_START_DUTY_MAX 49.8
169 #define BRUSHLESS7_START_DUTY_AMP 512
170 
176 #define BRUSHLESS7_STOP_DUTY_MAX 49.6
177 #define BRUSHLESS7_STOP_DUTY_AMP 256
178 #define BRUSHLESS7_STOP_DUTY_MASK 0x80
179 
185 #define BRUSHLESS7_CHANGE_DUTY_MIN 0.4
186 #define BRUSHLESS7_CHANGE_DUTY_MAX 99.6
187 #define BRUSHLESS7_CHANGE_DUTY_AMP 256
188 
194 #define BRUSHLESS7_MAX_DUTY_MIN 50.2
195 #define BRUSHLESS7_MAX_DUTY_MAX 100.0
196 #define BRUSHLESS7_MAX_DUTY_AMP 512
197 #define BRUSHLESS7_MAX_DUTY_DEC 257
198 
204 #define BRUSHLESS7_START_RPM_MAX 4095
205 #define BRUSHLESS7_START_RPM_SHIFT 4
206 #define BRUSHLESS7_START_RPM_MASK 0x0F
207 
213 #define BRUSHLESS7_MAX_SPEED_RMP_MASK 0xF9
214 
220 #define BRUSHLESS7_PRECENTAGE_DIV 100
221 
227 #define BRUSHLESS7_DEF_FREQ 5000
228  // End group macro
231 // --------------------------------------------------------------- PUBLIC TYPES
240 typedef struct
241 {
242  // Output pins
243 
244  digital_out_t dir;
245  digital_out_t sby;
246 
247  // Input pins
248 
249  digital_in_t cmo;
250  digital_in_t int_pin;
251 
252  // Modules
253 
254  pwm_t pwm;
255  i2c_master_t i2c;
256 
257  // ctx variable
258 
259  uint32_t pwm_freq;
260  uint8_t slave_address;
261 
262 } brushless7_t;
263 
267 typedef struct
268 {
269  // Communication gpio pins
270 
271  pin_name_t scl;
272  pin_name_t sda;
273  pin_name_t pwm;
274 
275  // Additional gpio pins
276 
277  pin_name_t cmo;
278  pin_name_t dir;
279  pin_name_t sby;
280  pin_name_t int_pin;
281 
282  // static variable
283 
284  uint32_t dev_pwm_freq;
285  uint32_t i2c_speed;
286  uint8_t i2c_address;
287 
289  // End types group
291 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
292 
298 #ifdef __cplusplus
299 extern "C"{
300 #endif
301 
311 
321 
330 
341 void brushless7_generic_write ( brushless7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
342 
353 void brushless7_generic_read ( brushless7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
354 
361 void brushless7_set_sby_pin_state ( brushless7_t *ctx, uint8_t state );
362 
369 
378 
389 uint8_t brushless7_start_duty ( brushless7_t *ctx, float duty_ptc );
390 
401 uint8_t brushless7_stop_duty ( brushless7_t *ctx, float duty_ptc );
402 
413 uint8_t brushless7_change_duty ( brushless7_t *ctx, float duty_ptc );
414 
425 uint8_t brushless7_max_duty ( brushless7_t *ctx, float duty_ptc );
426 
437 uint8_t brushless7_start_rpm ( brushless7_t *ctx, uint16_t rpm_val );
438 
447 uint8_t brushless7_max_speed_rpm ( brushless7_t *ctx, uint8_t max_speed_rpm );
448 
457 uint8_t brushless7_rotating_direction ( brushless7_t *ctx, uint8_t direction_rot );
458 
467 uint8_t brushless7_control_mode_set ( brushless7_t *ctx, uint8_t ctrl_type );
468 
478 void brushless7_set_duty_cycle ( brushless7_t *ctx, float duty_cycle );
479 
487 void brushless7_pwm_stop ( brushless7_t *ctx );
488 
496 void brushless7_pwm_start ( brushless7_t *ctx );
497 
498 #ifdef __cplusplus
499 }
500 #endif
501 #endif // _BRUSHLESS7_H_
502  // End public_function group
505 
506 // ------------------------------------------------------------------------- END
brushless7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: brushless7.h:285
brushless7_default_cfg
void brushless7_default_cfg(brushless7_t *ctx)
Click Default Configuration function.
brushless7_max_duty
uint8_t brushless7_max_duty(brushless7_t *ctx, float duty_ptc)
Function for setting max duty of device.
brushless7_generic_read
void brushless7_generic_read(brushless7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
brushless7_cfg_t::dir
pin_name_t dir
Definition: brushless7.h:278
brushless7_t::pwm_freq
uint32_t pwm_freq
Definition: brushless7.h:259
brushless7_cfg_t::sby
pin_name_t sby
Definition: brushless7.h:279
brushless7_pwm_stop
void brushless7_pwm_stop(brushless7_t *ctx)
Stop PWM module.
brushless7_generic_write
void brushless7_generic_write(brushless7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
brushless7_t::sby
digital_out_t sby
Definition: brushless7.h:245
brushless7_t::pwm
pwm_t pwm
Definition: brushless7.h:254
brushless7_cfg_t::scl
pin_name_t scl
Definition: brushless7.h:271
brushless7_pwm_start
void brushless7_pwm_start(brushless7_t *ctx)
Start PWM module.
brushless7_start_rpm
uint8_t brushless7_start_rpm(brushless7_t *ctx, uint16_t rpm_val)
Function for setting start rpm parameter of device.
brushless7_start_duty
uint8_t brushless7_start_duty(brushless7_t *ctx, float duty_ptc)
Function for setting start duty of device.
brushless7_cfg_t::cmo
pin_name_t cmo
Definition: brushless7.h:277
brushless7_t::dir
digital_out_t dir
Definition: brushless7.h:244
brushless7_set_duty_cycle
void brushless7_set_duty_cycle(brushless7_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
brushless7_t::i2c
i2c_master_t i2c
Definition: brushless7.h:255
brushless7_cfg_t::pwm
pin_name_t pwm
Definition: brushless7.h:273
brushless7_get_int_pin_state
uint8_t brushless7_get_int_pin_state(brushless7_t *ctx)
Generic function for getting INT pin state.
brushless7_max_speed_rpm
uint8_t brushless7_max_speed_rpm(brushless7_t *ctx, uint8_t max_speed_rpm)
Function for setting max rpm parameter of device.
brushless7_cfg_t::sda
pin_name_t sda
Definition: brushless7.h:272
brushless7_toggle_dir_pin_state
void brushless7_toggle_dir_pin_state(brushless7_t *ctx)
Generic function for toggling DIR pin state.
brushless7_cfg_setup
void brushless7_cfg_setup(brushless7_cfg_t *cfg)
Config Object Initialization function.
brushless7_init
BRUSHLESS7_RETVAL brushless7_init(brushless7_t *ctx, brushless7_cfg_t *cfg)
Initialization function.
brushless7_rotating_direction
uint8_t brushless7_rotating_direction(brushless7_t *ctx, uint8_t direction_rot)
Function for setting rotation direction.
brushless7_control_mode_set
uint8_t brushless7_control_mode_set(brushless7_t *ctx, uint8_t ctrl_type)
Function for setting type of device control.
brushless7_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless7.h:284
brushless7_t::int_pin
digital_in_t int_pin
Definition: brushless7.h:250
brushless7_set_sby_pin_state
void brushless7_set_sby_pin_state(brushless7_t *ctx, uint8_t state)
Generic function for setting SBY pin state.
brushless7_change_duty
uint8_t brushless7_change_duty(brushless7_t *ctx, float duty_ptc)
Function for changeing duty of device.
brushless7_t::slave_address
uint8_t slave_address
Definition: brushless7.h:260
brushless7_t::cmo
digital_in_t cmo
Definition: brushless7.h:249
BRUSHLESS7_RETVAL
#define BRUSHLESS7_RETVAL
Definition: brushless7.h:67
brushless7_cfg_t::int_pin
pin_name_t int_pin
Definition: brushless7.h:280
brushless7_cfg_t
Click configuration structure definition.
Definition: brushless7.h:267
brushless7_cfg_t::i2c_address
uint8_t i2c_address
Definition: brushless7.h:286
brushless7_stop_duty
uint8_t brushless7_stop_duty(brushless7_t *ctx, float duty_ptc)
Function for setting stop duty of device.
brushless7_t
Click ctx object definition.
Definition: brushless7.h:240