hbridge4 2.0.0.0

Functions

void hbridge4_cfg_setup (hbridge4_cfg_t *cfg)
 Config Object Initialization function.
 
HBRIDGE4_RETVAL hbridge4_init (hbridge4_t *ctx, hbridge4_cfg_t *cfg)
 Initialization function.
 
void hbridge4_enable (hbridge4_t *ctx, uint8_t state)
 Enable the device function.
 
void hbridge4_set_in1 (hbridge4_t *ctx, uint8_t state)
 Set IN1 function.
 
void hbridge4_set_in2 (hbridge4_t *ctx, uint8_t state)
 Set IN2 function.
 
void hbridge4_set_in3 (hbridge4_t *ctx, uint8_t state)
 Set IN3 function.
 
void hbridge4_set_in4 (hbridge4_t *ctx, uint8_t state)
 Set IN4 function.
 
void hbridge4_motor_a_standby (hbridge4_t *ctx)
 Motor A standby function.
 
void hbridge4_motor_acw (hbridge4_t *ctx)
 Motor A clockwise motion function.
 
void hbridge4_motor_accw (hbridge4_t *ctx)
 Motor A counter-clockwise motion function.
 
void hbridge4_motor_a_brake (hbridge4_t *ctx)
 Motor A Brake function.
 
void hbridge4_motor_b_standby (hbridge4_t *ctx)
 Motor B standby function.
 
void hbridge4_motor_bcw (hbridge4_t *ctx)
 Motor B clockwise motion function.
 
void hbridge4_motor_bccw (hbridge4_t *ctx)
 Motor B counter-clockwise motion function.
 
void hbridge4_motor_b_brake (hbridge4_t *ctx)
 Motor B Brake function.
 

Detailed Description

Function Documentation

◆ hbridge4_cfg_setup()

void hbridge4_cfg_setup ( hbridge4_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ hbridge4_enable()

void hbridge4_enable ( hbridge4_t * ctx,
uint8_t state )

Enable the device function.

Parameters
ctxClick object.
state0 - Device disabled / 1 - Device enabled

@description Function is used to enable or disable the device.

◆ hbridge4_init()

HBRIDGE4_RETVAL hbridge4_init ( hbridge4_t * ctx,
hbridge4_cfg_t * cfg )

Initialization function.

Parameters
hbridge4Click object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ hbridge4_motor_a_brake()

void hbridge4_motor_a_brake ( hbridge4_t * ctx)

Motor A Brake function.

Parameters
ctxClick object.

@description Function is used to brake motor A to a halt.

◆ hbridge4_motor_a_standby()

void hbridge4_motor_a_standby ( hbridge4_t * ctx)

Motor A standby function.

@description Function is used to put motor A into standby.

◆ hbridge4_motor_accw()

void hbridge4_motor_accw ( hbridge4_t * ctx)

Motor A counter-clockwise motion function.

Parameters
ctxClick object.

@description Function is used to put motor A into counter-clockwise motion.

◆ hbridge4_motor_acw()

void hbridge4_motor_acw ( hbridge4_t * ctx)

Motor A clockwise motion function.

Parameters
ctxClick object.

@description Function is used to put motor A into clockwise motion.

◆ hbridge4_motor_b_brake()

void hbridge4_motor_b_brake ( hbridge4_t * ctx)

Motor B Brake function.

Parameters
ctxClick object.

@description Function is used to brake motor B to a halt.

◆ hbridge4_motor_b_standby()

void hbridge4_motor_b_standby ( hbridge4_t * ctx)

Motor B standby function.

Parameters
ctxClick object.

@description Function is used to put motor B into standby.

◆ hbridge4_motor_bccw()

void hbridge4_motor_bccw ( hbridge4_t * ctx)

Motor B counter-clockwise motion function.

Parameters
ctxClick object.

@description Function is used to put motor B into counter-clockwise motion.

◆ hbridge4_motor_bcw()

void hbridge4_motor_bcw ( hbridge4_t * ctx)

Motor B clockwise motion function.

Parameters
ctxClick object.

@description Function is used to put motor B into clockwise motion.

◆ hbridge4_set_in1()

void hbridge4_set_in1 ( hbridge4_t * ctx,
uint8_t state )

Set IN1 function.

Parameters
ctxClick object.
state0 - IN1 pin cleared / 1 - IN1 pin set

@description Function is used to set or clear IN1 pin.

◆ hbridge4_set_in2()

void hbridge4_set_in2 ( hbridge4_t * ctx,
uint8_t state )

Set IN2 function.

Parameters
ctxClick object.
state0 - IN2 pin cleared / 1 - IN2 pin set

@description Function is used to set or clear IN2 pin.

◆ hbridge4_set_in3()

void hbridge4_set_in3 ( hbridge4_t * ctx,
uint8_t state )

Set IN3 function.

Parameters
ctxClick object.
state0 - IN3 pin cleared / 1 - IN3 pin set

@description Function is used to set or clear IN3 pin.

◆ hbridge4_set_in4()

void hbridge4_set_in4 ( hbridge4_t * ctx,
uint8_t state )

Set IN4 function.

Parameters
ctxClick object.
state0 - IN4 pin cleared / 1 - IN4 pin set

@description Function is used to set or clear IN4 pin.