stepper24
2.1.0.0
|
API for configuring and manipulating Stepper 24 Click driver. More...
Modules | |
Stepper 24 Registers List | |
List of registers of Stepper 24 Click driver. | |
Stepper 24 Registers Settings | |
Settings for registers of Stepper 24 Click driver. | |
Stepper 24 MikroBUS Map | |
MikroBUS pin mapping of Stepper 24 Click driver. | |
Functions | |
void | stepper24_cfg_setup (stepper24_cfg_t *cfg) |
Stepper 24 configuration object setup function. More... | |
err_t | stepper24_init (stepper24_t *ctx, stepper24_cfg_t *cfg) |
Stepper 24 initialization function. More... | |
err_t | stepper24_default_cfg (stepper24_t *ctx) |
Stepper 24 default configuration function. More... | |
err_t | stepper24_write_register (stepper24_t *ctx, uint8_t reg, uint8_t data_in) |
Stepper 24 write register function. More... | |
err_t | stepper24_read_register (stepper24_t *ctx, uint8_t reg, uint8_t *data_out) |
Stepper 24 read register function. More... | |
err_t | stepper24_get_step_mode (stepper24_t *ctx, uint8_t *mode) |
Stepper 24 get step mode function. More... | |
err_t | stepper24_set_step_mode (stepper24_t *ctx, uint8_t mode) |
Stepper 24 set step mode function. More... | |
err_t | stepper24_get_torque (stepper24_t *ctx, uint8_t *torque) |
Stepper 24 get torque function. More... | |
err_t | stepper24_set_torque (stepper24_t *ctx, uint8_t torque) |
Stepper 24 set torque function. More... | |
err_t | stepper24_get_decay (stepper24_t *ctx, uint8_t *decay) |
Stepper 24 get decay function. More... | |
err_t | stepper24_set_decay (stepper24_t *ctx, uint8_t decay) |
Stepper 24 set decay function. More... | |
err_t | stepper24_get_sleep_x_pin (stepper24_t *ctx, uint8_t *state) |
Stepper 24 get sleep x pin function. More... | |
err_t | stepper24_set_sleep_x_pin (stepper24_t *ctx, uint8_t state) |
Stepper 24 set sleep x pin function. More... | |
err_t | stepper24_get_lo1_pin (stepper24_t *ctx, uint8_t *state) |
Stepper 24 get lo1 pin function. More... | |
err_t | stepper24_get_lo2_pin (stepper24_t *ctx, uint8_t *state) |
Stepper 24 get lo2 pin function. More... | |
err_t | stepper24_get_mo_pin (stepper24_t *ctx, uint8_t *state) |
Stepper 24 get mo pin function. More... | |
err_t | stepper24_get_rst_pin (stepper24_t *ctx, uint8_t *state) |
Stepper 24 get RST pin function. More... | |
err_t | stepper24_set_rst_pin (stepper24_t *ctx, uint8_t state) |
Stepper 24 set RST pin function. More... | |
err_t | stepper24_reset_device (stepper24_t *ctx) |
Stepper 24 reset device function. More... | |
void | stepper24_drive_motor (stepper24_t *ctx, uint32_t steps, uint8_t speed) |
Stepper 24 driver motor function. More... | |
void | stepper24_enable_device (stepper24_t *ctx) |
Stepper 24 enable device function. More... | |
void | stepper24_disable_device (stepper24_t *ctx) |
Stepper 24 disable device function. More... | |
void | stepper24_set_direction (stepper24_t *ctx, uint8_t dir) |
Stepper 24 set direction function. More... | |
void | stepper24_switch_direction (stepper24_t *ctx) |
Stepper 24 switch direction function. More... | |
uint8_t | stepper24_get_int_pin (stepper24_t *ctx) |
Stepper 24 get int pin function. More... | |
void | stepper24_set_clk_pin (stepper24_t *ctx, uint8_t state) |
Stepper 24 set clk pin function. More... | |
API for configuring and manipulating Stepper 24 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void stepper24_cfg_setup | ( | stepper24_cfg_t * | cfg | ) |
Stepper 24 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See stepper24_cfg_t object definition for detailed explanation. |
err_t stepper24_default_cfg | ( | stepper24_t * | ctx | ) |
Stepper 24 default configuration function.
This function executes a default configuration of Stepper 24 click board.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper24_disable_device | ( | stepper24_t * | ctx | ) |
Stepper 24 disable device function.
This function disables the device by setting the EN pin to low logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
void stepper24_drive_motor | ( | stepper24_t * | ctx, |
uint32_t | steps, | ||
uint8_t | speed | ||
) |
Stepper 24 driver motor function.
This function drives the motor for the specific number of steps at the selected speed.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | steps | : Number of steps to rotate motor. |
[in] | speed | : Motor rotation speed:
|
void stepper24_enable_device | ( | stepper24_t * | ctx | ) |
Stepper 24 enable device function.
This function enables the device by setting the EN pin to high logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
err_t stepper24_get_decay | ( | stepper24_t * | ctx, |
uint8_t * | decay | ||
) |
Stepper 24 get decay function.
This function reads the motor decay settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | decay | : Decay settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t stepper24_get_int_pin | ( | stepper24_t * | ctx | ) |
Stepper 24 get int pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
err_t stepper24_get_lo1_pin | ( | stepper24_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 24 get lo1 pin function.
This function reads the lo1 pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_lo2_pin | ( | stepper24_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 24 get lo2 pin function.
This function reads the lo2 pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_mo_pin | ( | stepper24_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 24 get mo pin function.
This function reads the mo pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_rst_pin | ( | stepper24_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 24 get RST pin function.
This function reads the RST pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_sleep_x_pin | ( | stepper24_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 24 get sleep x pin function.
This function reads the sleep x pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_step_mode | ( | stepper24_t * | ctx, |
uint8_t * | mode | ||
) |
Stepper 24 get step mode function.
This function reads the step mode resolution settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_get_torque | ( | stepper24_t * | ctx, |
uint8_t * | torque | ||
) |
Stepper 24 get torque function.
This function reads the motor torque settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[out] | torque | : Torque settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_init | ( | stepper24_t * | ctx, |
stepper24_cfg_t * | cfg | ||
) |
Stepper 24 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See stepper24_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_read_register | ( | stepper24_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Stepper 24 read register function.
This function reads data from the selected PCA9555A register by using I2C serial interface.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_reset_device | ( | stepper24_t * | ctx | ) |
Stepper 24 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper24_set_clk_pin | ( | stepper24_t * | ctx, |
uint8_t | state | ||
) |
Stepper 24 set clk pin function.
This function sets the CLK pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | state | :
|
err_t stepper24_set_decay | ( | stepper24_t * | ctx, |
uint8_t | decay | ||
) |
Stepper 24 set decay function.
This function sets the motor decay settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | decay | : Decay settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper24_set_direction | ( | stepper24_t * | ctx, |
uint8_t | dir | ||
) |
Stepper 24 set direction function.
This function sets the motor direction by setting the DIR pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | dir | :
|
err_t stepper24_set_rst_pin | ( | stepper24_t * | ctx, |
uint8_t | state | ||
) |
Stepper 24 set RST pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_set_sleep_x_pin | ( | stepper24_t * | ctx, |
uint8_t | state | ||
) |
Stepper 24 set sleep x pin function.
This function sets the sleep x pin logic state.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_set_step_mode | ( | stepper24_t * | ctx, |
uint8_t | mode | ||
) |
Stepper 24 set step mode function.
This function sets the step mode resolution settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper24_set_torque | ( | stepper24_t * | ctx, |
uint8_t | torque | ||
) |
Stepper 24 set torque function.
This function sets the motor torque settings.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | torque | : Torque settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper24_switch_direction | ( | stepper24_t * | ctx | ) |
Stepper 24 switch direction function.
This function switches the motor direction by toggling the DIR pin.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
err_t stepper24_write_register | ( | stepper24_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Stepper 24 write register function.
This function writes a desired data byte to the selected PCA9555A register by using I2C serial interface.
[in] | ctx | : Click context object. See stepper24_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.