brushless24
2.1.0.0
|
API for configuring and manipulating Brushless 24 Click driver. More...
Modules | |
Brushless 24 PWM Settings | |
Settings for configuration of Brushless 24 Click driver. | |
Brushless 24 MikroBUS Map | |
MikroBUS pin mapping of Brushless 24 Click driver. | |
Functions | |
void | brushless24_cfg_setup (brushless24_cfg_t *cfg) |
Brushless 24 configuration object setup function. More... | |
err_t | brushless24_init (brushless24_t *ctx, brushless24_cfg_t *cfg) |
Brushless 24 initialization function. More... | |
err_t | brushless24_default_cfg (brushless24_t *ctx) |
Brushless 24 default configuration function. More... | |
err_t | brushless24_set_duty_cycle (brushless24_t *ctx, float duty_cycle) |
Brushless 24 sets PWM duty cycle. More... | |
err_t | brushless24_pwm_stop (brushless24_t *ctx) |
Brushless 24 stop PWM module. More... | |
err_t | brushless24_pwm_start (brushless24_t *ctx) |
Brushless 24 start PWM module. More... | |
uint8_t | brushless24_get_int_state (brushless24_t *ctx) |
Brushless 24 get INT pin state. More... | |
API for configuring and manipulating Brushless 24 Click driver.
void brushless24_cfg_setup | ( | brushless24_cfg_t * | cfg | ) |
Brushless 24 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See brushless24_cfg_t object definition for detailed explanation. |
err_t brushless24_default_cfg | ( | brushless24_t * | ctx | ) |
Brushless 24 default configuration function.
This function executes a default configuration of Brushless 24 click board.
[in] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t brushless24_get_int_state | ( | brushless24_t * | ctx | ) |
Brushless 24 get INT pin state.
This function reads state of the INT pin.
[in] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
err_t brushless24_init | ( | brushless24_t * | ctx, |
brushless24_cfg_t * | cfg | ||
) |
Brushless 24 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See brushless24_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t brushless24_pwm_start | ( | brushless24_t * | ctx | ) |
Brushless 24 start PWM module.
This function starts the PWM module output.
[in] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t brushless24_pwm_stop | ( | brushless24_t * | ctx | ) |
Brushless 24 stop PWM module.
This function stops the PWM module output.
[in] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t brushless24_set_duty_cycle | ( | brushless24_t * | ctx, |
float | duty_cycle | ||
) |
Brushless 24 sets PWM duty cycle.
This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).
[in] | ctx | : Click context object. See brushless24_t object definition for detailed explanation. |
[in] | duty_cycle | : PWM duty cycle. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.