dcmotor14 2.0.0.0

Functions

void dcmotor14_cfg_setup (dcmotor14_cfg_t *cfg)
 Config Object Initialization function.
 
DCMOTOR14_RETVAL dcmotor14_init (dcmotor14_t *ctx, dcmotor14_cfg_t *cfg)
 Initialization function.
 
void dcmotor14_set_an_state (dcmotor14_t *ctx, uint8_t state)
 Set an pin state function.
 
void dcmotor14_set_rst_state (dcmotor14_t *ctx, uint8_t state)
 Set rst pin state function.
 
void dcmotor14_stop (dcmotor14_t *ctx)
 Stop function.
 
void dcmotor14_forward (dcmotor14_t *ctx)
 Forward function.
 
void dcmotor14_reverse (dcmotor14_t *ctx)
 Reverse function.
 
void dcmotor14_brake (dcmotor14_t *ctx)
 Brake function.
 

Detailed Description

Function Documentation

◆ dcmotor14_brake()

void dcmotor14_brake ( dcmotor14_t * ctx)

Brake function.

Parameters
ctxClick object.

@description This functio is used to brake the motor.

◆ dcmotor14_cfg_setup()

void dcmotor14_cfg_setup ( dcmotor14_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.

◆ dcmotor14_forward()

void dcmotor14_forward ( dcmotor14_t * ctx)

Forward function.

Parameters
ctxClick object.

@description This functio is used to drive the motor forward.

◆ dcmotor14_init()

DCMOTOR14_RETVAL dcmotor14_init ( dcmotor14_t * ctx,
dcmotor14_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ dcmotor14_reverse()

void dcmotor14_reverse ( dcmotor14_t * ctx)

Reverse function.

Parameters
ctxClick object.

@description This functio is used to drive the motor in reverse.

◆ dcmotor14_set_an_state()

void dcmotor14_set_an_state ( dcmotor14_t * ctx,
uint8_t state )

Set an pin state function.

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

@description This function is used to set or clear an pin.

◆ dcmotor14_set_rst_state()

void dcmotor14_set_rst_state ( dcmotor14_t * ctx,
uint8_t state )

Set rst pin state function.

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

@description This function is used to set or clear rst pin.

◆ dcmotor14_stop()

void dcmotor14_stop ( dcmotor14_t * ctx)

Stop function.

Parameters
ctxClick object.

@description This function is used to stop the motor and put the device into standby mode after 1 ms.