Public function

Functions
void	brushless_cfg_setup (brushless_cfg_t *cfg)
	Config Object Initialization function.
BRUSHLESS_RETVAL	brushless_init (brushless_t *ctx, brushless_cfg_t *cfg)
	Initialization function.
void	brushless_set_duty_cycle (brushless_t *ctx, float duty_cycle)
	Generic sets PWM duty cycle.
void	brushless_pwm_stop (brushless_t *ctx)
	Stop PWM module.
void	brushless_pwm_start (brushless_t *ctx)
	Start PWM module.
brushless_data_t	brushless_generic_read (brushless_t *ctx)
	Generic read function.
void	brushless_spin_clockwise (brushless_t *ctx)
	Spin motor clockwise function.
void	brushless_spin_counter_clockwise (brushless_t *ctx)
	Spin motor counter clockwise function.
uint8_t	brushless_read_rotation_speed_sensor_output (brushless_t *ctx)
	Read rotation speed sensor output function.

Detailed Description

Function Documentation

brushless_cfg_setup()

void brushless_cfg_setup

(

brushless_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

brushless_generic_read()

brushless_data_t brushless_generic_read

(

brushless_t *

ctx

)

Generic read function.

Parameters

ctx	Click object.

Returns

ADC data

@description This function read ADC data.

brushless_init()

BRUSHLESS_RETVAL brushless_init	(	brushless_t *	ctx,
		brushless_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

brushless_pwm_start()

void brushless_pwm_start

(

brushless_t *

ctx

)

Start PWM module.

Parameters

ctx	Click object.

@description This function starts PWM module.

brushless_pwm_stop()

void brushless_pwm_stop

(

brushless_t *

ctx

)

Stop PWM module.

Parameters

ctx	Click object.

@description This function stops PWM module.

brushless_read_rotation_speed_sensor_output()

uint8_t brushless_read_rotation_speed_sensor_output

(

brushless_t *

ctx

)

Read rotation speed sensor output function.

Parameters

ctx	Click object.

@description This function reads the digital input of the INT pin.

brushless_set_duty_cycle()

void brushless_set_duty_cycle	(	brushless_t *	ctx,
		float	duty_cycle )

Generic sets PWM duty cycle.

Parameters

ctx	Click object.
duty_cycle	Duty cycle.

@description This function sets the PWM duty cycle.

brushless_spin_clockwise()

void brushless_spin_clockwise

(

brushless_t *

ctx

)

Spin motor clockwise function.

Parameters

ctx	Click object.

@description This function sets the spin direction of the motor to clockwise.

brushless_spin_counter_clockwise()

void brushless_spin_counter_clockwise

(

brushless_t *

ctx

)

Spin motor counter clockwise function.

Parameters

ctx	Click object.

@description This function sets the spin direction of the motor to counter clockwise.