stepper22  2.1.0.0
Modules | Functions
Stepper 22 Click Driver

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

Modules

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

Functions

void stepper22_cfg_setup (stepper22_cfg_t *cfg)
 Stepper 22 configuration object setup function. More...
 
err_t stepper22_init (stepper22_t *ctx, stepper22_cfg_t *cfg)
 Stepper 22 initialization function. More...
 
err_t stepper22_default_cfg (stepper22_t *ctx)
 Stepper 22 default configuration function. More...
 
err_t stepper22_write_reg (stepper22_t *ctx, uint8_t reg, uint16_t data_in)
 Stepper 22 write reg function. More...
 
err_t stepper22_read_reg (stepper22_t *ctx, uint8_t reg, uint16_t *data_out)
 Stepper 22 read reg function. More...
 
err_t stepper22_pca_write_reg (stepper22_t *ctx, uint8_t reg, uint8_t data_in)
 Stepper 22 pca write reg function. More...
 
err_t stepper22_pca_read_reg (stepper22_t *ctx, uint8_t reg, uint8_t *data_out)
 Stepper 22 pca read reg function. More...
 
err_t stepper22_read_bemf_voltage (stepper22_t *ctx, float *data_out)
 Stepper 22 read BEMF pin voltage level function. More...
 
err_t stepper22_get_stall_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get STALL pin function. More...
 
err_t stepper22_get_fault_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get FAULT pin function. More...
 
err_t stepper22_get_bin2_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get BIN2 pin function. More...
 
err_t stepper22_set_bin2_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set BIN2 pin function. More...
 
err_t stepper22_get_bin1_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get BIN1 pin function. More...
 
err_t stepper22_set_bin1_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set BIN1 pin function. More...
 
err_t stepper22_get_dir_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get DIR pin function. More...
 
err_t stepper22_set_dir_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set DIR pin function. More...
 
err_t stepper22_get_reset_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get RESET pin function. More...
 
err_t stepper22_set_reset_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set RESET pin function. More...
 
err_t stepper22_get_sleep_pin (stepper22_t *ctx, uint8_t *state)
 Stepper 22 get SLEEP pin function. More...
 
err_t stepper22_set_sleep_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set SLEEP pin function. More...
 
err_t stepper22_enable_device (stepper22_t *ctx)
 Stepper 22 enable device function. More...
 
err_t stepper22_disable_device (stepper22_t *ctx)
 Stepper 22 disable device function. More...
 
err_t stepper22_set_direction (stepper22_t *ctx, uint8_t dir)
 Stepper 22 set direction function. More...
 
err_t stepper22_switch_direction (stepper22_t *ctx)
 Stepper 22 switch direction function. More...
 
void stepper22_reset_pca (stepper22_t *ctx)
 Stepper 22 reset device function. More...
 
void stepper22_set_rst_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set RST pin function. More...
 
void stepper22_set_step_pin (stepper22_t *ctx, uint8_t state)
 Stepper 22 set STEP pin function. More...
 
uint8_t stepper22_get_int_pin (stepper22_t *ctx)
 Stepper 22 get INT pin function. More...
 
err_t stepper22_get_step_mode (stepper22_t *ctx, uint8_t *mode)
 Stepper 22 get step mode function. More...
 
err_t stepper22_set_step_mode (stepper22_t *ctx, uint8_t mode)
 Stepper 22 set step mode function. More...
 
err_t stepper22_drive_motor (stepper22_t *ctx, uint32_t steps, uint8_t speed)
 Stepper 22 driver motor function. More...
 

Detailed Description

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

◆ stepper22_cfg_setup()

void stepper22_cfg_setup ( stepper22_cfg_t cfg)

Stepper 22 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ stepper22_default_cfg()

err_t stepper22_default_cfg ( stepper22_t ctx)

Stepper 22 default configuration function.

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

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

◆ stepper22_disable_device()

err_t stepper22_disable_device ( stepper22_t ctx)

Stepper 22 disable device function.

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

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

◆ stepper22_drive_motor()

err_t stepper22_drive_motor ( stepper22_t ctx,
uint32_t  steps,
uint8_t  speed 
)

Stepper 22 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 stepper22_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
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper22_enable_device()

err_t stepper22_enable_device ( stepper22_t ctx)

Stepper 22 enable device function.

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

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

◆ stepper22_get_bin1_pin()

err_t stepper22_get_bin1_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get BIN1 pin function.

This function reads the BIN1 pin logic state.

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

◆ stepper22_get_bin2_pin()

err_t stepper22_get_bin2_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get BIN2 pin function.

This function reads the BIN2 pin logic state.

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

◆ stepper22_get_dir_pin()

err_t stepper22_get_dir_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get DIR pin function.

This function reads the DIR pin logic state.

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

◆ stepper22_get_fault_pin()

err_t stepper22_get_fault_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get FAULT pin function.

This function reads the FAULT pin logic state.

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

◆ stepper22_get_int_pin()

uint8_t stepper22_get_int_pin ( stepper22_t ctx)

Stepper 22 get INT pin function.

This function returns the INT pin logic state.

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

◆ stepper22_get_reset_pin()

err_t stepper22_get_reset_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get RESET pin function.

This function reads the RESET pin logic state.

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

◆ stepper22_get_sleep_pin()

err_t stepper22_get_sleep_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get SLEEP pin function.

This function reads the SLEEP pin logic state.

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

◆ stepper22_get_stall_pin()

err_t stepper22_get_stall_pin ( stepper22_t ctx,
uint8_t *  state 
)

Stepper 22 get STALL pin function.

This function reads the STALL pin logic state.

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

◆ stepper22_get_step_mode()

err_t stepper22_get_step_mode ( stepper22_t ctx,
uint8_t *  mode 
)

Stepper 22 get step mode function.

This function reads the step mode resolution settings.

Parameters
[in]ctx: Click context object. See stepper22_t object definition for detailed explanation.
[out]mode: Step mode resolution:
  • 0 - Full step (2-phase excitation) with 71% current,
  • 1 - 1/2 step,
  • 2 - 1/4 step,
  • 3 - 1/8 step,
  • 4 - 1/16 step,
  • 5 - 1/32 step,
  • 6 - 1/64 step,
  • 7 - 1/128 step,
  • 8 - 1/256 step.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper22_init()

err_t stepper22_init ( stepper22_t ctx,
stepper22_cfg_t cfg 
)

Stepper 22 initialization function.

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

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

◆ stepper22_pca_read_reg()

err_t stepper22_pca_read_reg ( stepper22_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

Stepper 22 pca read reg function.

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

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

◆ stepper22_pca_write_reg()

err_t stepper22_pca_write_reg ( stepper22_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

Stepper 22 pca write reg 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 stepper22_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.

◆ stepper22_read_bemf_voltage()

err_t stepper22_read_bemf_voltage ( stepper22_t ctx,
float *  data_out 
)

Stepper 22 read BEMF pin voltage level function.

This function reads results of AD conversion of the BEMF pin and converts them to proportional voltage level.

Parameters
[in]ctx: Click context object. See stepper22_t object definition for detailed explanation.
[out]data_out: Output voltage level of the analog pin [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).

◆ stepper22_read_reg()

err_t stepper22_read_reg ( stepper22_t ctx,
uint8_t  reg,
uint16_t *  data_out 
)

Stepper 22 read reg function.

This function reads data word from the selected register by using SPI serial interface.

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

◆ stepper22_reset_pca()

void stepper22_reset_pca ( stepper22_t ctx)

Stepper 22 reset device function.

This function resets the PCA9538A device by toggling the RST pin.

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

◆ stepper22_set_bin1_pin()

err_t stepper22_set_bin1_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set BIN1 pin function.

This function sets the BIN1 pin logic state.

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

◆ stepper22_set_bin2_pin()

err_t stepper22_set_bin2_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set BIN2 pin function.

This function sets the BIN2 pin logic state.

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

◆ stepper22_set_dir_pin()

err_t stepper22_set_dir_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set DIR pin function.

This function sets the DIR pin logic state.

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

◆ stepper22_set_direction()

err_t stepper22_set_direction ( stepper22_t ctx,
uint8_t  dir 
)

Stepper 22 set direction function.

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

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

◆ stepper22_set_reset_pin()

err_t stepper22_set_reset_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set RESET pin function.

This function sets the RESET pin logic state.

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

◆ stepper22_set_rst_pin()

void stepper22_set_rst_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set RST pin function.

This function sets the RST pin logic state.

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

◆ stepper22_set_sleep_pin()

err_t stepper22_set_sleep_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set SLEEP pin function.

This function sets the SLEEP pin logic state.

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

◆ stepper22_set_step_mode()

err_t stepper22_set_step_mode ( stepper22_t ctx,
uint8_t  mode 
)

Stepper 22 set step mode function.

This function sets the step mode resolution settings.

Parameters
[in]ctx: Click context object. See stepper22_t object definition for detailed explanation.
[in]mode: Step mode resolution:
  • 0 - Full step (2-phase excitation) with 71% current,
  • 1 - 1/2 step,
  • 2 - 1/4 step,
  • 3 - 1/8 step,
  • 4 - 1/16 step,
  • 5 - 1/32 step,
  • 6 - 1/64 step,
  • 7 - 1/128 step,
  • 8 - 1/256 step.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ stepper22_set_step_pin()

void stepper22_set_step_pin ( stepper22_t ctx,
uint8_t  state 
)

Stepper 22 set STEP pin function.

This function sets the STEP pin logic state.

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

◆ stepper22_switch_direction()

err_t stepper22_switch_direction ( stepper22_t ctx)

Stepper 22 switch direction function.

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

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

◆ stepper22_write_reg()

err_t stepper22_write_reg ( stepper22_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

Stepper 22 write reg function.

This function writes a desired data word to the selected register by using SPI serial interface.

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