DC Motor 21 Click Driver

API for configuring and manipulating DC Motor 21 Click driver. More...

Topics
	DC Motor 21 OUT Settings
	Settings for OUT of DC Motor 21 Click driver.
	DC Motor 21 MikroBUS Map
	MikroBUS pin mapping of DC Motor 21 Click driver.

Functions
void	dcmotor21_cfg_setup (dcmotor21_cfg_t *cfg)
	DC Motor 21 configuration object setup function.
err_t	dcmotor21_init (dcmotor21_t *ctx, dcmotor21_cfg_t *cfg)
	DC Motor 21 initialization function.
void	dcmotor21_default_cfg (dcmotor21_t *ctx)
	DC Motor 21 default configuration function.
void	dcmotor21_set_out_1 (dcmotor21_t *ctx, uint8_t state)
	DC Motor 21 set out 1 function.
void	dcmotor21_set_out_2 (dcmotor21_t *ctx, uint8_t state)
	DC Motor 21 set out 2 function.

Detailed Description

API for configuring and manipulating DC Motor 21 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

dcmotor21_cfg_setup()

void dcmotor21_cfg_setup

(

dcmotor21_cfg_t *

cfg

)

DC Motor 21 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See dcmotor21_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

dcmotor21_default_cfg()

void dcmotor21_default_cfg

(

dcmotor21_t *

ctx

)

DC Motor 21 default configuration function.

This function executes a default configuration of DC Motor 21 click board.

Parameters

[in]

ctx

: Click context object. See dcmotor21_t object definition for detailed explanation.

Returns

None.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

dcmotor21_init()

err_t dcmotor21_init	(	dcmotor21_t *	ctx,
		dcmotor21_cfg_t *	cfg )

DC Motor 21 initialization function.

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

Parameters

[out]	ctx	: Click context object. See dcmotor21_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See dcmotor21_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

dcmotor21_set_out_1()

void dcmotor21_set_out_1	(	dcmotor21_t *	ctx,
		uint8_t	state )

DC Motor 21 set out 1 function.

This function sets the state of output 1.

Parameters

[in]	ctx	: Click context object. See dcmotor21_t object definition for detailed explanation.
[in]	state	: 0 - LOW state, 1 - HIGH state, 2 - HIGH-Z state.

Returns

Nothing.

Note

None.

dcmotor21_set_out_2()

void dcmotor21_set_out_2	(	dcmotor21_t *	ctx,
		uint8_t	state )

DC Motor 21 set out 2 function.

This function sets the state of output 2.

Parameters

[in]	ctx	: Click context object. See dcmotor21_t object definition for detailed explanation.
[in]	state	: 0 - LOW state, 1 - HIGH state, 2 - HIGH-Z state.

Returns

Nothing.

Note

None.