flame 2.0.0.0
Public function

Functions

void flame_cfg_setup (flame_cfg_t *cfg)
 Config Object Initialization function.
 
FLAME_RETVAL flame_init (flame_t *ctx, flame_cfg_t *cfg)
 Initialization function.
 
uint8_t flame_check_status (flame_t *ctx)
 Check the flame status function.
 
uint8_t flame_get_interrupt (flame_t *ctx)
 Get interrupt status.
 

Detailed Description

Function Documentation

◆ flame_cfg_setup()

void flame_cfg_setup ( flame_cfg_t * cfg)

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.

◆ flame_check_status()

uint8_t flame_check_status ( flame_t * ctx)

Check the flame status function.

Parameters
ctxClick object.

@description This function will return 1 if a flame is detected and 0 if flame is not detectedfunction initializes all necessary pins and peripherals used for this click.

◆ flame_get_interrupt()

uint8_t flame_get_interrupt ( flame_t * ctx)

Get interrupt status.

Parameters
ctxClick object.

@description This functions for reads interrupt pin.

◆ flame_init()

FLAME_RETVAL flame_init ( flame_t * ctx,
flame_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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