API for configuring and manipulating Stepper 9 Click driver. More...

Topics
	Stepper 9 Registers List
	List of registers of Stepper 9 Click driver.

	Stepper 9 Registers Settings
	Settings for registers of Stepper 9 Click driver.

	Stepper 9 MikroBUS Map
	MikroBUS pin mapping of Stepper 9 Click driver.

Functions
void	stepper9_cfg_setup (stepper9_cfg_t *cfg)
	Stepper 9 configuration object setup function.

err_t	stepper9_init (stepper9_t ctx, stepper9_cfg_t cfg)
	Stepper 9 initialization function.

err_t	stepper9_default_cfg (stepper9_t *ctx)
	Stepper 9 default configuration function.

err_t	stepper9_write_register (stepper9_t *ctx, uint8_t reg, uint8_t data_in)
	Stepper 9 write register function.

err_t	stepper9_read_register (stepper9_t ctx, uint8_t reg, uint8_t data_out)
	Stepper 9 read register function.

err_t	stepper9_get_step_mode (stepper9_t ctx, uint8_t mode)
	Stepper 9 get step mode function.

err_t	stepper9_set_step_mode (stepper9_t *ctx, uint8_t mode)
	Stepper 9 set step mode function.

err_t	stepper9_get_sleep_x_pin (stepper9_t ctx, uint8_t state)
	Stepper 9 get sleep x pin function.

err_t	stepper9_set_sleep_x_pin (stepper9_t *ctx, uint8_t state)
	Stepper 9 set sleep x pin function.

err_t	stepper9_get_lo_pin (stepper9_t ctx, uint8_t state)
	Stepper 9 get lo pin function.

err_t	stepper9_get_mo_pin (stepper9_t ctx, uint8_t state)
	Stepper 9 get mo pin function.

void	stepper9_drive_motor (stepper9_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 9 driver motor function.

void	stepper9_enable_device (stepper9_t *ctx)
	Stepper 9 enable device function.

void	stepper9_disable_device (stepper9_t *ctx)
	Stepper 9 disable device function.

void	stepper9_set_direction (stepper9_t *ctx, uint8_t dir)
	Stepper 9 set direction function.

void	stepper9_switch_direction (stepper9_t *ctx)
	Stepper 9 switch direction function.

void	stepper9_reset_device (stepper9_t *ctx)
	Stepper 9 reset device function.

uint8_t	stepper9_get_int_pin (stepper9_t *ctx)
	Stepper 9 get int pin function.

void	stepper9_set_clk_pin (stepper9_t *ctx, uint8_t state)
	Stepper 9 set clk pin function.

Detailed Description

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

◆ stepper9_cfg_setup()

void stepper9_cfg_setup ( stepper9_cfg_t * cfg )

Stepper 9 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ stepper9_default_cfg()

err_t stepper9_default_cfg ( stepper9_t * ctx )

Stepper 9 default configuration function.

This function executes a default configuration of Stepper 9 click board.

Parameters

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

Returns

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

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

◆ stepper9_disable_device()

void stepper9_disable_device ( stepper9_t * ctx )

Stepper 9 disable device function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper9_drive_motor()

void stepper9_drive_motor	(	stepper9_t *	ctx,
		uint32_t	steps,
		uint8_t	speed )

Stepper 9 driver motor function.

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

Parameters

[in]	ctx	: Click context object. See stepper9_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.

◆ stepper9_enable_device()

void stepper9_enable_device ( stepper9_t * ctx )

Stepper 9 enable device function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper9_get_int_pin()

uint8_t stepper9_get_int_pin ( stepper9_t * ctx )

Stepper 9 get int pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ stepper9_get_lo_pin()

err_t stepper9_get_lo_pin	(	stepper9_t *	ctx,
		uint8_t *	state )

Stepper 9 get lo pin function.

This function reads the lo pin logic state.

Parameters

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

Returns

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

Note: None.

◆ stepper9_get_mo_pin()

err_t stepper9_get_mo_pin	(	stepper9_t *	ctx,
		uint8_t *	state )

Stepper 9 get mo pin function.

This function reads the mo pin logic state.

Parameters

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

Returns

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

Note: None.

◆ stepper9_get_sleep_x_pin()

err_t stepper9_get_sleep_x_pin	(	stepper9_t *	ctx,
		uint8_t *	state )

Stepper 9 get sleep x pin function.

This function reads the sleep x pin logic state.

Parameters

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

Returns

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

Note: None.

◆ stepper9_get_step_mode()

err_t stepper9_get_step_mode	(	stepper9_t *	ctx,
		uint8_t *	mode )

Stepper 9 get step mode function.

This function reads the step mode resolution settings.

Parameters

[in]	ctx	: Click context object. See stepper9_t object definition for detailed explanation.
[out]	mode	: Step mode resolution.

Returns

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

Note: None.

◆ stepper9_init()

err_t stepper9_init	(	stepper9_t *	ctx,
		stepper9_cfg_t *	cfg )

Stepper 9 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ stepper9_read_register()

err_t stepper9_read_register	(	stepper9_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Stepper 9 read register function.

This function reads data from the selected PCA9538A register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See stepper9_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

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

Note: None.

◆ stepper9_reset_device()

void stepper9_reset_device ( stepper9_t * ctx )

Stepper 9 reset device function.

This function resets the device by toggling the RST pin.

Parameters

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

Returns: None.

Note: None.

◆ stepper9_set_clk_pin()

void stepper9_set_clk_pin	(	stepper9_t *	ctx,
		uint8_t	state )

Stepper 9 set clk pin function.

This function sets the CLK pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ stepper9_set_direction()

void stepper9_set_direction	(	stepper9_t *	ctx,
		uint8_t	dir )

Stepper 9 set direction function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper9_set_sleep_x_pin()

err_t stepper9_set_sleep_x_pin	(	stepper9_t *	ctx,
		uint8_t	state )

Stepper 9 set sleep x pin function.

This function sets the sleep x pin logic state.

Parameters

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

Returns

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

Note: None.

◆ stepper9_set_step_mode()

err_t stepper9_set_step_mode	(	stepper9_t *	ctx,
		uint8_t	mode )

Stepper 9 set step mode function.

This function sets the step mode resolution settings.

Parameters

[in]	ctx	: Click context object. See stepper9_t object definition for detailed explanation.
[in]	mode	: Step mode resolution.

Returns

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

Note: None.

◆ stepper9_switch_direction()

void stepper9_switch_direction ( stepper9_t * ctx )

Stepper 9 switch direction function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper9_write_register()

err_t stepper9_write_register	(	stepper9_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Stepper 9 write register function.

This function writes a desired data byte to the selected PCA9538A register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See stepper9_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ stepper9_cfg_setup()

◆ stepper9_default_cfg()

◆ stepper9_disable_device()

◆ stepper9_drive_motor()

◆ stepper9_enable_device()

◆ stepper9_get_int_pin()

◆ stepper9_get_lo_pin()

◆ stepper9_get_mo_pin()

◆ stepper9_get_sleep_x_pin()

◆ stepper9_get_step_mode()

◆ stepper9_init()

◆ stepper9_read_register()

◆ stepper9_reset_device()

◆ stepper9_set_clk_pin()

◆ stepper9_set_direction()

◆ stepper9_set_sleep_x_pin()

◆ stepper9_set_step_mode()

◆ stepper9_switch_direction()

◆ stepper9_write_register()