stepper23  2.1.0.0
Modules | Functions
Stepper 23 Click Driver

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

Modules

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

Functions

void stepper23_cfg_setup (stepper23_cfg_t *cfg)
 Stepper 23 configuration object setup function. More...
 
err_t stepper23_init (stepper23_t *ctx, stepper23_cfg_t *cfg)
 Stepper 23 initialization function. More...
 
err_t stepper23_default_cfg (stepper23_t *ctx)
 Stepper 23 default configuration function. More...
 
err_t stepper23_write_register (stepper23_t *ctx, uint8_t reg, uint8_t data_in)
 Stepper 23 write register function. More...
 
err_t stepper23_read_register (stepper23_t *ctx, uint8_t reg, uint8_t *data_out)
 Stepper 23 read register function. More...
 
err_t stepper23_get_step_mode (stepper23_t *ctx, uint8_t *mode)
 Stepper 23 get step mode function. More...
 
err_t stepper23_set_step_mode (stepper23_t *ctx, uint8_t mode)
 Stepper 23 set step mode function. More...
 
err_t stepper23_get_torque (stepper23_t *ctx, uint8_t *torque)
 Stepper 23 get torque function. More...
 
err_t stepper23_set_torque (stepper23_t *ctx, uint8_t torque)
 Stepper 23 set torque function. More...
 
err_t stepper23_get_decay (stepper23_t *ctx, uint8_t *decay)
 Stepper 23 get decay function. More...
 
err_t stepper23_set_decay (stepper23_t *ctx, uint8_t decay)
 Stepper 23 set decay function. More...
 
err_t stepper23_get_sleep_x_pin (stepper23_t *ctx, uint8_t *state)
 Stepper 23 get sleep x pin function. More...
 
err_t stepper23_set_sleep_x_pin (stepper23_t *ctx, uint8_t state)
 Stepper 23 set sleep x pin function. More...
 
err_t stepper23_get_lo1_pin (stepper23_t *ctx, uint8_t *state)
 Stepper 23 get lo1 pin function. More...
 
err_t stepper23_get_lo2_pin (stepper23_t *ctx, uint8_t *state)
 Stepper 23 get lo2 pin function. More...
 
err_t stepper23_get_mo_pin (stepper23_t *ctx, uint8_t *state)
 Stepper 23 get mo pin function. More...
 
err_t stepper23_get_rst_pin (stepper23_t *ctx, uint8_t *state)
 Stepper 23 get RST pin function. More...
 
err_t stepper23_set_rst_pin (stepper23_t *ctx, uint8_t state)
 Stepper 23 set RST pin function. More...
 
err_t stepper23_reset_device (stepper23_t *ctx)
 Stepper 23 reset device function. More...
 
void stepper23_drive_motor (stepper23_t *ctx, uint32_t steps, uint8_t speed)
 Stepper 23 driver motor function. More...
 
void stepper23_enable_device (stepper23_t *ctx)
 Stepper 23 enable device function. More...
 
void stepper23_disable_device (stepper23_t *ctx)
 Stepper 23 disable device function. More...
 
void stepper23_set_direction (stepper23_t *ctx, uint8_t dir)
 Stepper 23 set direction function. More...
 
void stepper23_switch_direction (stepper23_t *ctx)
 Stepper 23 switch direction function. More...
 
uint8_t stepper23_get_int_pin (stepper23_t *ctx)
 Stepper 23 get int pin function. More...
 
void stepper23_set_clk_pin (stepper23_t *ctx, uint8_t state)
 Stepper 23 set clk pin function. More...
 

Detailed Description

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

◆ stepper23_cfg_setup()

void stepper23_cfg_setup ( stepper23_cfg_t cfg)

Stepper 23 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ stepper23_default_cfg()

err_t stepper23_default_cfg ( stepper23_t ctx)

Stepper 23 default configuration function.

This function executes a default configuration of Stepper 23 Click board.

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

◆ stepper23_disable_device()

void stepper23_disable_device ( stepper23_t ctx)

Stepper 23 disable device function.

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

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

◆ stepper23_drive_motor()

void stepper23_drive_motor ( stepper23_t ctx,
uint32_t  steps,
uint8_t  speed 
)

Stepper 23 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 stepper23_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.

◆ stepper23_enable_device()

void stepper23_enable_device ( stepper23_t ctx)

Stepper 23 enable device function.

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

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

◆ stepper23_get_decay()

err_t stepper23_get_decay ( stepper23_t ctx,
uint8_t *  decay 
)

Stepper 23 get decay function.

This function reads the motor decay settings.

Parameters
[in]ctx: Click context object. See stepper23_t object definition for detailed explanation.
[out]decay: Decay settings.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper23_get_int_pin()

uint8_t stepper23_get_int_pin ( stepper23_t ctx)

Stepper 23 get int pin function.

This function returns the INT pin logic state.

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

◆ stepper23_get_lo1_pin()

err_t stepper23_get_lo1_pin ( stepper23_t ctx,
uint8_t *  state 
)

Stepper 23 get lo1 pin function.

This function reads the lo1 pin logic state.

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

◆ stepper23_get_lo2_pin()

err_t stepper23_get_lo2_pin ( stepper23_t ctx,
uint8_t *  state 
)

Stepper 23 get lo2 pin function.

This function reads the lo2 pin logic state.

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

◆ stepper23_get_mo_pin()

err_t stepper23_get_mo_pin ( stepper23_t ctx,
uint8_t *  state 
)

Stepper 23 get mo pin function.

This function reads the mo pin logic state.

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

◆ stepper23_get_rst_pin()

err_t stepper23_get_rst_pin ( stepper23_t ctx,
uint8_t *  state 
)

Stepper 23 get RST pin function.

This function reads the RST pin logic state.

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

◆ stepper23_get_sleep_x_pin()

err_t stepper23_get_sleep_x_pin ( stepper23_t ctx,
uint8_t *  state 
)

Stepper 23 get sleep x pin function.

This function reads the sleep x pin logic state.

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

◆ stepper23_get_step_mode()

err_t stepper23_get_step_mode ( stepper23_t ctx,
uint8_t *  mode 
)

Stepper 23 get step mode function.

This function reads the step mode resolution settings.

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

◆ stepper23_get_torque()

err_t stepper23_get_torque ( stepper23_t ctx,
uint8_t *  torque 
)

Stepper 23 get torque function.

This function reads the motor torque settings.

Parameters
[in]ctx: Click context object. See stepper23_t object definition for detailed explanation.
[out]torque: Torque settings.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper23_init()

err_t stepper23_init ( stepper23_t ctx,
stepper23_cfg_t cfg 
)

Stepper 23 initialization function.

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

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

◆ stepper23_read_register()

err_t stepper23_read_register ( stepper23_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

Stepper 23 read register function.

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

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

◆ stepper23_reset_device()

err_t stepper23_reset_device ( stepper23_t ctx)

Stepper 23 reset device function.

This function resets the device by toggling the RST pin.

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

◆ stepper23_set_clk_pin()

void stepper23_set_clk_pin ( stepper23_t ctx,
uint8_t  state 
)

Stepper 23 set clk pin function.

This function sets the CLK pin logic state.

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

◆ stepper23_set_decay()

err_t stepper23_set_decay ( stepper23_t ctx,
uint8_t  decay 
)

Stepper 23 set decay function.

This function sets the motor decay settings.

Parameters
[in]ctx: Click context object. See stepper23_t object definition for detailed explanation.
[in]decay: Decay settings.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper23_set_direction()

void stepper23_set_direction ( stepper23_t ctx,
uint8_t  dir 
)

Stepper 23 set direction function.

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

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

◆ stepper23_set_rst_pin()

err_t stepper23_set_rst_pin ( stepper23_t ctx,
uint8_t  state 
)

Stepper 23 set RST pin function.

This function sets the RST pin logic state.

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

◆ stepper23_set_sleep_x_pin()

err_t stepper23_set_sleep_x_pin ( stepper23_t ctx,
uint8_t  state 
)

Stepper 23 set sleep x pin function.

This function sets the sleep x pin logic state.

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

◆ stepper23_set_step_mode()

err_t stepper23_set_step_mode ( stepper23_t ctx,
uint8_t  mode 
)

Stepper 23 set step mode function.

This function sets the step mode resolution settings.

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

◆ stepper23_set_torque()

err_t stepper23_set_torque ( stepper23_t ctx,
uint8_t  torque 
)

Stepper 23 set torque function.

This function sets the motor torque settings.

Parameters
[in]ctx: Click context object. See stepper23_t object definition for detailed explanation.
[in]torque: Torque settings.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper23_switch_direction()

void stepper23_switch_direction ( stepper23_t ctx)

Stepper 23 switch direction function.

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

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

◆ stepper23_write_register()

err_t stepper23_write_register ( stepper23_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

Stepper 23 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 stepper23_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.