dcmotor4  2.0.0.0
Functions

Functions

void dcmotor4_cfg_setup (dcmotor4_cfg_t *cfg)
 Config Object Initialization function. More...
 
DCMOTOR4_RETVAL dcmotor4_init (dcmotor4_t *ctx, dcmotor4_cfg_t *cfg)
 Initialization function. More...
 
void dcmotor4_set_duty_cycle (dcmotor4_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void dcmotor4_pwm_stop (dcmotor4_t *ctx)
 Stop PWM module. More...
 
void dcmotor4_pwm_start (dcmotor4_t *ctx)
 Start PWM module. More...
 
void dcmotor4_run_clockwise (dcmotor4_t *ctx)
 Run clockwise. More...
 
void dcmotor4_run_counter_clockwise (dcmotor4_t *ctx)
 Run counter clockwise. More...
 
void dcmotor4_enable_motor (dcmotor4_t *ctx)
 Enable motor. More...
 
void dcmotor4_disable_motor (dcmotor4_t *ctx)
 Disable motor. More...
 
uint8_t dcmotor4_get_diagnostic (dcmotor4_t *ctx)
 Get diagnostic. More...
 

Detailed Description

Function Documentation

◆ dcmotor4_cfg_setup()

void dcmotor4_cfg_setup ( dcmotor4_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.

◆ dcmotor4_disable_motor()

void dcmotor4_disable_motor ( dcmotor4_t ctx)

Disable motor.

Parameters
ctxClick object.

@description This function disables motor.

◆ dcmotor4_enable_motor()

void dcmotor4_enable_motor ( dcmotor4_t ctx)

Enable motor.

Parameters
ctxClick object.

@description This function enables motor.

◆ dcmotor4_get_diagnostic()

uint8_t dcmotor4_get_diagnostic ( dcmotor4_t ctx)

Get diagnostic.

Parameters
ctxClick object.

@description This function gets diagnostic.

◆ dcmotor4_init()

DCMOTOR4_RETVAL dcmotor4_init ( dcmotor4_t ctx,
dcmotor4_cfg_t cfg 
)

Initialization function.

Parameters
dcmotor4Click object.
cfgClick configuration structure.

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

◆ dcmotor4_pwm_start()

void dcmotor4_pwm_start ( dcmotor4_t ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ dcmotor4_pwm_stop()

void dcmotor4_pwm_stop ( dcmotor4_t ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ dcmotor4_run_clockwise()

void dcmotor4_run_clockwise ( dcmotor4_t ctx)

Run clockwise.

Parameters
ctxClick object.

@description This function runs clockwise.

◆ dcmotor4_run_counter_clockwise()

void dcmotor4_run_counter_clockwise ( dcmotor4_t ctx)

Run counter clockwise.

Parameters
ctxClick object.

@description This function run counter clockwise.

◆ dcmotor4_set_duty_cycle()

void dcmotor4_set_duty_cycle ( dcmotor4_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.