brushless14 2.0.0.0
|
API for configuring and manipulating Brushless 14 Click driver. More...
Modules | |
Brushless 14 Registers List | |
List of registers of Brushless 14 Click driver. | |
Brushless 14 Registers Settings | |
Settings for registers of Brushless 14 Click driver. | |
Brushless 14 MikroBUS Map | |
MikroBUS pin mapping of Brushless 14 Click driver. | |
Functions | |
void | brushless14_cfg_setup (brushless14_cfg_t *cfg) |
Brushless 14 configuration object setup function. More... | |
err_t | brushless14_init (brushless14_t *ctx, brushless14_cfg_t *cfg) |
Brushless 14 initialization function. More... | |
err_t | brushless14_default_cfg (brushless14_t *ctx) |
Brushless 14 default configuration function. More... | |
err_t | brushless14_set_duty_cycle (brushless14_t *ctx, float duty_cycle) |
Brushless 14 sets PWM duty cycle. More... | |
err_t | brushless14_pwm_stop (brushless14_t *ctx) |
Brushless 14 stop PWM module. More... | |
err_t | brushless14_pwm_start (brushless14_t *ctx) |
Brushless 14 start PWM module. More... | |
err_t | brushless14_dac_write (brushless14_t *ctx, uint8_t reg, uint16_t in_data) |
DAC write function. More... | |
err_t | brushless14_dac_read (brushless14_t *ctx, uint8_t reg, uint16_t *out_data) |
DAC reading function. More... | |
err_t | brushless14_set_adj0 (brushless14_t *ctx, uint16_t m_voltage) |
Set Adjusted input 0. More... | |
err_t | brushless14_set_adj1 (brushless14_t *ctx, uint16_t m_voltage) |
Set Adjusted input 1. More... | |
err_t | brushless14_set_adj2 (brushless14_t *ctx, uint16_t m_voltage) |
Set Adjusted input 2. More... | |
err_t | brushless14_set_adj3 (brushless14_t *ctx, uint16_t m_voltage) |
Set Adjusted input 3. More... | |
err_t | brushless14_set_fpwm (brushless14_t *ctx, uint16_t m_voltage) |
Set PWM frequency select input. More... | |
err_t | brushless14_set_la (brushless14_t *ctx, uint16_t m_voltage) |
Set lead angle setting input. More... | |
err_t | brushless14_port_expander_write (brushless14_t *ctx, uint8_t reg, uint8_t in_data) |
Port expander write function. More... | |
err_t | brushless14_port_expander_read (brushless14_t *ctx, uint8_t reg, uint8_t *out_data) |
Port expander reading function. More... | |
err_t | brushless14_set_slop (brushless14_t *ctx, uint8_t state) |
Set soft switching select. More... | |
err_t | brushless14_set_rot (brushless14_t *ctx, uint8_t state) |
Set rotation speed of lead angle switching. More... | |
err_t | brushless14_set_fst (brushless14_t *ctx, uint8_t state) |
Set forced commutation frequency select. More... | |
err_t | brushless14_set_sel_adj (brushless14_t *ctx, uint8_t state) |
Set PWM duty function setting. More... | |
err_t | brushless14_set_lap (brushless14_t *ctx, uint8_t state) |
Set overlapping commutation select. More... | |
err_t | brushless14_get_fg_out (brushless14_t *ctx, uint8_t *state) |
Get rotation speed. More... | |
err_t | brushless14_get_ld_out (brushless14_t *ctx, uint8_t *state) |
Get lock detection signal. More... | |
uint8_t | brushless14_get_int (brushless14_t *ctx) |
Get port expadner interrupt. More... | |
void | brushless14_set_dir (brushless14_t *ctx, uint8_t state) |
Set dirrection pin state. More... | |
API for configuring and manipulating Brushless 14 Click driver.
void brushless14_cfg_setup | ( | brushless14_cfg_t * | cfg | ) |
Brushless 14 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See brushless14_cfg_t object definition for detailed explanation. |
err_t brushless14_dac_read | ( | brushless14_t * | ctx, |
uint8_t | reg, | ||
uint16_t * | out_data | ||
) |
DAC reading function.
This function reads a word from the register for the DAC IC.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | out_data | : Output read data. |
0
- Success, -1
- Error.err_t brushless14_dac_write | ( | brushless14_t * | ctx, |
uint8_t | reg, | ||
uint16_t | in_data | ||
) |
DAC write function.
This function writes a word to the register for the DAC IC.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | in_data | : Data to be written. |
0
- Success, -1
- Error.err_t brushless14_default_cfg | ( | brushless14_t * | ctx | ) |
Brushless 14 default configuration function.
This function executes a default configuration of Brushless 14 click board.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t brushless14_get_fg_out | ( | brushless14_t * | ctx, |
uint8_t * | state | ||
) |
Get rotation speed.
This function gets rotation speed.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.uint8_t brushless14_get_int | ( | brushless14_t * | ctx | ) |
Get port expadner interrupt.
This function gets interrupt signal from port expander pin.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
err_t brushless14_get_ld_out | ( | brushless14_t * | ctx, |
uint8_t * | state | ||
) |
Get lock detection signal.
This function gets lock detection signal.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.err_t brushless14_init | ( | brushless14_t * | ctx, |
brushless14_cfg_t * | cfg | ||
) |
Brushless 14 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See brushless14_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t brushless14_port_expander_read | ( | brushless14_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | out_data | ||
) |
Port expander reading function.
This function reads a byte from the register for the Port expander IC.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | out_data | : Output read data. |
0
- Success, -1
- Error.err_t brushless14_port_expander_write | ( | brushless14_t * | ctx, |
uint8_t | reg, | ||
uint8_t | in_data | ||
) |
Port expander write function.
This function writes a byte to the register for the Port expander IC.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | in_data | : Data to be written. |
0
- Success, -1
- Error.err_t brushless14_pwm_start | ( | brushless14_t * | ctx | ) |
Brushless 14 start PWM module.
This function starts the PWM module output.
[out] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t brushless14_pwm_stop | ( | brushless14_t * | ctx | ) |
Brushless 14 stop PWM module.
This function stops the PWM module output.
[out] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t brushless14_set_adj0 | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set Adjusted input 0.
This function sets adjusted input 0 voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.err_t brushless14_set_adj1 | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set Adjusted input 1.
This function sets adjusted input 1 voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.err_t brushless14_set_adj2 | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set Adjusted input 2.
This function sets adjusted input 2 voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.err_t brushless14_set_adj3 | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set Adjusted input 3.
This function sets adjusted input 3 voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.void brushless14_set_dir | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set dirrection pin state.
This function sets CW/CCW pin state that changes rotation direction.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
err_t brushless14_set_duty_cycle | ( | brushless14_t * | ctx, |
float | duty_cycle | ||
) |
Brushless 14 sets PWM duty cycle.
This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).
[out] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | duty_ratio | : PWM duty_ratio. |
0
- Success, -1
- Error.err_t brushless14_set_fpwm | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set PWM frequency select input.
This function sets PWM frequency select input voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.err_t brushless14_set_fst | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set forced commutation frequency select.
This function sets forced commutation frequency select.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.err_t brushless14_set_la | ( | brushless14_t * | ctx, |
uint16_t | m_voltage | ||
) |
Set lead angle setting input.
This function sets lead angle setting input voltage level.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | m_voltage | : Voltage level to be set in mV. |
0
- Success, -1
- Error.err_t brushless14_set_lap | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set overlapping commutation select.
This function sets overlapping commutation select.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.err_t brushless14_set_rot | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set rotation speed of lead angle switching.
This function sets rotation speed of lead angle switching.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.err_t brushless14_set_sel_adj | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set PWM duty function setting.
This function sets PWM duty function setting.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.err_t brushless14_set_slop | ( | brushless14_t * | ctx, |
uint8_t | state | ||
) |
Set soft switching select.
This function sets soft switching select.
[in] | ctx | : Click context object. See brushless14_t object definition for detailed explanation. |
[in] | state | : Logic state. |
0
- Success, -1
- Error.