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

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

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

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

Functions
void	stepper17_cfg_setup (stepper17_cfg_t *cfg)
	Stepper 17 configuration object setup function.

err_t	stepper17_init (stepper17_t ctx, stepper17_cfg_t cfg)
	Stepper 17 initialization function.

err_t	stepper17_default_cfg (stepper17_t *ctx)
	Stepper 17 default configuration function.

err_t	stepper17_write_register (stepper17_t *ctx, uint8_t reg, uint8_t data_in)
	Stepper 17 write register function.

err_t	stepper17_read_register (stepper17_t ctx, uint8_t reg, uint8_t data_out)
	Stepper 17 read register function.

err_t	stepper17_get_step_mode (stepper17_t ctx, uint8_t mode)
	Stepper 17 get step mode function.

err_t	stepper17_set_step_mode (stepper17_t *ctx, uint8_t mode)
	Stepper 17 set step mode function.

err_t	stepper17_get_torque (stepper17_t ctx, uint8_t torque)
	Stepper 17 get torque function.

err_t	stepper17_set_torque (stepper17_t *ctx, uint8_t torque)
	Stepper 17 set torque function.

err_t	stepper17_get_decay (stepper17_t ctx, uint8_t decay)
	Stepper 17 get decay function.

err_t	stepper17_set_decay (stepper17_t *ctx, uint8_t decay)
	Stepper 17 set decay function.

err_t	stepper17_get_sleep_x_pin (stepper17_t ctx, uint8_t state)
	Stepper 17 get sleep x pin function.

err_t	stepper17_set_sleep_x_pin (stepper17_t *ctx, uint8_t state)
	Stepper 17 set sleep x pin function.

err_t	stepper17_get_lo1_pin (stepper17_t ctx, uint8_t state)
	Stepper 17 get lo1 pin function.

err_t	stepper17_get_lo2_pin (stepper17_t ctx, uint8_t state)
	Stepper 17 get lo2 pin function.

err_t	stepper17_get_mo_pin (stepper17_t ctx, uint8_t state)
	Stepper 17 get mo pin function.

void	stepper17_drive_motor (stepper17_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 17 driver motor function.

void	stepper17_enable_device (stepper17_t *ctx)
	Stepper 17 enable device function.

void	stepper17_disable_device (stepper17_t *ctx)
	Stepper 17 disable device function.

void	stepper17_set_direction (stepper17_t *ctx, uint8_t dir)
	Stepper 17 set direction function.

void	stepper17_switch_direction (stepper17_t *ctx)
	Stepper 17 switch direction function.

void	stepper17_reset_device (stepper17_t *ctx)
	Stepper 17 reset device function.

uint8_t	stepper17_get_int_pin (stepper17_t *ctx)
	Stepper 17 get int pin function.

void	stepper17_set_clk_pin (stepper17_t *ctx, uint8_t state)
	Stepper 17 set clk pin function.

Detailed Description

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

◆ stepper17_cfg_setup()

void stepper17_cfg_setup ( stepper17_cfg_t * cfg )

Stepper 17 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ stepper17_default_cfg()

err_t stepper17_default_cfg ( stepper17_t * ctx )

Stepper 17 default configuration function.

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

Parameters

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

◆ stepper17_disable_device()

void stepper17_disable_device ( stepper17_t * ctx )

Stepper 17 disable device function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper17_drive_motor()

void stepper17_drive_motor	(	stepper17_t *	ctx,
		uint32_t	steps,
		uint8_t	speed )

Stepper 17 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 stepper17_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.

◆ stepper17_enable_device()

void stepper17_enable_device ( stepper17_t * ctx )

Stepper 17 enable device function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper17_get_decay()

err_t stepper17_get_decay	(	stepper17_t *	ctx,
		uint8_t *	decay )

Stepper 17 get decay function.

This function reads the motor decay settings.

Parameters

[in]	ctx	: Click context object. See stepper17_t object definition for detailed explanation.
[out]	decay	: Decay settings.

Returns

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

Note: None.

◆ stepper17_get_int_pin()

uint8_t stepper17_get_int_pin ( stepper17_t * ctx )

Stepper 17 get int pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ stepper17_get_lo1_pin()

err_t stepper17_get_lo1_pin	(	stepper17_t *	ctx,
		uint8_t *	state )

Stepper 17 get lo1 pin function.

This function reads the lo1 pin logic state.

Parameters

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

◆ stepper17_get_lo2_pin()

err_t stepper17_get_lo2_pin	(	stepper17_t *	ctx,
		uint8_t *	state )

Stepper 17 get lo2 pin function.

This function reads the lo2 pin logic state.

Parameters

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

◆ stepper17_get_mo_pin()

err_t stepper17_get_mo_pin	(	stepper17_t *	ctx,
		uint8_t *	state )

Stepper 17 get mo pin function.

This function reads the mo pin logic state.

Parameters

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

◆ stepper17_get_sleep_x_pin()

err_t stepper17_get_sleep_x_pin	(	stepper17_t *	ctx,
		uint8_t *	state )

Stepper 17 get sleep x pin function.

This function reads the sleep x pin logic state.

Parameters

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

◆ stepper17_get_step_mode()

err_t stepper17_get_step_mode	(	stepper17_t *	ctx,
		uint8_t *	mode )

Stepper 17 get step mode function.

This function reads the step mode resolution settings.

Parameters

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

◆ stepper17_get_torque()

err_t stepper17_get_torque	(	stepper17_t *	ctx,
		uint8_t *	torque )

Stepper 17 get torque function.

This function reads the motor torque settings.

Parameters

[in]	ctx	: Click context object. See stepper17_t object definition for detailed explanation.
[out]	torque	: Torque settings.

Returns

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

Note: None.

◆ stepper17_init()

err_t stepper17_init	(	stepper17_t *	ctx,
		stepper17_cfg_t *	cfg )

Stepper 17 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ stepper17_read_register()

err_t stepper17_read_register	(	stepper17_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Stepper 17 read register function.

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

Parameters

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

◆ stepper17_reset_device()

void stepper17_reset_device ( stepper17_t * ctx )

Stepper 17 reset device function.

This function resets the device by toggling the RST pin.

Parameters

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

Returns: None.

Note: None.

◆ stepper17_set_clk_pin()

void stepper17_set_clk_pin	(	stepper17_t *	ctx,
		uint8_t	state )

Stepper 17 set clk pin function.

This function sets the CLK pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ stepper17_set_decay()

err_t stepper17_set_decay	(	stepper17_t *	ctx,
		uint8_t	decay )

Stepper 17 set decay function.

This function sets the motor decay settings.

Parameters

[in]	ctx	: Click context object. See stepper17_t object definition for detailed explanation.
[in]	decay	: Decay settings.

Returns

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

Note: None.

◆ stepper17_set_direction()

void stepper17_set_direction	(	stepper17_t *	ctx,
		uint8_t	dir )

Stepper 17 set direction function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper17_set_sleep_x_pin()

err_t stepper17_set_sleep_x_pin	(	stepper17_t *	ctx,
		uint8_t	state )

Stepper 17 set sleep x pin function.

This function sets the sleep x pin logic state.

Parameters

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

◆ stepper17_set_step_mode()

err_t stepper17_set_step_mode	(	stepper17_t *	ctx,
		uint8_t	mode )

Stepper 17 set step mode function.

This function sets the step mode resolution settings.

Parameters

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

◆ stepper17_set_torque()

err_t stepper17_set_torque	(	stepper17_t *	ctx,
		uint8_t	torque )

Stepper 17 set torque function.

This function sets the motor torque settings.

Parameters

[in]	ctx	: Click context object. See stepper17_t object definition for detailed explanation.
[in]	torque	: Torque settings.

Returns

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

Note: None.

◆ stepper17_switch_direction()

void stepper17_switch_direction ( stepper17_t * ctx )

Stepper 17 switch direction function.

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

Parameters

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

Returns: None.

Note: None.

◆ stepper17_write_register()

err_t stepper17_write_register	(	stepper17_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Stepper 17 write register function.

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

Parameters

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

◆ stepper17_cfg_setup()

◆ stepper17_default_cfg()

◆ stepper17_disable_device()

◆ stepper17_drive_motor()

◆ stepper17_enable_device()

◆ stepper17_get_decay()

◆ stepper17_get_int_pin()

◆ stepper17_get_lo1_pin()

◆ stepper17_get_lo2_pin()

◆ stepper17_get_mo_pin()

◆ stepper17_get_sleep_x_pin()

◆ stepper17_get_step_mode()

◆ stepper17_get_torque()

◆ stepper17_init()

◆ stepper17_read_register()

◆ stepper17_reset_device()

◆ stepper17_set_clk_pin()

◆ stepper17_set_decay()

◆ stepper17_set_direction()

◆ stepper17_set_sleep_x_pin()

◆ stepper17_set_step_mode()

◆ stepper17_set_torque()

◆ stepper17_switch_direction()

◆ stepper17_write_register()