dcmotor17
2.0.0.0
|
API for configuring and manipulating DC Motor 17 Click driver. More...
Modules | |
DC Motor 17 Settings | |
Settings of DC Motor 17 Click driver. | |
DC Motor 17 MikroBUS Map | |
MikroBUS pin mapping of DC Motor 17 Click driver. | |
Retval_flag | |
Sel_out | |
Mode | |
Functions | |
void | dcmotor17_cfg_setup (dcmotor17_cfg_t *cfg) |
DC Motor 17 configuration object setup function. More... | |
err_t | dcmotor17_init (dcmotor17_t *ctx, dcmotor17_cfg_t *cfg) |
DC Motor 17 initialization function. More... | |
void | dcmotor17_default_cfg (dcmotor17_t *ctx) |
DC Motor 17 default configuration function. More... | |
void | dcmotor17_standby_mode (dcmotor17_t *ctx) |
DC Motor 17 set to standby operating mode function. More... | |
void | dcmotor17_normal_mode (dcmotor17_t *ctx) |
DC Motor 17 set to normal operating mode function. More... | |
dcmotor17_retval_t | dcmotor17_set_mode (dcmotor17_t *ctx, uint8_t op_mode) |
DC Motor 17 set operating mode function. More... | |
dcmotor17_retval_t | dcmotor14_stop (dcmotor17_t *ctx, uint8_t sel_out) |
DC Motor 17 stop motor function. More... | |
dcmotor17_retval_t | dcmotor14_forward (dcmotor17_t *ctx, uint8_t sel_out) |
DC Motor 17 forward function. More... | |
dcmotor17_retval_t | dcmotor14_reverse (dcmotor17_t *ctx, uint8_t sel_out) |
DC Motor 17 reverse function. More... | |
API for configuring and manipulating DC Motor 17 Click driver.
dcmotor17_retval_t dcmotor14_forward | ( | dcmotor17_t * | ctx, |
uint8_t | sel_out | ||
) |
DC Motor 17 forward function.
This function is used to drive the motor forward of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
[in] | sel_out | : Select channel motor output.
|
0x00
( DCMOTOR17_OK ) - Ok, 0xFF
( DCMOTOR17_ERROR ) - Error. dcmotor17_retval_t dcmotor14_reverse | ( | dcmotor17_t * | ctx, |
uint8_t | sel_out | ||
) |
DC Motor 17 reverse function.
This function is used to drive the motor reverse of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
0x00
( DCMOTOR17_OK ) - Ok, 0xFF
( DCMOTOR17_ERROR ) - Error. dcmotor17_retval_t dcmotor14_stop | ( | dcmotor17_t * | ctx, |
uint8_t | sel_out | ||
) |
DC Motor 17 stop motor function.
This function is used to stop the motor of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
[in] | sel_out | : Select channel motor output.
|
0x00
( DCMOTOR17_OK ) - Ok, 0xFF
( DCMOTOR17_ERROR ) - Error. void dcmotor17_cfg_setup | ( | dcmotor17_cfg_t * | cfg | ) |
DC Motor 17 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See dcmotor17_cfg_t object definition for detailed explanation. |
void dcmotor17_default_cfg | ( | dcmotor17_t * | ctx | ) |
DC Motor 17 default configuration function.
This function executes a default configuration of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
See #err_t definition for detailed explanation.
err_t dcmotor17_init | ( | dcmotor17_t * | ctx, |
dcmotor17_cfg_t * | cfg | ||
) |
DC Motor 17 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See dcmotor17_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void dcmotor17_normal_mode | ( | dcmotor17_t * | ctx | ) |
DC Motor 17 set to normal operating mode function.
This function sets the normal operating mode of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
dcmotor17_retval_t dcmotor17_set_mode | ( | dcmotor17_t * | ctx, |
uint8_t | op_mode | ||
) |
DC Motor 17 set operating mode function.
This function sets the desired operating mode of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |
[in] | op_mode | : Operating mode.
|
0x00
( DCMOTOR17_OK ) - Ok, 0xFF
( DCMOTOR17_ERROR ) - Error. void dcmotor17_standby_mode | ( | dcmotor17_t * | ctx | ) |
DC Motor 17 set to standby operating mode function.
This function sets the standby operating mode of DC Motor 17 click board.
[in] | ctx | : Click context object. See dcmotor17_t object definition for detailed explanation. |