hbridge8 2.0.0.0
hbridge8.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  hbridge8_t
 H-Bridge 8 Click driver selector. More...
 
struct  hbridge8_cfg_t
 H-Bridge 8 Click configuration object. More...
 

Macros

#define HBRIDGE8_MODE_REVERSE   0
 H-Bridge 8 Current polarity setting.
 
#define HBRIDGE8_MODE_FORWARD   1
 
#define HBRIDGE8_DEF_FREQ   225000
 H-Bridge 8 default PWM frequency.
 
#define HBRIDGE8_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  hbridge8_return_value_t { HBRIDGE8_OK = 0 , HBRIDGE8_ERROR = -1 }
 H-Bridge 8 Click return value data. More...
 

Functions

void hbridge8_cfg_setup (hbridge8_cfg_t *cfg)
 H-Bridge 8 configuration object setup function.
 
err_t hbridge8_init (hbridge8_t *ctx, hbridge8_cfg_t *cfg)
 H-Bridge 8 initialization function.
 
err_t hbridge8_default_cfg (hbridge8_t *ctx)
 H-Bridge 8 default configuration function.
 
err_t hbridge8_set_duty_cycle (hbridge8_t *ctx, float duty_cycle)
 H-Bridge 8 sets PWM duty cycle.
 
err_t hbridge8_pwm_stop (hbridge8_t *ctx)
 H-Bridge 8 stop PWM module.
 
err_t hbridge8_pwm_start (hbridge8_t *ctx)
 H-Bridge 8 start PWM module.
 
err_t hbridge8_set_mode (hbridge8_t *ctx, uint8_t mode)
 H-Bridge 8 set operating mode function.
 
err_t hbridge8_enable (hbridge8_t *ctx)
 H-Bridge 8 set IC enable function.
 
err_t hbridge8_disable (hbridge8_t *ctx)
 H-Bridge 8 set IC disable function.
 
uint8_t hbridge8_get_fault_indication (hbridge8_t *ctx)
 H-Bridge 8 get fault indication function.
 

Detailed Description

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

Enumeration Type Documentation

◆ hbridge8_return_value_t

H-Bridge 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
HBRIDGE8_OK 
HBRIDGE8_ERROR