stepper17
2.1.0.0
|
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_write_register (stepper17_t *ctx, uint8_t reg, uint8_t data_in) |
Stepper 17 write register function. More... | |
err_t | stepper17_read_register (stepper17_t *ctx, uint8_t reg, uint8_t *data_out) |
Stepper 17 read register function. More... | |
err_t | stepper17_get_step_mode (stepper17_t *ctx, uint8_t *mode) |
Stepper 17 get step mode function. More... | |
err_t | stepper17_set_step_mode (stepper17_t *ctx, uint8_t mode) |
Stepper 17 set step mode function. More... | |
err_t | stepper17_get_torque (stepper17_t *ctx, uint8_t *torque) |
Stepper 17 get torque function. More... | |
err_t | stepper17_set_torque (stepper17_t *ctx, uint8_t torque) |
Stepper 17 set torque function. More... | |
err_t | stepper17_get_decay (stepper17_t *ctx, uint8_t *decay) |
Stepper 17 get decay function. More... | |
err_t | stepper17_set_decay (stepper17_t *ctx, uint8_t decay) |
Stepper 17 set decay function. More... | |
err_t | stepper17_get_sleep_x_pin (stepper17_t *ctx, uint8_t *state) |
Stepper 17 get sleep x pin function. More... | |
err_t | stepper17_set_sleep_x_pin (stepper17_t *ctx, uint8_t state) |
Stepper 17 set sleep x pin function. More... | |
err_t | stepper17_get_lo1_pin (stepper17_t *ctx, uint8_t *state) |
Stepper 17 get lo1 pin function. More... | |
err_t | stepper17_get_lo2_pin (stepper17_t *ctx, uint8_t *state) |
Stepper 17 get lo2 pin function. More... | |
err_t | stepper17_get_mo_pin (stepper17_t *ctx, uint8_t *state) |
Stepper 17 get mo pin function. More... | |
void | stepper17_drive_motor (stepper17_t *ctx, uint32_t steps, uint8_t speed) |
Stepper 17 driver motor function. More... | |
void | stepper17_enable_device (stepper17_t *ctx) |
Stepper 17 enable device function. More... | |
void | stepper17_disable_device (stepper17_t *ctx) |
Stepper 17 disable device function. More... | |
void | stepper17_set_direction (stepper17_t *ctx, uint8_t dir) |
Stepper 17 set direction function. More... | |
void | stepper17_switch_direction (stepper17_t *ctx) |
Stepper 17 switch direction function. More... | |
void | stepper17_reset_device (stepper17_t *ctx) |
Stepper 17 reset device function. More... | |
uint8_t | stepper17_get_int_pin (stepper17_t *ctx) |
Stepper 17 get int pin function. More... | |
void | stepper17_set_clk_pin (stepper17_t *ctx, uint8_t state) |
Stepper 17 set clk pin function. More... | |
API for configuring and manipulating Stepper 17 Click driver.
void stepper17_cfg_setup | ( | stepper17_cfg_t * | cfg | ) |
Stepper 17 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See stepper17_cfg_t object definition for detailed explanation. |
err_t stepper17_default_cfg | ( | stepper17_t * | ctx | ) |
Stepper 17 default configuration function.
This function executes a default configuration of Stepper 17 click board.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper17_disable_device | ( | stepper17_t * | ctx | ) |
Stepper 17 disable device function.
This function disables the device by setting the EN pin to low logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
void stepper17_drive_motor | ( | stepper17_t * | ctx, |
uint32_t | steps, | ||
uint8_t | speed | ||
) |
Stepper 17 driver motor function.
This function drives the motor for the specific number of steps at the selected speed.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | steps | : Number of steps to rotate motor. |
[in] | speed | : Motor rotation speed:
|
void stepper17_enable_device | ( | stepper17_t * | ctx | ) |
Stepper 17 enable device function.
This function enables the device by setting the EN pin to high logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
err_t stepper17_get_decay | ( | stepper17_t * | ctx, |
uint8_t * | decay | ||
) |
Stepper 17 get decay function.
This function reads the motor decay settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | decay | : Decay settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t stepper17_get_int_pin | ( | stepper17_t * | ctx | ) |
Stepper 17 get int pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
err_t stepper17_get_lo1_pin | ( | stepper17_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 17 get lo1 pin function.
This function reads the lo1 pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_get_lo2_pin | ( | stepper17_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 17 get lo2 pin function.
This function reads the lo2 pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_get_mo_pin | ( | stepper17_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 17 get mo pin function.
This function reads the mo pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_get_sleep_x_pin | ( | stepper17_t * | ctx, |
uint8_t * | state | ||
) |
Stepper 17 get sleep x pin function.
This function reads the sleep x pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_get_step_mode | ( | stepper17_t * | ctx, |
uint8_t * | mode | ||
) |
Stepper 17 get step mode function.
This function reads the step mode resolution settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_get_torque | ( | stepper17_t * | ctx, |
uint8_t * | torque | ||
) |
Stepper 17 get torque function.
This function reads the motor torque settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[out] | torque | : Torque settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_read_register | ( | stepper17_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Stepper 17 read register function.
This function reads data from the selected PCA9555A register by using I2C serial interface.
[in] | ctx | : Click context object. See stepper17_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. void stepper17_reset_device | ( | stepper17_t * | ctx | ) |
Stepper 17 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
void stepper17_set_clk_pin | ( | stepper17_t * | ctx, |
uint8_t | state | ||
) |
Stepper 17 set clk pin function.
This function sets the CLK pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | state | :
|
err_t stepper17_set_decay | ( | stepper17_t * | ctx, |
uint8_t | decay | ||
) |
Stepper 17 set decay function.
This function sets the motor decay settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | decay | : Decay settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper17_set_direction | ( | stepper17_t * | ctx, |
uint8_t | dir | ||
) |
Stepper 17 set direction function.
This function sets the motor direction by setting the DIR pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | dir | :
|
err_t stepper17_set_sleep_x_pin | ( | stepper17_t * | ctx, |
uint8_t | state | ||
) |
Stepper 17 set sleep x pin function.
This function sets the sleep x pin logic state.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | state | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_set_step_mode | ( | stepper17_t * | ctx, |
uint8_t | mode | ||
) |
Stepper 17 set step mode function.
This function sets the step mode resolution settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t stepper17_set_torque | ( | stepper17_t * | ctx, |
uint8_t | torque | ||
) |
Stepper 17 set torque function.
This function sets the motor torque settings.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
[in] | torque | : Torque settings. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stepper17_switch_direction | ( | stepper17_t * | ctx | ) |
Stepper 17 switch direction function.
This function switches the motor direction by toggling the DIR pin.
[in] | ctx | : Click context object. See stepper17_t object definition for detailed explanation. |
err_t stepper17_write_register | ( | stepper17_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Stepper 17 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 stepper17_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.