brushless5 2.0.0.0

Functions

void brushless5_cfg_setup (brushless5_cfg_t *cfg)
 Config Object Initialization function.
 
BRUSHLESS5_RETVAL brushless5_init (brushless5_t *ctx, brushless5_cfg_t *cfg)
 Initialization function.
 
void brushless5_set_duty_cycle (brushless5_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle.
 
void brushless5_pwm_stop (brushless5_t *ctx)
 Stop PWM module.
 
void brushless5_pwm_start (brushless5_t *ctx)
 Start PWM module.
 
uint8_t brushless5_get_fg (brushless5_t *ctx)
 Get fg pin state.
 

Detailed Description

Function Documentation

◆ brushless5_cfg_setup()

void brushless5_cfg_setup ( brushless5_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.

◆ brushless5_get_fg()

uint8_t brushless5_get_fg ( brushless5_t * ctx)

Get fg pin state.

Parameters
ctxClick object.

@description This function returns fg pin state.

◆ brushless5_init()

BRUSHLESS5_RETVAL brushless5_init ( brushless5_t * ctx,
brushless5_cfg_t * cfg )

Initialization function.

Parameters
brushless5Click object.
cfgClick configuration structure.

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

◆ brushless5_pwm_start()

void brushless5_pwm_start ( brushless5_t * ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ brushless5_pwm_stop()

void brushless5_pwm_stop ( brushless5_t * ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ brushless5_set_duty_cycle()

void brushless5_set_duty_cycle ( brushless5_t * ctx,
float duty_cycle )

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.