API for configuring and manipulating STSPIN820 Click driver. More...

Topics
	STSPIN820 Settings
	Settings of STSPIN820 Click driver.

	STSPIN820 MikroBUS Map
	MikroBUS pin mapping of STSPIN820 Click driver.

Functions
void	stspin820_cfg_setup (stspin820_cfg_t *cfg)
	STSPIN820 configuration object setup function.

err_t	stspin820_init (stspin820_t ctx, stspin820_cfg_t cfg)
	STSPIN820 initialization function.

void	stspin820_default_cfg (stspin820_t *ctx)
	STSPIN820 default configuration function.

void	stspin820_drive_motor (stspin820_t *ctx, uint32_t steps, uint8_t speed)
	STSPIN820 drive motor function.

void	stspin820_enable_device (stspin820_t *ctx)
	STSPIN820 enable device function.

void	stspin820_disable_device (stspin820_t *ctx)
	STSPIN820 disable device function.

void	stspin820_set_direction (stspin820_t *ctx, uint8_t dir)
	STSPIN820 set direction function.

void	stspin820_switch_direction (stspin820_t *ctx)
	STSPIN820 switch direction function.

void	stspin820_reset_device (stspin820_t *ctx)
	STSPIN820 reset device function.

void	stspin820_set_rst_pin (stspin820_t *ctx, uint8_t state)
	STSPIN820 set rst pin function.

uint8_t	stspin820_get_fault_pin (stspin820_t *ctx)
	STSPIN820 get fault pin function.

void	stspin820_set_step_pin (stspin820_t *ctx, uint8_t state)
	STSPIN820 set step pin function.

Detailed Description

API for configuring and manipulating STSPIN820 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

◆ stspin820_cfg_setup()

void stspin820_cfg_setup ( stspin820_cfg_t * cfg )

STSPIN820 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See stspin820_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ stspin820_default_cfg()

void stspin820_default_cfg ( stspin820_t * ctx )

STSPIN820 default configuration function.

This function executes a default configuration of STSPIN820 click board.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: None.

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

◆ stspin820_disable_device()

void stspin820_disable_device ( stspin820_t * ctx )

STSPIN820 disable device function.

This function disables the device by setting the EN pin to low logic state.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ stspin820_drive_motor()

void stspin820_drive_motor	(	stspin820_t *	ctx,
		uint32_t	steps,
		uint8_t	speed )

STSPIN820 drive motor function.

This function drives the motor for the specific number of steps at the selected speed.

Parameters

[in]	ctx	: Click context object. See stspin820_t object definition for detailed explanation.
[in]	steps	: Number of steps to rotate motor.
[in]	speed	: Motor rotation speed: `0` - Very slow, `1` - Slow, `2` - Medium, `3` - Fast, `4` - Very fast,

Returns: None.

Note: None.

◆ stspin820_enable_device()

void stspin820_enable_device ( stspin820_t * ctx )

STSPIN820 enable device function.

This function enables the device by setting the EN pin to high logic state.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ stspin820_get_fault_pin()

uint8_t stspin820_get_fault_pin ( stspin820_t * ctx )

STSPIN820 get fault pin function.

This function returns the FAULT pin logic state.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ stspin820_init()

err_t stspin820_init	(	stspin820_t *	ctx,
		stspin820_cfg_t *	cfg )

STSPIN820 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ stspin820_reset_device()

void stspin820_reset_device ( stspin820_t * ctx )

STSPIN820 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ stspin820_set_direction()

void stspin820_set_direction	(	stspin820_t *	ctx,
		uint8_t	dir )

STSPIN820 set direction function.

This function sets the motor direction by setting the DIR pin logic state.

Parameters

[in]	ctx	: Click context object. See stspin820_t object definition for detailed explanation.
[in]	dir	: `0` - Clockwise, `1` - Counter-Clockwise.

Returns: None.

Note: None.

◆ stspin820_set_rst_pin()

void stspin820_set_rst_pin	(	stspin820_t *	ctx,
		uint8_t	state )

STSPIN820 set rst pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See stspin820_t object definition for detailed explanation.
[in]	state	: `0` - Low logic state, `1` - High logic state.

Returns: None.

Note: None.

◆ stspin820_set_step_pin()

void stspin820_set_step_pin	(	stspin820_t *	ctx,
		uint8_t	state )

STSPIN820 set step pin function.

This function sets the STEP pin logic state.

Parameters

[in]	ctx	: Click context object. See stspin820_t object definition for detailed explanation.
[in]	state	: `0` - Low logic state, `1` - High logic state.

Returns: None.

Note: None.

◆ stspin820_switch_direction()

void stspin820_switch_direction ( stspin820_t * ctx )

STSPIN820 switch direction function.

This function switches the motor direction by toggling the DIR pin.

Parameters

[in] ctx : Click context object. See stspin820_t object definition for detailed explanation.

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ stspin820_cfg_setup()

◆ stspin820_default_cfg()

◆ stspin820_disable_device()

◆ stspin820_drive_motor()

◆ stspin820_enable_device()

◆ stspin820_get_fault_pin()

◆ stspin820_init()

◆ stspin820_reset_device()

◆ stspin820_set_direction()

◆ stspin820_set_rst_pin()

◆ stspin820_set_step_pin()

◆ stspin820_switch_direction()