stspin220
2.1.0.0
|
API for configuring and manipulating STSPIN220 Click driver. More...
Modules | |
STSPIN220 Settings | |
Settings of STSPIN220 Click driver. | |
STSPIN220 MikroBUS Map | |
MikroBUS pin mapping of STSPIN220 Click driver. | |
Functions | |
void | stspin220_cfg_setup (stspin220_cfg_t *cfg) |
STSPIN220 configuration object setup function. More... | |
err_t | stspin220_init (stspin220_t *ctx, stspin220_cfg_t *cfg) |
STSPIN220 initialization function. More... | |
void | stspin220_default_cfg (stspin220_t *ctx) |
STSPIN220 default configuration function. More... | |
void | stspin220_drive_motor (stspin220_t *ctx, uint32_t steps, uint8_t speed) |
STSPIN220 drive motor function. More... | |
void | stspin220_enable_device (stspin220_t *ctx) |
STSPIN220 enable device function. More... | |
void | stspin220_disable_device (stspin220_t *ctx) |
STSPIN220 disable device function. More... | |
void | stspin220_set_direction (stspin220_t *ctx, uint8_t dir) |
STSPIN220 set direction function. More... | |
void | stspin220_switch_direction (stspin220_t *ctx) |
STSPIN220 switch direction function. More... | |
void | stspin220_reset_device (stspin220_t *ctx) |
STSPIN220 reset device function. More... | |
void | stspin220_set_rst_pin (stspin220_t *ctx, uint8_t state) |
STSPIN220 set rst pin function. More... | |
uint8_t | stspin220_get_fault_pin (stspin220_t *ctx) |
STSPIN220 get fault pin function. More... | |
void | stspin220_set_step_pin (stspin220_t *ctx, uint8_t state) |
STSPIN220 set step pin function. More... | |
API for configuring and manipulating STSPIN220 Click driver.
void stspin220_cfg_setup | ( | stspin220_cfg_t * | cfg | ) |
STSPIN220 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See stspin220_cfg_t object definition for detailed explanation. |
void stspin220_default_cfg | ( | stspin220_t * | ctx | ) |
STSPIN220 default configuration function.
This function executes a default configuration of STSPIN220 click board.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
void stspin220_disable_device | ( | stspin220_t * | ctx | ) |
STSPIN220 disable device function.
This function disables the device by setting the EN pin to low logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
void stspin220_drive_motor | ( | stspin220_t * | ctx, |
uint32_t | steps, | ||
uint8_t | speed | ||
) |
STSPIN220 drive motor function.
This function drives the motor for the specific number of steps at the selected speed.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
[in] | steps | : Number of steps to rotate motor. |
[in] | speed | : Motor rotation speed:
|
void stspin220_enable_device | ( | stspin220_t * | ctx | ) |
STSPIN220 enable device function.
This function enables the device by setting the EN pin to high logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
uint8_t stspin220_get_fault_pin | ( | stspin220_t * | ctx | ) |
STSPIN220 get fault pin function.
This function returns the FAULT pin logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
err_t stspin220_init | ( | stspin220_t * | ctx, |
stspin220_cfg_t * | cfg | ||
) |
STSPIN220 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See stspin220_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void stspin220_reset_device | ( | stspin220_t * | ctx | ) |
STSPIN220 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
void stspin220_set_direction | ( | stspin220_t * | ctx, |
uint8_t | dir | ||
) |
STSPIN220 set direction function.
This function sets the motor direction by setting the DIR pin logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
[in] | dir | :
|
void stspin220_set_rst_pin | ( | stspin220_t * | ctx, |
uint8_t | state | ||
) |
STSPIN220 set rst pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
[in] | state | :
|
void stspin220_set_step_pin | ( | stspin220_t * | ctx, |
uint8_t | state | ||
) |
STSPIN220 set step pin function.
This function sets the STEP pin logic state.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |
[in] | state | :
|
void stspin220_switch_direction | ( | stspin220_t * | ctx | ) |
STSPIN220 switch direction function.
This function switches the motor direction by toggling the DIR pin.
[in] | ctx | : Click context object. See stspin220_t object definition for detailed explanation. |