hbridge6  2.0.0.0
hbridge6.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2021 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 HBRIDGE6_H
29 #define HBRIDGE6_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 
65 #define HBRIDGE6_REG_IN_PORT 0x00
66 #define HBRIDGE6_REG_OUT_PORT 0x01
67 #define HBRIDGE6_REG_POL_INV 0x02
68 #define HBRIDGE6_REG_CONFIG 0x03
69 
74 #define HBRIDGE6_PIN_STATE_LOW 0x00
75 #define HBRIDGE6_PIN_STATE_HIGH 0x01
76 
77 #define HBRIDGE6_IN_PORT_MULTI_SENSE_LOW 0xFB
78 #define HBRIDGE6_IN_PORT_MULTI_SENSE_HIGH 0x04
79 
80 #define HBRIDGE6_IN_PORT_IN_LOW 0xFE
81 #define HBRIDGE6_IN_PORT_IN_HIGH 0x01
82 
83 #define HBRIDGE6_MS_EN_LOW 0xFD
84 #define HBRIDGE6_MS_EN_HIGH 0x02
85 
86 #define HBRIDGE6_DIAGNOSTIC_DISABLE 0x00
87 #define HBRIDGE6_DIAGNOSTIC_ENABLE 0x01
88 
89 #define HBRIDGE6_DEFAULT_CFG 0xE0
90 
91 #define HBRIDGE6_IN_PORT_SEL_BIT_MASK 0x01
92 #define HBRIDGE6_IN_PORT_SEL_0 0x00
93 #define HBRIDGE6_IN_PORT_SEL_1 0x01
94 
95 #define HBRIDGE6_NUMBER_OF_PORTS 0x07
96 
101 #define HBRIDGE6_DIRECTION_BRAKE 0x00
102 #define HBRIDGE6_DIRECTION_CLOCKWISE 0x01
103 #define HBRIDGE6_DIRECTION_COUNTERCLOCKWISE 0x02
104 
110 #define HBRIDGE6_I2C_SLAVE_ADR_0 0x70
111 #define HBRIDGE6_I2C_SLAVE_ADR_1 0x71
112 #define HBRIDGE6_I2C_SLAVE_ADR_2 0x72
113 #define HBRIDGE6_I2C_SLAVE_ADR_3 0x73
114 
119 #define HBRIDGE6_DEF_FREQ 5000
120  // hbridge6_set
122 
137 #define HBRIDGE6_MAP_MIKROBUS( cfg, mikrobus ) \
138  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
140  cfg.ms = MIKROBUS( mikrobus, MIKROBUS_AN ); \
141  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
142  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
143  // hbridge6_map // hbridge6
146 
151 typedef struct
152 {
153  // Output pins
154  digital_out_t rst;
156  // Input pins
157  digital_in_t ms;
159  // Modules
160  i2c_master_t i2c;
161  pwm_t pwm;
163  // I2C slave address
164  uint8_t slave_address;
166  uint32_t pwm_freq;
168 } hbridge6_t;
169 
174 typedef struct
175 {
176  pin_name_t scl;
177  pin_name_t sda;
179  pin_name_t ms;
180  pin_name_t rst;
181  pin_name_t pwm;
183  uint32_t i2c_speed;
184  uint8_t i2c_address;
186  uint32_t dev_pwm_freq;
188  uint8_t in_out;
189  uint8_t invert;
190  uint8_t out_val;
191 
193 
198 typedef enum
199 {
201  HBRIDGE6_ERROR = -1
202 
204 
222 
237 
249 void hbridge6_generic_write ( hbridge6_t *ctx, uint8_t reg, uint8_t tx_buf );
250 
260 uint8_t hbridge6_generic_read ( hbridge6_t *ctx, uint8_t reg );
261 
276 
288 err_t hbridge6_set_duty_cycle ( hbridge6_t *ctx, float duty_cycle );
289 
301 
313 
324 
336 void hbridge6_set_output ( hbridge6_t *ctx, uint8_t n_out_port, hbridge6_cfg_t cfg_data );
337 
349 void hbridge6_get_output ( hbridge6_t *ctx, uint8_t n_out_port, hbridge6_cfg_t *cfg_data );
350 
361 
372 void hbridge6_set_input_port_a ( hbridge6_t *ctx, uint8_t pin_state );
373 
384 void hbridge6_set_input_port_b ( hbridge6_t *ctx, uint8_t pin_state );
385 
396 void hbridge6_enable_diagnostic ( hbridge6_t *ctx, uint8_t en_state );
397 
409 void hbridge6_set_multi_sense ( hbridge6_t *ctx, uint8_t sel_num, uint8_t pin_state );
410 
420 void hbridge6_set_direction ( hbridge6_t *ctx, uint8_t direction );
421 
431 
432 #ifdef __cplusplus
433 }
434 #endif
435 #endif // HBRIDGE6_H
436  // hbridge6
438 
439 // ------------------------------------------------------------------------ END
hbridge6_cfg_setup
void hbridge6_cfg_setup(hbridge6_cfg_t *cfg)
H-Bridge 6 configuration object setup function.
hbridge6_generic_write
void hbridge6_generic_write(hbridge6_t *ctx, uint8_t reg, uint8_t tx_buf)
H-Bridge 6 I2C writing function.
hbridge6_cfg_t::rst
pin_name_t rst
Definition: hbridge6.h:180
hbridge6_set_duty_cycle
err_t hbridge6_set_duty_cycle(hbridge6_t *ctx, float duty_cycle)
H-Bridge 6 sets PWM duty cycle.
hbridge6_t::pwm_freq
uint32_t pwm_freq
Definition: hbridge6.h:166
hbridge6_generic_read
uint8_t hbridge6_generic_read(hbridge6_t *ctx, uint8_t reg)
H-Bridge 6 I2C reading function.
hbridge6_t::slave_address
uint8_t slave_address
Definition: hbridge6.h:164
hbridge6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hbridge6.h:183
hbridge6_reset
void hbridge6_reset(hbridge6_t *ctx)
HW reset function.
HBRIDGE6_ERROR
@ HBRIDGE6_ERROR
Definition: hbridge6.h:201
hbridge6_pwm_start
err_t hbridge6_pwm_start(hbridge6_t *ctx)
H-Bridge 6 start PWM module.
hbridge6_set_input_port_a
void hbridge6_set_input_port_a(hbridge6_t *ctx, uint8_t pin_state)
Set input port A function.
hbridge6_t::rst
digital_out_t rst
Definition: hbridge6.h:154
hbridge6_cfg_t::invert
uint8_t invert
Definition: hbridge6.h:189
hbridge6_t
H-Bridge 6 Click context object.
Definition: hbridge6.h:152
hbridge6_set_multi_sense
void hbridge6_set_multi_sense(hbridge6_t *ctx, uint8_t sel_num, uint8_t pin_state)
Set multi sense function.
hbridge6_set_output
void hbridge6_set_output(hbridge6_t *ctx, uint8_t n_out_port, hbridge6_cfg_t cfg_data)
Set output function.
hbridge6_return_value_t
hbridge6_return_value_t
H-Bridge 6 Click return value data.
Definition: hbridge6.h:199
hbridge6_t::i2c
i2c_master_t i2c
Definition: hbridge6.h:160
hbridge6_set_input_port_b
void hbridge6_set_input_port_b(hbridge6_t *ctx, uint8_t pin_state)
Set input port B function.
hbridge6_t::ms
digital_in_t ms
Definition: hbridge6.h:157
hbridge6_get_output
void hbridge6_get_output(hbridge6_t *ctx, uint8_t n_out_port, hbridge6_cfg_t *cfg_data)
Get output function.
hbridge6_enable_diagnostic
void hbridge6_enable_diagnostic(hbridge6_t *ctx, uint8_t en_state)
Enable the diagnostic function.
hbridge6_t::pwm
pwm_t pwm
Definition: hbridge6.h:161
hbridge6_cfg_t::pwm
pin_name_t pwm
Definition: hbridge6.h:181
hbridge6_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: hbridge6.h:186
hbridge6_get_an_diagnostic
uint8_t hbridge6_get_an_diagnostic(hbridge6_t *ctx)
Get diagnostic function.
HBRIDGE6_OK
@ HBRIDGE6_OK
Definition: hbridge6.h:200
hbridge6_default_config
void hbridge6_default_config(hbridge6_t *ctx)
Default config function.
hbridge6_cfg_t
H-Bridge 6 Click configuration object.
Definition: hbridge6.h:175
hbridge6_default_cfg
err_t hbridge6_default_cfg(hbridge6_t *ctx)
H-Bridge 6 default configuration function.
hbridge6_cfg_t::sda
pin_name_t sda
Definition: hbridge6.h:177
hbridge6_set_direction
void hbridge6_set_direction(hbridge6_t *ctx, uint8_t direction)
Adjust the direction function.
hbridge6_cfg_t::ms
pin_name_t ms
Definition: hbridge6.h:179
hbridge6_cfg_t::i2c_address
uint8_t i2c_address
Definition: hbridge6.h:184
hbridge6_cfg_t::in_out
uint8_t in_out
Definition: hbridge6.h:188
hbridge6_cfg_t::out_val
uint8_t out_val
Definition: hbridge6.h:190
hbridge6_init
err_t hbridge6_init(hbridge6_t *ctx, hbridge6_cfg_t *cfg)
H-Bridge 6 initialization function.
hbridge6_cfg_t::scl
pin_name_t scl
Definition: hbridge6.h:176
hbridge6_pwm_stop
err_t hbridge6_pwm_stop(hbridge6_t *ctx)
H-Bridge 6 stop PWM module.