Public function

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

Detailed Description

Function Documentation

dcmotor4_cfg_setup()

void dcmotor4_cfg_setup

(

dcmotor4_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.

dcmotor4_disable_motor()

void dcmotor4_disable_motor

(

dcmotor4_t *

ctx

)

Disable motor.

Parameters

ctx	Click object.

@description This function disables motor.

dcmotor4_enable_motor()

void dcmotor4_enable_motor

(

dcmotor4_t *

ctx

)

Enable motor.

Parameters

ctx	Click object.

@description This function enables motor.

dcmotor4_get_diagnostic()

uint8_t dcmotor4_get_diagnostic

(

dcmotor4_t *

ctx

)

Get diagnostic.

Parameters

ctx	Click object.

@description This function gets diagnostic.

dcmotor4_init()

DCMOTOR4_RETVAL dcmotor4_init	(	dcmotor4_t *	ctx,
		dcmotor4_cfg_t *	cfg )

Initialization function.

Parameters

dcmotor4	Click object.
cfg	Click 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

ctx	Click object.

@description This function starts PWM module.

dcmotor4_pwm_stop()

void dcmotor4_pwm_stop

(

dcmotor4_t *

ctx

)

Stop PWM module.

Parameters

ctx	Click object.

@description This function stops PWM module.

dcmotor4_run_clockwise()

void dcmotor4_run_clockwise

(

dcmotor4_t *

ctx

)

Run clockwise.

Parameters

ctx	Click object.

@description This function runs clockwise.

dcmotor4_run_counter_clockwise()

void dcmotor4_run_counter_clockwise

(

dcmotor4_t *

ctx

)

Run counter clockwise.

Parameters

ctx	Click 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

ctx	Click object.
duty_cycle	Duty cycle.

@description This function sets the PWM duty cycle.