API for configuring and manipulating Brushless 12 Click driver.
More...
API for configuring and manipulating Brushless 12 Click driver.
◆ BRUSHLESS12_BRAKE
#define BRUSHLESS12_BRAKE 0 |
◆ BRUSHLESS12_DIR_FORWARD
#define BRUSHLESS12_DIR_FORWARD 1 |
◆ BRUSHLESS12_DIR_REVERSE
#define BRUSHLESS12_DIR_REVERSE 0 |
◆ BRUSHLESS12_DISABLE
#define BRUSHLESS12_DISABLE 0 |
◆ BRUSHLESS12_ENABLE
#define BRUSHLESS12_ENABLE 1 |
◆ BRUSHLESS12_START
#define BRUSHLESS12_START 1 |
◆ brushless12_cfg_setup()
Brushless 12 configuration object setup function.
This function initializes click configuration structure to initial values.
- Parameters
-
[out] | cfg | : Click configuration structure. See brushless12_cfg_t object definition for detailed explanation. |
- Returns
- Nothing.
- Note
- The all used pins will be set to unconnected state.
◆ brushless12_default_cfg()
Brushless 12 default configuration function.
This function executes a default configuration of Brushless 12 click board.
- Parameters
-
[in] | ctx | : Click context object. See brushless12_t object definition for detailed explanation. |
- Returns
-
See #err_t definition for detailed explanation.
- Note
- This function can consist any necessary configuration or setting to put device into operating mode.
◆ brushless12_init()
Brushless 12 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
- Parameters
-
[out] | ctx | : Click context object. See brushless12_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See brushless12_cfg_t object definition for detailed explanation. |
- Returns
-
See #err_t definition for detailed explanation.
- Note
- None.
◆ brushless12_set_brake()
void brushless12_set_brake |
( |
brushless12_t * |
ctx, |
|
|
uint8_t |
state |
|
) |
| |
Brushless 12 set BRK pin state function.
This function sets the BRK pin to the desired state.
- Parameters
-
[in] | ctx | : Click context object. See brushless12_t object definition for detailed explanation. |
- Returns
- Nothing.
- Note
- None.
◆ brushless12_set_direction()
void brushless12_set_direction |
( |
brushless12_t * |
ctx, |
|
|
uint8_t |
state |
|
) |
| |
Brushless 12 set F/R pin state function.
This function sets the F/R pin to the desired state.
- Parameters
-
[in] | ctx | : Click context object. See brushless12_t object definition for detailed explanation. |
- Returns
- Nothing.
- Note
- None.
◆ brushless12_set_enable()
void brushless12_set_enable |
( |
brushless12_t * |
ctx, |
|
|
uint8_t |
state |
|
) |
| |
Brushless 12 set EN pin state function.
This function sets the EN pin to the desired state.
- Parameters
-
[in] | ctx | : Click context object. See brushless12_t object definition for detailed explanation. |
- Returns
- Nothing.
- Note
- None.