hbridge16  2.1.0.0
Data Structures | Macros | Enumerations | Functions
hbridge16.h File Reference

This file contains API for H-Bridge 16 Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  hbridge16_t
 H-Bridge 16 Click context object. More...
 
struct  hbridge16_cfg_t
 H-Bridge 16 Click configuration object. More...
 

Macros

#define HBRIDGE16_REG_INPUT_PORT   0x00
 H-Bridge 16 description register. More...
 
#define HBRIDGE16_REG_OUTPUT_PORT   0x01
 
#define HBRIDGE16_REG_POLARITY_INV   0x02
 
#define HBRIDGE16_REG_CONFIG   0x03
 
#define HBRIDGE16_NONE_PIN   0x00
 H-Bridge 16 pin mask. More...
 
#define HBRIDGE16_IN1_PIN   0x01
 
#define HBRIDGE16_IN2_PIN   0x02
 
#define HBRIDGE16_IN3_PIN   0x04
 
#define HBRIDGE16_IN4_PIN   0x08
 
#define HBRIDGE16_DECAY_PIN   0x10
 
#define HBRIDGE16_MD_PIN   0x20
 
#define HBRIDGE16_OCPM_PIN   0x40
 
#define HBRIDGE16_FLT_PIN   0x80
 
#define HBRIDGE16_ALL_OUTPUT_PIN   0x7F
 
#define HBRIDGE16_ALL_PIN   0xFF
 
#define HBRIDGE16_DRIVE_MOTOR_REVERSE   0x00
 H-Bridge 16 motor states setting. More...
 
#define HBRIDGE16_DRIVE_MOTOR_FORWARD   0x01
 
#define HBRIDGE16_DRIVE_MOTOR_FREEWHEEL   0x02
 
#define HBRIDGE16_DRIVE_MOTOR_BRAKE   0x03
 
#define HBRIDGE16_PWM_MODE   0x01
 H-Bridge 16 mode setting. More...
 
#define HBRIDGE16_PH_EN_MODE   0x00
 
#define HBRIDGE16_SLEEP_MODE_OFF   0x01
 H-Bridge 16 sleep mode setting. More...
 
#define HBRIDGE16_SLEEP_MODE_ON   0x00
 
#define HBRIDGE16_DEVICE_ADDRESS_A1A0_00   0x70
 H-Bridge 16 device address setting. More...
 
#define HBRIDGE16_DEVICE_ADDRESS_A1A0_01   0x71
 
#define HBRIDGE16_DEVICE_ADDRESS_A1A0_10   0x72
 
#define HBRIDGE16_DEVICE_ADDRESS_A1A0_11   0x73
 
#define HBRIDGE16_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  hbridge16_return_value_t { HBRIDGE16_OK = 0, HBRIDGE16_ERROR = -1 }
 H-Bridge 16 Click return value data. More...
 

Functions

void hbridge16_cfg_setup (hbridge16_cfg_t *cfg)
 H-Bridge 16 configuration object setup function. More...
 
err_t hbridge16_init (hbridge16_t *ctx, hbridge16_cfg_t *cfg)
 H-Bridge 16 initialization function. More...
 
err_t hbridge16_default_cfg (hbridge16_t *ctx)
 H-Bridge 16 default configuration function. More...
 
err_t hbridge16_generic_write (hbridge16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 H-Bridge 16 I2C writing function. More...
 
err_t hbridge16_generic_read (hbridge16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 H-Bridge 16 I2C reading function. More...
 
void hbridge16_reset_port_exp (hbridge16_t *ctx)
 H-Bridge 16 reset port expander function. More...
 
uint8_t hbridge16_get_int_pin (hbridge16_t *ctx)
 H-Bridge 16 get Interrupt pin function. More...
 
void hbridge16_set_slp_pin (hbridge16_t *ctx, uint8_t pin_state)
 H-Bridge 15 set Sleep pin function. More...
 
err_t hbridge16_write_reg (hbridge16_t *ctx, uint8_t reg, uint8_t data_in)
 H-Bridge 16 write register function. More...
 
err_t hbridge16_read_reg (hbridge16_t *ctx, uint8_t reg, uint8_t *data_out)
 H-Bridge 16 read register function. More...
 
err_t hbridge16_set_pins (hbridge16_t *ctx, uint8_t set_mask, uint8_t clr_mask)
 H-Bridge 16 set pins function. More...
 
err_t hbridge16_set_mode (hbridge16_t *ctx, uint8_t mode_sel)
 H-Bridge 16 set mode function. More...
 
err_t hbridge16_set_out_state (hbridge16_t *ctx, uint8_t out_state)
 H-Bridge 16 set output function. More...
 

Detailed Description

This file contains API for H-Bridge 16 Click Driver.

Enumeration Type Documentation

◆ hbridge16_return_value_t

H-Bridge 16 Click return value data.

Predefined enum values for driver return values.

Enumerator
HBRIDGE16_OK 
HBRIDGE16_ERROR