multisteppertb67s209 2.0.0.0
Topics | Functions
Multi Stepper TB67S209 Click Driver

API for configuring and manipulating Multi Stepper TB67S209 Click driver. More...

Topics

 Multi Stepper TB67S209 Registers List
 List of registers of Multi Stepper TB67S209 Click driver.
 
 Multi Stepper TB67S209 Registers Settings
 Settings for registers of Multi Stepper TB67S209 Click driver.
 
 Multi Stepper TB67S209 MikroBUS Map
 MikroBUS pin mapping of Multi Stepper TB67S209 Click driver.
 

Functions

void multisteppertb67s209_cfg_setup (multisteppertb67s209_cfg_t *cfg)
 Multi Stepper TB67S209 configuration object setup function.
 
err_t multisteppertb67s209_init (multisteppertb67s209_t *ctx, multisteppertb67s209_cfg_t *cfg)
 Multi Stepper TB67S209 initialization function.
 
err_t multisteppertb67s209_default_cfg (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 default configuration function.
 
err_t multisteppertb67s209_write_register (multisteppertb67s209_t *ctx, uint8_t reg, uint8_t data_in)
 Multi Stepper TB67S209 write register function.
 
err_t multisteppertb67s209_read_register (multisteppertb67s209_t *ctx, uint8_t reg, uint8_t *data_out)
 Multi Stepper TB67S209 read register function.
 
err_t multisteppertb67s209_get_step_mode (multisteppertb67s209_t *ctx, uint8_t *mode)
 Multi Stepper TB67S209 get step mode function.
 
err_t multisteppertb67s209_set_step_mode (multisteppertb67s209_t *ctx, uint8_t mode)
 Multi Stepper TB67S209 set step mode function.
 
err_t multisteppertb67s209_get_smd_mode (multisteppertb67s209_t *ctx, uint8_t *mode)
 Multi Stepper TB67S209 get smd mode function.
 
err_t multisteppertb67s209_set_smd_mode (multisteppertb67s209_t *ctx, uint8_t mode)
 Multi Stepper TB67S209 set smd mode function.
 
void multisteppertb67s209_drive_motor (multisteppertb67s209_t *ctx, uint32_t steps, uint8_t speed)
 Multi Stepper TB67S209 driver motor function.
 
void multisteppertb67s209_enable_device (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 enable device function.
 
void multisteppertb67s209_disable_device (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 disable device function.
 
void multisteppertb67s209_set_direction (multisteppertb67s209_t *ctx, uint8_t dir)
 Multi Stepper TB67S209 set direction function.
 
void multisteppertb67s209_switch_direction (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 switch direction function.
 
void multisteppertb67s209_reset_device (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 reset device function.
 
uint8_t multisteppertb67s209_get_int_pin (multisteppertb67s209_t *ctx)
 Multi Stepper TB67S209 get int pin function.
 
void multisteppertb67s209_set_clk_pin (multisteppertb67s209_t *ctx, uint8_t state)
 Multi Stepper TB67S209 set clk pin function.
 

Detailed Description

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

◆ multisteppertb67s209_cfg_setup()

void multisteppertb67s209_cfg_setup ( multisteppertb67s209_cfg_t * cfg)

Multi Stepper TB67S209 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See multisteppertb67s209_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ multisteppertb67s209_default_cfg()

err_t multisteppertb67s209_default_cfg ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 default configuration function.

This function executes a default configuration of Multi Stepper TB67S209 click board.

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

◆ multisteppertb67s209_disable_device()

void multisteppertb67s209_disable_device ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 disable device function.

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

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ multisteppertb67s209_drive_motor()

void multisteppertb67s209_drive_motor ( multisteppertb67s209_t * ctx,
uint32_t steps,
uint8_t speed )

Multi Stepper TB67S209 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 multisteppertb67s209_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.

◆ multisteppertb67s209_enable_device()

void multisteppertb67s209_enable_device ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 enable device function.

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

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ multisteppertb67s209_get_int_pin()

uint8_t multisteppertb67s209_get_int_pin ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 get int pin function.

This function returns the INT pin logic state.

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ multisteppertb67s209_get_smd_mode()

err_t multisteppertb67s209_get_smd_mode ( multisteppertb67s209_t * ctx,
uint8_t * mode )

Multi Stepper TB67S209 get smd mode function.

This function reads the SMD mode settings.

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
[out]mode: SMD mode setting.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ multisteppertb67s209_get_step_mode()

err_t multisteppertb67s209_get_step_mode ( multisteppertb67s209_t * ctx,
uint8_t * mode )

Multi Stepper TB67S209 get step mode function.

This function reads the step mode resolution settings.

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

◆ multisteppertb67s209_init()

err_t multisteppertb67s209_init ( multisteppertb67s209_t * ctx,
multisteppertb67s209_cfg_t * cfg )

Multi Stepper TB67S209 initialization function.

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

Parameters
[out]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See multisteppertb67s209_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ multisteppertb67s209_read_register()

err_t multisteppertb67s209_read_register ( multisteppertb67s209_t * ctx,
uint8_t reg,
uint8_t * data_out )

Multi Stepper TB67S209 read register function.

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

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

◆ multisteppertb67s209_reset_device()

void multisteppertb67s209_reset_device ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 reset device function.

This function resets the device by toggling the RST pin.

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ multisteppertb67s209_set_clk_pin()

void multisteppertb67s209_set_clk_pin ( multisteppertb67s209_t * ctx,
uint8_t state )

Multi Stepper TB67S209 set clk pin function.

This function sets the CLK pin logic state.

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
[in]state:
  • 0 - Low logic state,
  • 1 - High logic state.
Returns
None.
Note
None.

◆ multisteppertb67s209_set_direction()

void multisteppertb67s209_set_direction ( multisteppertb67s209_t * ctx,
uint8_t dir )

Multi Stepper TB67S209 set direction function.

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

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
[in]dir:
  • 0 - Clockwise,
  • 1 - Counter-Clockwise.
Returns
None.
Note
None.

◆ multisteppertb67s209_set_smd_mode()

err_t multisteppertb67s209_set_smd_mode ( multisteppertb67s209_t * ctx,
uint8_t mode )

Multi Stepper TB67S209 set smd mode function.

This function sets the SMD mode settings.

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
[in]mode: SMD mode.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ multisteppertb67s209_set_step_mode()

err_t multisteppertb67s209_set_step_mode ( multisteppertb67s209_t * ctx,
uint8_t mode )

Multi Stepper TB67S209 set step mode function.

This function sets the step mode resolution settings.

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

◆ multisteppertb67s209_switch_direction()

void multisteppertb67s209_switch_direction ( multisteppertb67s209_t * ctx)

Multi Stepper TB67S209 switch direction function.

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

Parameters
[in]ctx: Click context object. See multisteppertb67s209_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ multisteppertb67s209_write_register()

err_t multisteppertb67s209_write_register ( multisteppertb67s209_t * ctx,
uint8_t reg,
uint8_t data_in )

Multi Stepper TB67S209 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 multisteppertb67s209_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.