heater 2.0.0.0
Public function

Functions

void heater_cfg_setup (heater_cfg_t *cfg, heater_config_t *cfg1)
 Config Object Initialization function.
 
HEATER_RETVAL heater_init (heater_t *ctx, heater_cfg_t *cfg, heater_config_t *cfg1)
 Initialization function.
 
void heater_set_led1_status (heater_t *ctx, uint8_t status)
 Sets state of the rst pin.
 
void heater_set_led2_status (heater_t *ctx, uint8_t status)
 Sets state of the cs pin.
 
uint16_t heater_read_data (heater_t *ctx)
 Generic function for reading data from device.
 
float heater_read_mv (heater_t *ctx)
 Function reads data from device and converts it to mV value.
 
float heater_read_temp (heater_t *ctx)
 Function reads data and converts it to temperature data in degree C.
 
void heater_set_duty_cycle (heater_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle.
 
void heater_pwm_stop (heater_t *ctx)
 Stop PWM module.
 
void heater_pwm_start (heater_t *ctx)
 Start PWM module.
 

Detailed Description

Function Documentation

◆ heater_cfg_setup()

void heater_cfg_setup ( heater_cfg_t * cfg,
heater_config_t * cfg1 )

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ heater_init()

HEATER_RETVAL heater_init ( heater_t * ctx,
heater_cfg_t * cfg,
heater_config_t * cfg1 )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ heater_pwm_start()

void heater_pwm_start ( heater_t * ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ heater_pwm_stop()

void heater_pwm_stop ( heater_t * ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ heater_read_data()

uint16_t heater_read_data ( heater_t * ctx)

Generic function for reading data from device.

Parameters
ctxClick object.
Returns
Raw adc data

◆ heater_read_mv()

float heater_read_mv ( heater_t * ctx)

Function reads data from device and converts it to mV value.

Parameters
ctxClick object.
Returns
Read data in mV

◆ heater_read_temp()

float heater_read_temp ( heater_t * ctx)

Function reads data and converts it to temperature data in degree C.

Parameters
ctxClick object.
Returns
Read data in degree C

◆ heater_set_duty_cycle()

void heater_set_duty_cycle ( heater_t * ctx,
float duty_cycle )

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.

◆ heater_set_led1_status()

void heater_set_led1_status ( heater_t * ctx,
uint8_t status )

Sets state of the rst pin.

Parameters
ctxClick object.
statusstatus of the led

◆ heater_set_led2_status()

void heater_set_led2_status ( heater_t * ctx,
uint8_t status )

Sets state of the cs pin.

Parameters
ctxClick object.
statusstatus of the led