dcmotor7  2.0.0.0
dcmotor7.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 DCMOTOR7_H
36 #define DCMOTOR7_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define DCMOTOR7_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.pwma = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.pwmb = MIKROBUS( mikrobus, MIKROBUS_PWM )
71 
77 #define DCMOTOR7_RETVAL uint8_t
78 
79 #define DCMOTOR7_OK 0x00
80 #define DCMOTOR7_INIT_ERROR 0xFF
81 
87 #define DCMOTOR7_CMD_INPUT_PORT 0x00 // def xxxx xxxx
88 #define DCMOTOR7_CMD_OUTPUT_PORT 0x01 // def 1111 1111
89 #define DCMOTOR7_CMD_POLARITY_INVERSION 0x02 // def 0000 0000
90 #define DCMOTOR7_CMD_CONFIGURATION 0x03 // def 1111 1111
91 
97 #define DCMOTOR7_PORT_0 0x01
98 #define DCMOTOR7_PORT_1 0x02
99 #define DCMOTOR7_PORT_2 0x04
100 #define DCMOTOR7_PORT_3 0x08
101 #define DCMOTOR7_PORT_4 0x10
102 #define DCMOTOR7_PORT_5 0x20
103 #define DCMOTOR7_PORT_6 0x40
104 #define DCMOTOR7_PORT_7 0x80
105 
111 #define DCMOTOR7_TBLK_FOSCM_X4_CLK 0x00
112 #define DCMOTOR7_TBLK_FOSCM_X6_CLK 0x01
113 
119 #define DCMOTOR7_HBMODE_SMALL_MODE 0x00
120 #define DCMOTOR7_HBMODE_LARGE_MODE 0x01
121 
127 #define DCMOTOR7_MOTOR_A 0x01
128 #define DCMOTOR7_MOTOR_B 0x02
129 
135 #define DCMOTOR7_SLAVE_ADDRESS_0_0 0x70
136 #define DCMOTOR7_SLAVE_ADDRESS_0_1 0x71
137 #define DCMOTOR7_SLAVE_ADDRESS_1_0 0x72
138 #define DCMOTOR7_SLAVE_ADDRESS_1_1 0x73
139 
145 #define DCMOTOR7_ENABLE_ALL_OUTPUT_PORT 0x00
146 #define DCMOTOR7_DISABLE_ALL_OUTPUT_PORT 0xFF
147  // End group macro
150 // --------------------------------------------------------------- PUBLIC TYPES
159 typedef struct
160 {
161  // Output pins
162 
163  digital_out_t pwma;
164  digital_out_t pwmb;
165 
166  // Modules
167 
168  i2c_master_t i2c;
169 
170  // ctx variable
171 
172  uint8_t slave_address;
173 
174 } dcmotor7_t;
175 
179 typedef struct
180 {
181  // Communication gpio pins
182 
183  pin_name_t scl;
184  pin_name_t sda;
185 
186  // Additional gpio pins
187 
188  pin_name_t pwma;
189  pin_name_t pwmb;
190 
191  // static variable
192 
193  uint32_t i2c_speed;
194  uint8_t i2c_address;
195 
197  // End types group
199 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
200 
206 #ifdef __cplusplus
207 extern "C"{
208 #endif
209 
219 
229 
247 
257 void dcmotor7_generic_write ( dcmotor7_t *ctx, uint8_t reg, uint8_t tmp );
258 
269 void dcmotor7_generic_read ( dcmotor7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
270 
278 void dcmotor7_set_port ( dcmotor7_t *ctx, uint8_t port, uint8_t value );
279 
288 void dcmotor7_set_motor ( dcmotor7_t *ctx, uint8_t motor, uint8_t in1, uint8_t in2 );
289 
296 void dcmotor7_set_tblkab ( dcmotor7_t *ctx, uint8_t tblk );
297 
304 void dcmotor7_set_hb_mode ( dcmotor7_t *ctx, uint8_t mode );
305 
312 void dcmotor7_motor_stop ( dcmotor7_t *ctx, uint8_t motor );
313 
320 void dcmotor7_go_to_stand_by_mode ( dcmotor7_t *ctx, uint8_t motor );
321 
328 void dcmotor7_set_pwm_motor_a ( dcmotor7_t *ctx, uint8_t state );
329 
336 void dcmotor7_set_pwm_motor_b ( dcmotor7_t *ctx, uint8_t state );
337 
338 #ifdef __cplusplus
339 }
340 #endif
341 #endif // _DCMOTOR7_H_
342  // End public_function group
345 
346 // ------------------------------------------------------------------------- END
dcmotor7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dcmotor7.h:193
dcmotor7_set_pwm_motor_b
void dcmotor7_set_pwm_motor_b(dcmotor7_t *ctx, uint8_t state)
Function for set PWM value for motor B.
dcmotor7_set_pwm_motor_a
void dcmotor7_set_pwm_motor_a(dcmotor7_t *ctx, uint8_t state)
Function for set PWM value for motor A.
dcmotor7_t::pwma
digital_out_t pwma
Definition: dcmotor7.h:163
dcmotor7_set_hb_mode
void dcmotor7_set_hb_mode(dcmotor7_t *ctx, uint8_t mode)
Functions for set H-Bridge operation mode.
DCMOTOR7_RETVAL
#define DCMOTOR7_RETVAL
Definition: dcmotor7.h:77
dcmotor7_cfg_t::i2c_address
uint8_t i2c_address
Definition: dcmotor7.h:194
dcmotor7_cfg_t::pwma
pin_name_t pwma
Definition: dcmotor7.h:188
dcmotor7_cfg_t::pwmb
pin_name_t pwmb
Definition: dcmotor7.h:189
dcmotor7_t
Click ctx object definition.
Definition: dcmotor7.h:160
dcmotor7_cfg_setup
void dcmotor7_cfg_setup(dcmotor7_cfg_t *cfg)
Config Object Initialization function.
dcmotor7_cfg_t::sda
pin_name_t sda
Definition: dcmotor7.h:184
dcmotor7_cfg_t::scl
pin_name_t scl
Definition: dcmotor7.h:183
dcmotor7_t::pwmb
digital_out_t pwmb
Definition: dcmotor7.h:164
dcmotor7_set_motor
void dcmotor7_set_motor(dcmotor7_t *ctx, uint8_t motor, uint8_t in1, uint8_t in2)
Functions for set Motor.
dcmotor7_t::slave_address
uint8_t slave_address
Definition: dcmotor7.h:172
dcmotor7_init
DCMOTOR7_RETVAL dcmotor7_init(dcmotor7_t *ctx, dcmotor7_cfg_t *cfg)
Initialization function.
dcmotor7_cfg_t
Click configuration structure definition.
Definition: dcmotor7.h:180
dcmotor7_motor_stop
void dcmotor7_motor_stop(dcmotor7_t *ctx, uint8_t motor)
Motor stop function.
dcmotor7_set_port
void dcmotor7_set_port(dcmotor7_t *ctx, uint8_t port, uint8_t value)
Functions for set port.
dcmotor7_go_to_stand_by_mode
void dcmotor7_go_to_stand_by_mode(dcmotor7_t *ctx, uint8_t motor)
Function for setting the motor in stand mode.
dcmotor7_generic_write
void dcmotor7_generic_write(dcmotor7_t *ctx, uint8_t reg, uint8_t tmp)
Generic write function.
dcmotor7_set_tblkab
void dcmotor7_set_tblkab(dcmotor7_t *ctx, uint8_t tblk)
Functions for set Motor Ach and Bch Digital tBLK.
dcmotor7_default_cfg
void dcmotor7_default_cfg(dcmotor7_t *ctx)
Default Confuguration.
dcmotor7_generic_read
void dcmotor7_generic_read(dcmotor7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
dcmotor7_t::i2c
i2c_master_t i2c
Definition: dcmotor7.h:168