hbridge15  2.1.0.0
hbridge15.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 HBRIDGE15_H
29 #define HBRIDGE15_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define HBRIDGE15_REG_INPUT_PORT 0x00
74 #define HBRIDGE15_REG_OUTPUT_PORT 0x01
75 #define HBRIDGE15_REG_POLARITY_INVERSION 0x02
76 #define HBRIDGE15_REG_CONFIGURATION 0x03
77  // hbridge15_reg
79 
94 #define HBRIDGE15_PIN_MASK_NONE 0x00
95 #define HBRIDGE15_PIN_MASK_SLP 0x01
96 #define HBRIDGE15_PIN_MASK_FLT 0x02
97 #define HBRIDGE15_PIN_MASK_CONFIG 0x04
98 #define HBRIDGE15_PIN_MASK_M1 0x08
99 #define HBRIDGE15_PIN_MASK_M0 0x10
100 #define HBRIDGE15_PIN_MASK_DIR 0x20
101 #define HBRIDGE15_PIN_MASK_EN_B 0x40
102 #define HBRIDGE15_PIN_MASK_EN_A 0x80
103 #define HBRIDGE15_PIN_MASK_ALL 0xFF
104 
109 #define HBRIDGE15_PIN_STATE_HIGH 0x01
110 #define HBRIDGE15_PIN_STATE_LOW 0x00
111 
116 #define HBRIDGE15_SLEEP_STATE_ON 0x01
117 #define HBRIDGE15_SLEEP_STATE_OFF 0x00
118 
123 #define HBRIDGE15_DRIVE_MOTOR_REVERSE 0x00
124 #define HBRIDGE15_DRIVE_MOTOR_FORWARD 0x01
125 #define HBRIDGE15_DRIVE_MOTOR_FREEWHEEL 0x02
126 #define HBRIDGE15_DRIVE_MOTOR_BRAKE 0x03
127 
133 #define HBRIDGE15_DEVICE_ADDRESS_00 0x70
134 #define HBRIDGE15_DEVICE_ADDRESS_01 0x71
135 #define HBRIDGE15_DEVICE_ADDRESS_10 0x72
136 #define HBRIDGE15_DEVICE_ADDRESS_11 0x73
137  // hbridge15_set
139 
154 #define HBRIDGE15_MAP_MIKROBUS( cfg, mikrobus ) \
155  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
156  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
157  cfg.ena = MIKROBUS( mikrobus, MIKROBUS_CS ); \
158  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
159  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
160  // hbridge15_map // hbridge15
163 
168 typedef struct
169 {
170  // Output pins
171  digital_out_t ena;
172  digital_out_t rst;
174  // Input pins
175  digital_in_t int_pin;
177  // Modules
178  i2c_master_t i2c;
180  // I2C slave address
181  uint8_t slave_address;
183 } hbridge15_t;
184 
189 typedef struct
190 {
191  pin_name_t scl;
192  pin_name_t sda;
194  pin_name_t ena;
195  pin_name_t rst;
196  pin_name_t int_pin;
198  uint32_t i2c_speed;
199  uint8_t i2c_address;
202 
207 typedef enum
208 {
210  HBRIDGE15_ERROR = -1
211 
213 
230 
245 
259 
274 err_t hbridge15_generic_write ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
275 
290 err_t hbridge15_generic_read ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
291 
301 void hbridge15_set_rst_pin ( hbridge15_t *ctx, uint8_t pin_state );
302 
312 void hbridge15_set_ena_pin ( hbridge15_t *ctx, uint8_t pin_state );
313 
323 
333 
347 err_t hbridge15_write_reg ( hbridge15_t *ctx, uint8_t reg, uint8_t data_in );
348 
361 err_t hbridge15_read_reg ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_out );
362 
375 err_t hbridge15_set_pins ( hbridge15_t *ctx, uint8_t set_mask, uint8_t clr_mask );
376 
389 err_t hbridge15_set_sleep ( hbridge15_t *ctx, uint8_t sleep_state );
390 
403 err_t hbridge15_set_out_state ( hbridge15_t *ctx, uint8_t out_state );
404 
405 #ifdef __cplusplus
406 }
407 #endif
408 #endif // HBRIDGE15_H
409  // hbridge15
411 
412 // ------------------------------------------------------------------------ END
hbridge15_cfg_t::sda
pin_name_t sda
Definition: hbridge15.h:192
hbridge15_read_reg
err_t hbridge15_read_reg(hbridge15_t *ctx, uint8_t reg, uint8_t *data_out)
H-Bridge 15 read register function.
hbridge15_cfg_t::scl
pin_name_t scl
Definition: hbridge15.h:191
hbridge15_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hbridge15.h:198
HBRIDGE15_OK
@ HBRIDGE15_OK
Definition: hbridge15.h:209
hbridge15_t
H-Bridge 15 Click context object.
Definition: hbridge15.h:169
hbridge15_cfg_t::i2c_address
uint8_t i2c_address
Definition: hbridge15.h:199
hbridge15_cfg_t
H-Bridge 15 Click configuration object.
Definition: hbridge15.h:190
hbridge15_default_cfg
err_t hbridge15_default_cfg(hbridge15_t *ctx)
H-Bridge 15 default configuration function.
hbridge15_init
err_t hbridge15_init(hbridge15_t *ctx, hbridge15_cfg_t *cfg)
H-Bridge 15 initialization function.
hbridge15_get_int_state
uint8_t hbridge15_get_int_state(hbridge15_t *ctx)
H-Bridge 15 get INT pin state function.
hbridge15_generic_read
err_t hbridge15_generic_read(hbridge15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
H-Bridge 15 I2C reading function.
hbridge15_cfg_t::ena
pin_name_t ena
Definition: hbridge15.h:194
hbridge15_generic_write
err_t hbridge15_generic_write(hbridge15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
H-Bridge 15 I2C writing function.
hbridge15_t::ena
digital_out_t ena
Definition: hbridge15.h:171
hbridge15_t::slave_address
uint8_t slave_address
Definition: hbridge15.h:181
hbridge15_return_value_t
hbridge15_return_value_t
H-Bridge 15 Click return value data.
Definition: hbridge15.h:208
hbridge15_reset_port_exp
void hbridge15_reset_port_exp(hbridge15_t *ctx)
H-Bridge 15 reset port expander function.
hbridge15_set_sleep
err_t hbridge15_set_sleep(hbridge15_t *ctx, uint8_t sleep_state)
H-Bridge 15 set sleep function.
hbridge15_set_pins
err_t hbridge15_set_pins(hbridge15_t *ctx, uint8_t set_mask, uint8_t clr_mask)
H-Bridge 15 set pins function.
HBRIDGE15_ERROR
@ HBRIDGE15_ERROR
Definition: hbridge15.h:210
hbridge15_t::int_pin
digital_in_t int_pin
Definition: hbridge15.h:175
hbridge15_cfg_setup
void hbridge15_cfg_setup(hbridge15_cfg_t *cfg)
H-Bridge 15 configuration object setup function.
hbridge15_set_out_state
err_t hbridge15_set_out_state(hbridge15_t *ctx, uint8_t out_state)
H-Bridge 15 set output function.
hbridge15_write_reg
err_t hbridge15_write_reg(hbridge15_t *ctx, uint8_t reg, uint8_t data_in)
H-Bridge 15 write register function.
hbridge15_t::rst
digital_out_t rst
Definition: hbridge15.h:172
hbridge15_t::i2c
i2c_master_t i2c
Definition: hbridge15.h:178
hbridge15_cfg_t::rst
pin_name_t rst
Definition: hbridge15.h:195
hbridge15_set_rst_pin
void hbridge15_set_rst_pin(hbridge15_t *ctx, uint8_t pin_state)
H-Bridge 15 set RST pin function.
hbridge15_cfg_t::int_pin
pin_name_t int_pin
Definition: hbridge15.h:196
hbridge15_set_ena_pin
void hbridge15_set_ena_pin(hbridge15_t *ctx, uint8_t pin_state)
H-Bridge 15 set ENA pin function.