Fan click
Fan Click carries an EMC2301 controller for powering and regulating the operation of 5V four-wire fans, which are commonly utilized as coolers in computers and other electronics.
click Product page
Click library
- Author : MikroE Team
- Date : jan 2020.
- Type : I2C type
Software Support
We provide a library for the Fan Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.
Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.
Library Description
This library contains API for Fan Click driver.
Standard key functions :
- Config Object Initialization function.
void fan_cfg_setup ( fan_cfg_t *cfg );
- Initialization function.
FAN_RETVAL fan_init ( fan_t *ctx, fan_cfg_t *cfg );
Example key functions :
- Generic write function.
void fan_generic_write ( fan_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
- Generic read function.
void fan_generic_read ( fan_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
- Fan click lock registers.
void fan_lock_registers ( fan_t *ctx, uint8_t lock );
Examples Description
This application is controller for powering and regulating.
The demo application is composed of two sections :
Application Init
Initialization driver init and init chip.
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
if (
fan_init( &fan, &fan_cfg ) == I2C_MASTER_ERROR )
{
log_info( &logger, "---- Application Init Error ----" );
log_info( &logger, "---- Please, run program again ----" );
for ( ; ; );
}
log_info( &logger, "---- Application Init Done ----" );
log_info( &logger, "---- Application Program Running... ----\n" );
}
#define FAN_MAP_MIKROBUS(cfg, mikrobus)
Definition fan.h:65
err_t fan_default_cfg(fan_t *ctx)
Click Default Configuration function.
err_t fan_pwm_base(fan_t *ctx, uint8_t freq)
Set PWM base frequency function.
err_t fan_init(fan_t *ctx, fan_cfg_t *cfg)
Initialization function.
void fan_cfg_setup(fan_cfg_t *cfg)
Config Object Initialization function.
void application_init(void)
Definition main.c:43
#define FAN_PWM_BASE_FREQ_HALF_SCALE
Definition main.c:33
Click configuration structure definition.
Definition fan.h:250
Application Task
Performs a control of the fan and reads rotation per minute (RPM). Results will be sent to the usb uart terminal.
{
{
log_printf( &logger, " Duty Ratio : %u%%\r\n", (uint16_t)duty );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
uint16_t tacho = 0;
log_printf( &logger, " Rotation per minute : %urpm\r\n\n", tacho );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}
}
err_t fan_get_tach(fan_t *ctx, uint16_t *data_out)
Get tach function.
err_t fan_setting(fan_t *ctx, double percentage)
Fan setting function.
#define FAN_DUTY_RATIO_0_PER
Definition main.c:28
void application_task(void)
Definition main.c:78
#define FAN_DUTY_RATIO_100_PER
Definition main.c:30
#define FAN_DUTY_RATIO_10_PER
Definition main.c:29
The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.
Other mikroE Libraries used in the example:
- MikroSDK.Board
- MikroSDK.Log
- Click.Fan
Additional notes and informations
Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.