dcmotor11  2.0.0.0
dcmotor11.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 DCMOTOR11_H
36 #define DCMOTOR11_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define DCMOTOR11_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define DCMOTOR11_RETVAL uint8_t
73 
74 #define DCMOTOR11_OK 0x00
75 #define DCMOTOR11_INIT_ERROR 0xFF
76 
82 #define DCMOTOR11_DEVICE_SLAVE_ADDR_0_0 0x60
83 #define DCMOTOR11_DEVICE_SLAVE_ADDR_0_1 0x62
84 #define DCMOTOR11_DEVICE_SLAVE_ADDR_1_0 0x66
85 #define DCMOTOR11_DEVICE_SLAVE_ADDR_1_1 0x68
86 
92 #define DCMOTOR11_REGISTER_CONTROL 0x00
93 #define DCMOTOR11_REGISTER_FAULT 0x01
94 
100 #define DCMOTOR11_VSET_480mV 0x06 << 2
101 #define DCMOTOR11_VSET_560mV 0x07 << 2
102 #define DCMOTOR11_VSET_640mV 0x08 << 2
103 #define DCMOTOR11_VSET_720mV 0x09 << 2
104 #define DCMOTOR11_VSET_800mV 0x0A << 2
105 #define DCMOTOR11_VSET_880mV 0x0B << 2
106 #define DCMOTOR11_VSET_960mV 0x0C << 2
107 #define DCMOTOR11_VSET_1040mV 0x0D << 2
108 #define DCMOTOR11_VSET_1120mV 0x0E << 2
109 #define DCMOTOR11_VSET_1200mV 0x0F << 2
110 #define DCMOTOR11_VSET_1290mV 0x10 << 2
111 #define DCMOTOR11_VSET_1370mV 0x11 << 2
112 #define DCMOTOR11_VSET_1450mV 0x12 << 2
113 #define DCMOTOR11_VSET_1530mV 0x13 << 2
114 #define DCMOTOR11_VSET_1610mV 0x14 << 2
115 #define DCMOTOR11_VSET_1690mV 0x15 << 2
116 #define DCMOTOR11_VSET_1770mV 0x16 << 2
117 #define DCMOTOR11_VSET_1850mV 0x17 << 2
118 #define DCMOTOR11_VSET_1930mV 0x18 << 2
119 #define DCMOTOR11_VSET_2010mV 0x19 << 2
120 #define DCMOTOR11_VSET_2090mV 0x1A << 2
121 #define DCMOTOR11_VSET_2170mV 0x1B << 2
122 #define DCMOTOR11_VSET_2500mV 0x1C << 2
123 #define DCMOTOR11_VSET_2330mV 0x1D << 2
124 #define DCMOTOR11_VSET_2410mV 0x1E << 2
125 #define DCMOTOR11_VSET_2490mV 0x1F << 2
126 #define DCMOTOR11_VSET_2570mV 0x20 << 2
127 #define DCMOTOR11_VSET_2650mV 0x21 << 2
128 #define DCMOTOR11_VSET_2730mV 0x22 << 2
129 #define DCMOTOR11_VSET_2810mV 0x23 << 2
130 #define DCMOTOR11_VSET_2890mV 0x24 << 2
131 #define DCMOTOR11_VSET_2970mV 0x25 << 2
132 #define DCMOTOR11_VSET_3050mV 0x26 << 2
133 #define DCMOTOR11_VSET_3130mV 0x27 << 2
134 #define DCMOTOR11_VSET_3210mV 0x28 << 2
135 #define DCMOTOR11_VSET_3290mV 0x29 << 2
136 #define DCMOTOR11_VSET_3370mV 0x2A << 2
137 #define DCMOTOR11_VSET_3450mV 0x2B << 2
138 #define DCMOTOR11_VSET_3530mV 0x2C << 2
139 #define DCMOTOR11_VSET_3610mV 0x2D << 2
140 #define DCMOTOR11_VSET_3690mV 0x2E << 2
141 #define DCMOTOR11_VSET_3770mV 0x2F << 2
142 #define DCMOTOR11_VSET_3860mV 0x30 << 2
143 #define DCMOTOR11_VSET_3940mV 0x31 << 2
144 #define DCMOTOR11_VSET_4020mV 0x32 << 2
145 #define DCMOTOR11_VSET_4100mV 0x33 << 2
146 #define DCMOTOR11_VSET_4180mV 0x34 << 2
147 #define DCMOTOR11_VSET_4260mV 0x35 << 2
148 #define DCMOTOR11_VSET_4340mV 0x36 << 2
149 #define DCMOTOR11_VSET_4420mV 0x37 << 2
150 #define DCMOTOR11_VSET_4500mV 0x38 << 2
151 #define DCMOTOR11_VSET_4580mV 0x39 << 2
152 #define DCMOTOR11_VSET_4660mV 0x3A << 2
153 #define DCMOTOR11_VSET_4740mV 0x3B << 2
154 #define DCMOTOR11_VSET_4820mV 0x3C << 2
155 #define DCMOTOR11_VSET_4900mV 0x3D << 2
156 #define DCMOTOR11_VSET_4980mV 0x3E << 2
157 #define DCMOTOR11_VSET_5060mV 0x3F << 2
158 
164 #define DCMOTOR11_DIRECTION_FORWARD 0x01
165 #define DCMOTOR11_DIRECTION_BACKWARD 0x02
166 #define DCMOTOR11_DIRECTION_STOP 0x00
167 #define DCMOTOR11_DIRECTION_BREAK 0x03
168  // End group macro
171 // --------------------------------------------------------------- PUBLIC TYPES
180 typedef struct
181 {
182  // Input pins
183 
184  digital_in_t flt;
185 
186  // Modules
187 
188  i2c_master_t i2c;
189 
190  // ctx variable
191 
192  uint8_t slave_address;
193 
194 } dcmotor11_t;
195 
199 typedef struct
200 {
201  // Communication gpio pins
202 
203  pin_name_t scl;
204  pin_name_t sda;
205 
206  // Additional gpio pins
207 
208  pin_name_t flt;
209 
210  // static variable
211 
212  uint32_t i2c_speed;
213  uint8_t i2c_address;
214 
216  // End types group
218 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
219 
225 #ifdef __cplusplus
226 extern "C"{
227 #endif
228 
238 
248 
259 void dcmotor11_generic_write ( dcmotor11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
260 
271 void dcmotor11_generic_read ( dcmotor11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
272 
280 void dcmotor11_control ( dcmotor11_t *ctx, uint8_t dir, uint8_t speed );
281 
290 
297 void dcmotor11_clear_fault ( dcmotor11_t *ctx, uint8_t dev_data );
298 
305 
312 
321 
322 #ifdef __cplusplus
323 }
324 #endif
325 #endif // _DCMOTOR11_H_
326  // End public_function group
329 
330 // ------------------------------------------------------------------------- END
dcmotor11_cfg_t
Click configuration structure definition.
Definition: dcmotor11.h:200
dcmotor11_clear_fault
void dcmotor11_clear_fault(dcmotor11_t *ctx, uint8_t dev_data)
Set Fault.
dcmotor11_control
void dcmotor11_control(dcmotor11_t *ctx, uint8_t dir, uint8_t speed)
Motor Control.
dcmotor11_generic_read
void dcmotor11_generic_read(dcmotor11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
dcmotor11_stop
void dcmotor11_stop(dcmotor11_t *ctx)
Motor Stop.
dcmotor11_cfg_t::sda
pin_name_t sda
Definition: dcmotor11.h:204
dcmotor11_cfg_t::scl
pin_name_t scl
Definition: dcmotor11.h:203
dcmotor11_t::flt
digital_in_t flt
Definition: dcmotor11.h:184
dcmotor11_cfg_t::flt
pin_name_t flt
Definition: dcmotor11.h:208
dcmotor11_get_interrupt_state
uint8_t dcmotor11_get_interrupt_state(dcmotor11_t *ctx)
Interrupt state on the INT pin.
dcmotor11_cfg_t::i2c_address
uint8_t i2c_address
Definition: dcmotor11.h:213
dcmotor11_generic_write
void dcmotor11_generic_write(dcmotor11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
dcmotor11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dcmotor11.h:212
dcmotor11_init
DCMOTOR11_RETVAL dcmotor11_init(dcmotor11_t *ctx, dcmotor11_cfg_t *cfg)
Initialization function.
DCMOTOR11_RETVAL
#define DCMOTOR11_RETVAL
Definition: dcmotor11.h:72
dcmotor11_get_fault
uint8_t dcmotor11_get_fault(dcmotor11_t *ctx)
Get Fault.
dcmotor11_cfg_setup
void dcmotor11_cfg_setup(dcmotor11_cfg_t *cfg)
Config Object Initialization function.
dcmotor11_t::i2c
i2c_master_t i2c
Definition: dcmotor11.h:188
dcmotor11_t::slave_address
uint8_t slave_address
Definition: dcmotor11.h:192
dcmotor11_t
Click ctx object definition.
Definition: dcmotor11.h:181
dcmotor11_break
void dcmotor11_break(dcmotor11_t *ctx)
Motor Break.