stepper17  2.0.0.0
Modules | Functions
Stepper 17 Click Driver

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

Modules

 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. More...
 
err_t stepper17_init (stepper17_t *ctx, stepper17_cfg_t *cfg)
 Stepper 17 initialization function. More...
 
err_t stepper17_default_cfg (stepper17_t *ctx)
 Stepper 17 default configuration function. More...
 
err_t stepper17_generic_write (stepper17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 Stepper 17 I2C writing function. More...
 
err_t stepper17_generic_read (stepper17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 Stepper 17 I2C reading function. More...
 
err_t stepper17_set_duty_cycle (stepper17_t *ctx, float duty_cycle)
 Stepper 17 sets PWM duty cycle. More...
 
err_t stepper17_pwm_stop (stepper17_t *ctx)
 Stepper 17 stop PWM module. More...
 
err_t stepper17_pwm_start (stepper17_t *ctx)
 Stepper 17 start PWM module. More...
 
void stepper17_set_dir_state (stepper17_t *ctx, uint8_t state)
 Direction control. More...
 
void stepper17_set_rst_state (stepper17_t *ctx, uint8_t state)
 Set reset pin state. More...
 
void stepper17_set_en_state (stepper17_t *ctx, uint8_t state)
 Enable stepping motor output. More...
 
uint8_t stepper17_get_int_state (stepper17_t *ctx)
 Gets interrupt state. More...
 
err_t stepper17_step_resolution (stepper17_t *ctx, uint8_t resolution)
 Step resolution setting. More...
 
err_t stepper17_torque_setting (stepper17_t *ctx, uint8_t torque)
 Torque setting. More...
 
err_t stepper17_decay_function (stepper17_t *ctx, uint8_t decay)
 Decay period setting. More...
 
err_t stepper17_mode (stepper17_t *ctx, uint8_t mode)
 Mode setting. More...
 
uint8_t stepper17_get_error (stepper17_t *ctx)
 Reads error output. More...
 
uint8_t stepper17_get_electrical_angle (stepper17_t *ctx)
 Reads MO pin state. More...
 
void stepper17_reset_electrical_angle (stepper17_t *ctx)
 Reset electrical angle to initial state. More...
 

Detailed Description

API for configuring and manipulating Stepper 17 Click driver.

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_decay_function()

err_t stepper17_decay_function ( stepper17_t ctx,
uint8_t  decay 
)

Decay period setting.

This function sets decay period.

Parameters
[out]ctx: Click context object.
[in]decay: Torque data. See stepper17_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ 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_generic_read()

err_t stepper17_generic_read ( stepper17_t ctx,
uint8_t  reg,
uint8_t *  rx_buf,
uint8_t  rx_len 
)

Stepper 17 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See stepper17_t object definition for detailed explanation.
[in]reg: Start register address.
[out]rx_buf: Output read data.
[in]rx_len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ stepper17_generic_write()

err_t stepper17_generic_write ( stepper17_t ctx,
uint8_t  reg,
uint8_t *  tx_buf,
uint8_t  tx_len 
)

Stepper 17 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See stepper17_t object definition for detailed explanation.
[in]reg: Start register address.
[in]tx_buf: Data to be written.
[in]tx_len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ stepper17_get_electrical_angle()

uint8_t stepper17_get_electrical_angle ( stepper17_t ctx)

Reads MO pin state.

This function reads internal electrical angles that MO pin indicates.

Parameters
[out]ctx: Click context object. See stepper17_t object definition for detailed explanation.
Returns
  • 4 - Except inital value,
  • 0 - Initial value.

◆ stepper17_get_error()

uint8_t stepper17_get_error ( stepper17_t ctx)

Reads error output.

This function gets error output.

Parameters
[out]ctx: Click context object. See stepper17_t object definition for detailed explanation.
Returns
  • 3 - No Error,
  • 2 - Over-current Error,
  • 1 - Over-temperature Error,
  • 0 - Over-current and over-temperature Error.

◆ stepper17_get_int_state()

uint8_t stepper17_get_int_state ( stepper17_t ctx)

Gets interrupt state.

This function gets interrupt pin state. Interrupt state goes low whenever input pins change from port 1( MO, LO1, LO2 ).

Parameters
[out]ctx: Click context object. See stepper17_t object definition for detailed explanation.
Returns
  • 0 - Interrupt,
  • 1 - Idle.

◆ 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_mode()

err_t stepper17_mode ( stepper17_t ctx,
uint8_t  mode 
)

Mode setting.

This function sets mode.

Parameters
[out]ctx: Click context object.
[in]mode: Mode data. See stepper17_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ stepper17_pwm_start()

err_t stepper17_pwm_start ( stepper17_t ctx)

Stepper 17 start PWM module.

This function starts the PWM moudle output.

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

◆ stepper17_pwm_stop()

err_t stepper17_pwm_stop ( stepper17_t ctx)

Stepper 17 stop PWM module.

This function stops the PWM moudle output.

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

◆ stepper17_reset_electrical_angle()

void stepper17_reset_electrical_angle ( stepper17_t ctx)

Reset electrical angle to initial state.

This function toggles rst pin state to reset electrical angle to initial state.

Parameters
[out]ctx: Click context object.
[in]state: Logic pin state. See stepper17_t object definition for detailed explanation.
Returns
Nothing.

◆ stepper17_set_dir_state()

void stepper17_set_dir_state ( stepper17_t ctx,
uint8_t  state 
)

Direction control.

This function sets pin that controls direction of motor rotating.

Parameters
[out]ctx: Click context object.
[in]state: Logic pin state. See stepper17_t object definition for detailed explanation.
Returns
Nothing.

◆ stepper17_set_duty_cycle()

err_t stepper17_set_duty_cycle ( stepper17_t ctx,
float  duty_cycle 
)

Stepper 17 sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

Parameters
[out]ctx: Click context object. See stepper17_t object definition for detailed explanation.
[in]duty_ratio: PWM duty_ratio.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ stepper17_set_en_state()

void stepper17_set_en_state ( stepper17_t ctx,
uint8_t  state 
)

Enable stepping motor output.

This function sets pin that contols stepping motor output.

Parameters
[out]ctx: Click context object.
[in]state: Logic pin state. See stepper17_t object definition for detailed explanation.
Returns
Nothing.

◆ stepper17_set_rst_state()

void stepper17_set_rst_state ( stepper17_t ctx,
uint8_t  state 
)

Set reset pin state.

This function sets pin that resets electrical angle to inital state.

Parameters
[out]ctx: Click context object.
[in]state: Logic pin state. See stepper17_t object definition for detailed explanation.
Returns
Nothing.

◆ stepper17_step_resolution()

err_t stepper17_step_resolution ( stepper17_t ctx,
uint8_t  resolution 
)

Step resolution setting.

This function sets step resolution.

Parameters
[out]ctx: Click context object.
[in]resolution: Step resolution data. See stepper17_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ stepper17_torque_setting()

err_t stepper17_torque_setting ( stepper17_t ctx,
uint8_t  torque 
)

Torque setting.

This function sets torque.

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