Public function

Functions
void	dcmotor10_cfg_setup (dcmotor10_cfg_t *cfg)
	Config Object Initialization function.
DCMOTOR10_RETVAL	dcmotor10_init (dcmotor10_t *ctx, dcmotor10_cfg_t *cfg)
	Initialization function.
void	dcmotor10_send_cmd (dcmotor10_t *ctx, uint16_t wr_data)
	Send command function.
uint16_t	dcmotor10_read_status (dcmotor10_t *ctx)
	Read status function.
void	dcmotor10_inhibit (dcmotor10_t *ctx, uint8_t state)
	Inhibit device function.

Detailed Description

Function Documentation

dcmotor10_cfg_setup()

void dcmotor10_cfg_setup

(

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

dcmotor10_inhibit()

void dcmotor10_inhibit	(	dcmotor10_t *	ctx,
		uint8_t	state )

Inhibit device function.

Parameters

ctx	Click object.
state	8-bit command.

@description Function is used to inhibit or uninhibit the device.

dcmotor10_init()

DCMOTOR10_RETVAL dcmotor10_init	(	dcmotor10_t *	ctx,
		dcmotor10_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.

dcmotor10_read_status()

uint16_t dcmotor10_read_status

(

dcmotor10_t *

ctx

)

Read status function.

Parameters

ctx	Click object.

Returns

result 16-bit status value

@description Function is used to read status.

Note

Use datasheet to discerm what value from register represents.

dcmotor10_send_cmd()

void dcmotor10_send_cmd	(	dcmotor10_t *	ctx,
		uint16_t	wr_data )

Send command function.

Parameters

ctx	Click object.
wr_data	16-bit input command

@description Function is used to send command.

Note

Consult datasheet in order to discern what to write into register or use predefined values.