multisteppertb67s269
2.0.0.0
|
API for configuring and manipulating Multi Stepper TB67S269 Click driver. More...
Modules | |
Multi Stepper TB67S269 Registers List | |
List of registers of Multi Stepper TB67S269 Click driver. | |
Multi Stepper TB67S269 Registers Settings | |
Settings for registers of Multi Stepper TB67S269 Click driver. | |
Multi Stepper TB67S269 MikroBUS Map | |
MikroBUS pin mapping of Multi Stepper TB67S269 Click driver. | |
Functions | |
void | multisteppertb67s269_cfg_setup (multisteppertb67s269_cfg_t *cfg) |
Multi Stepper TB67S269 configuration object setup function. More... | |
err_t | multisteppertb67s269_init (multisteppertb67s269_t *ctx, multisteppertb67s269_cfg_t *cfg) |
Multi Stepper TB67S269 initialization function. More... | |
err_t | multisteppertb67s269_default_cfg (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 default configuration function. More... | |
err_t | multisteppertb67s269_write_register (multisteppertb67s269_t *ctx, uint8_t reg, uint8_t data_in) |
Multi Stepper TB67S269 write register function. More... | |
err_t | multisteppertb67s269_read_register (multisteppertb67s269_t *ctx, uint8_t reg, uint8_t *data_out) |
Multi Stepper TB67S269 read register function. More... | |
err_t | multisteppertb67s269_get_step_mode (multisteppertb67s269_t *ctx, uint8_t *mode) |
Multi Stepper TB67S269 get step mode function. More... | |
err_t | multisteppertb67s269_set_step_mode (multisteppertb67s269_t *ctx, uint8_t mode) |
Multi Stepper TB67S269 set step mode function. More... | |
void | multisteppertb67s269_drive_motor (multisteppertb67s269_t *ctx, uint32_t steps, uint8_t speed) |
Multi Stepper TB67S269 driver motor function. More... | |
void | multisteppertb67s269_enable_device (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 enable device function. More... | |
void | multisteppertb67s269_disable_device (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 disable device function. More... | |
void | multisteppertb67s269_set_direction (multisteppertb67s269_t *ctx, uint8_t dir) |
Multi Stepper TB67S269 set direction function. More... | |
void | multisteppertb67s269_switch_direction (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 switch direction function. More... | |
void | multisteppertb67s269_reset_device (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 reset device function. More... | |
uint8_t | multisteppertb67s269_get_int_pin (multisteppertb67s269_t *ctx) |
Multi Stepper TB67S269 get int pin function. More... | |
void | multisteppertb67s269_set_clk_pin (multisteppertb67s269_t *ctx, uint8_t state) |
Multi Stepper TB67S269 set clk pin function. More... | |
API for configuring and manipulating Multi Stepper TB67S269 Click driver.
void multisteppertb67s269_cfg_setup | ( | multisteppertb67s269_cfg_t * | cfg | ) |
Multi Stepper TB67S269 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See multisteppertb67s269_cfg_t object definition for detailed explanation. |
err_t multisteppertb67s269_default_cfg | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 default configuration function.
This function executes a default configuration of Multi Stepper TB67S269 click board.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
0
- Success, -1
- Error.void multisteppertb67s269_disable_device | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 disable device function.
This function disables the device by setting the EN pin to low logic state.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
void multisteppertb67s269_drive_motor | ( | multisteppertb67s269_t * | ctx, |
uint32_t | steps, | ||
uint8_t | speed | ||
) |
Multi Stepper TB67S269 driver motor function.
This function drives the motor for the specific number of steps at the selected speed.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[in] | steps | : Number of steps to rotate motor. |
[in] | speed | : Motor rotation speed:
|
void multisteppertb67s269_enable_device | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 enable device function.
This function enables the device by setting the EN pin to high logic state.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
uint8_t multisteppertb67s269_get_int_pin | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 get int pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
err_t multisteppertb67s269_get_step_mode | ( | multisteppertb67s269_t * | ctx, |
uint8_t * | mode | ||
) |
Multi Stepper TB67S269 get step mode function.
This function reads the step mode resolution settings.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[out] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t multisteppertb67s269_init | ( | multisteppertb67s269_t * | ctx, |
multisteppertb67s269_cfg_t * | cfg | ||
) |
Multi Stepper TB67S269 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See multisteppertb67s269_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t multisteppertb67s269_read_register | ( | multisteppertb67s269_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Multi Stepper TB67S269 read register function.
This function reads data from the selected PCA9538A register by using I2C serial interface.
[in] | ctx | : Click context object. See multisteppertb67s269_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 multisteppertb67s269_reset_device | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
void multisteppertb67s269_set_clk_pin | ( | multisteppertb67s269_t * | ctx, |
uint8_t | state | ||
) |
Multi Stepper TB67S269 set clk pin function.
This function sets the CLK pin logic state.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[in] | state | :
|
void multisteppertb67s269_set_direction | ( | multisteppertb67s269_t * | ctx, |
uint8_t | dir | ||
) |
Multi Stepper TB67S269 set direction function.
This function sets the motor direction by setting the AN pin logic state.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[in] | dir | :
|
err_t multisteppertb67s269_set_step_mode | ( | multisteppertb67s269_t * | ctx, |
uint8_t | mode | ||
) |
Multi Stepper TB67S269 set step mode function.
This function sets the step mode resolution settings.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
[in] | mode | : Step mode resolution. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void multisteppertb67s269_switch_direction | ( | multisteppertb67s269_t * | ctx | ) |
Multi Stepper TB67S269 switch direction function.
This function switches the motor direction by toggling the AN pin.
[in] | ctx | : Click context object. See multisteppertb67s269_t object definition for detailed explanation. |
err_t multisteppertb67s269_write_register | ( | multisteppertb67s269_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Multi Stepper TB67S269 write register function.
This function writes a desired data byte to the selected PCA9538A register by using I2C serial interface.
[in] | ctx | : Click context object. See multisteppertb67s269_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.