brushless3
2.0.0.0
|
Functions | |
void | brushless3_cfg_setup (brushless3_cfg_t *cfg) |
Config Object Initialization function. More... | |
BRUSHLESS3_RETVAL | brushless3_init (brushless3_t *ctx, brushless3_cfg_t *cfg) |
Initialization function. More... | |
void | brushless3_default_cfg (brushless3_t *ctx) |
Click Default Configuration function. More... | |
void | brushless3_write_data (brushless3_t *ctx, uint8_t reg_addr, uint8_t write_data) |
Write function. More... | |
uint8_t | brushless3_read_data (brushless3_t *ctx, uint8_t reg_addr) |
Read function. More... | |
void | brushless3_set_default_param (brushless3_t *ctx) |
Set default parameter function. More... | |
void | brushless3_set_pwm_mode (brushless3_t *ctx) |
Set PWM mode function. More... | |
void | brushless3_set_an_mode (brushless3_t *ctx) |
Set Analog mode function. More... | |
void | brushless3_disable_sleep_mode (brushless3_t *ctx) |
Disable entering into sleep or standby mode function. More... | |
void | brushless3_enable_config (brushless3_t *ctx) |
Enable the writing to the configuration registers function. More... | |
void | brushless3_disable_config (brushless3_t *ctx) |
Disable the writing to the configuration registers function. More... | |
void | brushless3_copy_eeprom (brushless3_t *ctx) |
Copy EEPROM data to register function. More... | |
void | brushless3_enable_write_eeprom (brushless3_t *ctx) |
Enable the writing to the EEPROM registers function. More... | |
void | brushless3_disable_write_eeprom (brushless3_t *ctx) |
Disable the writing to the EEPROM registers function. More... | |
uint8_t | brushless3_check_over_temp (brushless3_t *ctx) |
Check indicate device temperature is over its limits function. More... | |
uint8_t | brushless3_check_sleep_mode (brushless3_t *ctx) |
Check indicate that device went into sleep or standby mode function. More... | |
uint8_t | brushless3_check_motor_lock (brushless3_t *ctx) |
Check indicate that the motor is locked function. More... | |
float | brushless3_get_supply_voltage_value (brushless3_t *ctx) |
Get the supply voltage function. More... | |
float | brushless3_get_speed_cmd (brushless3_t *ctx) |
Get the speed command ( % ) based on analog or PWM or I2C function. More... | |
uint8_t | brushless3_check_fault_code (brushless3_t *ctx) |
Check fault code function. More... | |
float | brushless3_get_speed (brushless3_t *ctx) |
Get speed function. More... | |
void | brushless3_set_speed (brushless3_t *ctx, uint16_t motor_speed_hz) |
Set speed function. More... | |
void | brushless3_set_speedPWM (brushless3_t *ctx, uint16_t motor_speed_hz) |
Set speed PWM function. More... | |
float | brushless3_get_period (brushless3_t *ctx) |
Get motor period function. More... | |
void | brushless3_enable_programming_eeprom (brushless3_t *ctx) |
Set prog key function. More... | |
float | brushless3_get_velocity_constant (brushless3_t *ctx) |
Get measured velocity constant function. More... | |
void | brushless3_forward_direction (brushless3_t *ctx) |
Set the direction of rotation in the forward direction function. More... | |
void | brushless3_reverse_direction (brushless3_t *ctx) |
Set the direction of rotation in the reverse direction function. More... | |
uint8_t | brushless3_get_interrupt_status (brushless3_t *ctx) |
Get Interrupt pin state function. More... | |
void | brushless3_set_duty_cycle (brushless3_t *ctx, float duty_cycle) |
Generic sets PWM duty cycle. More... | |
void | brushless3_pwm_stop (brushless3_t *ctx) |
Stop PWM module. More... | |
void | brushless3_pwm_start (brushless3_t *ctx) |
Start PWM module. More... | |
void brushless3_cfg_setup | ( | brushless3_cfg_t * | cfg | ) |
Config Object Initialization function.
cfg | Click configuration structure. |
@description This function initializes click configuration structure to init state.
uint8_t brushless3_check_fault_code | ( | brushless3_t * | ctx | ) |
Check fault code function.
ctx | Click object. |
@description Function check fault code by read 8-bit value from the target Fault Code register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
uint8_t brushless3_check_motor_lock | ( | brushless3_t * | ctx | ) |
Check indicate that the motor is locked function.
ctx | Click object. |
@description Function check indicate that the motor is locked by check bit4 from the target Status register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
uint8_t brushless3_check_over_temp | ( | brushless3_t * | ctx | ) |
Check indicate device temperature is over its limits function.
ctx | Click object. |
@description Function check indicate device temperature is over its limits by check bit7 from the target Status register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
uint8_t brushless3_check_sleep_mode | ( | brushless3_t * | ctx | ) |
Check indicate that device went into sleep or standby mode function.
ctx | Click object. |
@description Function check indicate device went into sleep or standby mode by check bit6 from the target Status register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_copy_eeprom | ( | brushless3_t * | ctx | ) |
Copy EEPROM data to register function.
ctx | Click object. |
@description Function copy EEPROM data to register by set bit5 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_default_cfg | ( | brushless3_t * | ctx | ) |
Click Default Configuration function.
ctx | Click object. |
@description This function executes default configuration for Brushless3 click.
void brushless3_disable_config | ( | brushless3_t * | ctx | ) |
Disable the writing to the configuration registers function.
ctx | Click object. |
@description Function enable the writing to the configuration registers by clear bit6 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_disable_sleep_mode | ( | brushless3_t * | ctx | ) |
Disable entering into sleep or standby mode function.
ctx | Click object. |
@description Function set Analog mode by set bit7 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_disable_write_eeprom | ( | brushless3_t * | ctx | ) |
Disable the writing to the EEPROM registers function.
ctx | Click object. |
@description Function disable the writing to the EEPROM registers by clear bit4 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_enable_config | ( | brushless3_t * | ctx | ) |
Enable the writing to the configuration registers function.
ctx | Click object. |
@description Function enable the writing to the configuration registers by set bit6 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_enable_programming_eeprom | ( | brushless3_t * | ctx | ) |
Set prog key function.
ctx | Click object. |
@description Function set prog key by write value of 0xB6 from the target Dev CTRL register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_enable_write_eeprom | ( | brushless3_t * | ctx | ) |
Enable the writing to the EEPROM registers function.
ctx | Click object. |
@description Function enable the writing to the EEPROM registers by set bit4 to the target EECtrl register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_forward_direction | ( | brushless3_t * | ctx | ) |
Set the direction of rotation in the forward direction function.
ctx | Click object. |
@description Function set the direction of rotation in the forward direction by sets PWM and RST pin on Brushless 3 Click board.
uint8_t brushless3_get_interrupt_status | ( | brushless3_t * | ctx | ) |
Get Interrupt pin state function.
ctx | Click object. |
@description Function get Interrupt ( INT ) pin state of Brushless 3 Click board.
float brushless3_get_period | ( | brushless3_t * | ctx | ) |
Get motor period function.
ctx | Click object. |
@description Function get motor period by read value from the two target Motor Period 1 and 2 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
float brushless3_get_speed | ( | brushless3_t * | ctx | ) |
Get speed function.
ctx | Click object. |
@description Function get speed by read value from the two target Motor Speed 1 and 2 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
float brushless3_get_speed_cmd | ( | brushless3_t * | ctx | ) |
Get the speed command ( % ) based on analog or PWM or I2C function.
ctx | Click object. |
@description Function get the speed command ( % ) based on analog or PWM or I2C by read the value from the target Speed CMD register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
float brushless3_get_supply_voltage_value | ( | brushless3_t * | ctx | ) |
Get the supply voltage function.
ctx | Click object. |
@description Function get the supply voltage by read the value from the target Supply Voltage register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
float brushless3_get_velocity_constant | ( | brushless3_t * | ctx | ) |
Get measured velocity constant function.
ctx | Click object. |
@description Function get measured velocity constant by read value from the two target Motor KT 1 and 2 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
BRUSHLESS3_RETVAL brushless3_init | ( | brushless3_t * | ctx, |
brushless3_cfg_t * | cfg | ||
) |
Initialization function.
brushless3 | Click object. |
cfg | Click configuration structure. |
@description This function initializes all necessary pins and peripherals used for this click.
void brushless3_pwm_start | ( | brushless3_t * | ctx | ) |
Start PWM module.
ctx | Click object. |
@description This function starts PWM module.
void brushless3_pwm_stop | ( | brushless3_t * | ctx | ) |
Stop PWM module.
ctx | Click object. |
@description This function stops PWM module.
uint8_t brushless3_read_data | ( | brushless3_t * | ctx, |
uint8_t | reg_addr | ||
) |
Read function.
ctx | Click object. |
reg_addr | Register address. |
@description This function reads data from the desired register.
void brushless3_reverse_direction | ( | brushless3_t * | ctx | ) |
Set the direction of rotation in the reverse direction function.
ctx | Click object. |
@description Function set the direction of rotation in the reverse direction by sets PWM and clear RST pin on Brushless 3 Click board.
void brushless3_set_an_mode | ( | brushless3_t * | ctx | ) |
Set Analog mode function.
ctx | Click object. |
@description Function set Analog mode by clear bit1 to the target SysOpt9 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_set_default_param | ( | brushless3_t * | ctx | ) |
Set default parameter function.
ctx | Click object. |
@description Function set default parameter by write the default data to the a few target 8-bit register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_set_duty_cycle | ( | brushless3_t * | ctx, |
float | duty_cycle | ||
) |
Generic sets PWM duty cycle.
ctx | Click object. |
duty_cycle | Duty cycle. |
@description This function sets the PWM duty cycle.
void brushless3_set_pwm_mode | ( | brushless3_t * | ctx | ) |
Set PWM mode function.
ctx | Click object. |
@description Function set PWM mode by set bit1 to the target SysOpt9 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_set_speed | ( | brushless3_t * | ctx, |
uint16_t | motor_speed_hz | ||
) |
Set speed function.
ctx | Click object. |
motor_speed_hz | Float value of motor speed ( Hz ); |
@description Function set speed by write the desired value to the two target Speed Ctrl 1 and 2 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_set_speedPWM | ( | brushless3_t * | ctx, |
uint16_t | motor_speed_hz | ||
) |
Set speed PWM function.
ctx | Click object. |
motor_speed_hz | Float value of motor speed ( Hz ); |
@description Function set speed by write the desired value to the two target Speed Ctrl 1 and 2 register address of DRV10983 sensorless BLDC motor driver on Brushless 3 click board.
void brushless3_write_data | ( | brushless3_t * | ctx, |
uint8_t | reg_addr, | ||
uint8_t | write_data | ||
) |
Write function.
ctx | Click object. |
reg_addr | Register address. |
write_data | Byte of data to be written. |
@description This function writes data to the desired register.