ledflash 2.0.0.0
Public function

Functions

void ledflash_cfg_setup (ledflash_cfg_t *cfg)
 Config Object Initialization function.
 
LEDFLASH_RETVAL ledflash_init (ledflash_t *ctx, ledflash_cfg_t *cfg)
 Initialization function.
 
void ledflash_char_supcap_enable (ledflash_t *ctx)
 Charge Supercapacitor Enable function.
 
void ledflash_flash_enable (ledflash_t *ctx)
 Flash Enable function.
 
void ledflash_torch_enable (ledflash_t *ctx)
 Torch Enable function.
 
void ledflash_char_supcap_disable (ledflash_t *ctx)
 Charge Supercapacitor Disable function.
 
void ledflash_flash_disable (ledflash_t *ctx)
 Flash Disable function.
 
void ledflash_torch_disable (ledflash_t *ctx)
 Torch Disable function.
 
uint8_t ledflash_flash_rdy_flag (ledflash_t *ctx)
 Check Flash Ready Flag function.
 

Detailed Description

Function Documentation

◆ ledflash_cfg_setup()

void ledflash_cfg_setup ( ledflash_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.

◆ ledflash_char_supcap_disable()

void ledflash_char_supcap_disable ( ledflash_t * ctx)

Charge Supercapacitor Disable function.

Parameters
ctxClick object.

@description Function disables charging of the supercapacitor.

◆ ledflash_char_supcap_enable()

void ledflash_char_supcap_enable ( ledflash_t * ctx)

Charge Supercapacitor Enable function.

Parameters
ctxClick object.

@description Function enables charging of the supercapacitor.

◆ ledflash_flash_disable()

void ledflash_flash_disable ( ledflash_t * ctx)

Flash Disable function.

Parameters
ctxClick object.

@description Function disables flash.

◆ ledflash_flash_enable()

void ledflash_flash_enable ( ledflash_t * ctx)

Flash Enable function.

Parameters
ctxClick object.

@description Function enables flash.

◆ ledflash_flash_rdy_flag()

uint8_t ledflash_flash_rdy_flag ( ledflash_t * ctx)

Check Flash Ready Flag function.

Parameters
ctxClick object.
Returns
'0' if flash is not ready
'1' if flash is ready

@description Functions checks the flash ready flag.

◆ ledflash_init()

LEDFLASH_RETVAL ledflash_init ( ledflash_t * ctx,
ledflash_cfg_t * cfg )

Initialization function.

Parameters
ledflashClick object.
cfgClick configuration structure.

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

◆ ledflash_torch_disable()

void ledflash_torch_disable ( ledflash_t * ctx)

Torch Disable function.

Parameters
ctxClick object.

@description Function disables torch.

◆ ledflash_torch_enable()

void ledflash_torch_enable ( ledflash_t * ctx)

Torch Enable function.

Parameters
ctxClick object.

@description Function enables torch.