irbeacon 2.0.0.0
Public function

Functions

void irbeacon_cfg_setup (irbeacon_cfg_t *cfg)
 Config Object Initialization function.
 
IRBEACON_RETVAL irbeacon_init (irbeacon_t *ctx, irbeacon_cfg_t *cfg)
 Initialization function.
 
void irbeacon_set_duty_cycle (irbeacon_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle.
 
void irbeacon_pwm_stop (irbeacon_t *ctx)
 Stop PWM module.
 
void irbeacon_pwm_start (irbeacon_t *ctx)
 Start PWM module.
 
void irbeacon_enable_mod (irbeacon_t *ctx)
 Enable MOD function.
 
void irbeacon_disable_mod (irbeacon_t *ctx)
 Disable MOD function.
 
void irbeacon_reset_mod (irbeacon_t *ctx)
 Reset MOD function.
 

Detailed Description

Function Documentation

◆ irbeacon_cfg_setup()

void irbeacon_cfg_setup ( irbeacon_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.

◆ irbeacon_disable_mod()

void irbeacon_disable_mod ( irbeacon_t * ctx)

Disable MOD function.

Parameters
ctxClick object.

@description Function disables the device by clearing MOD pin.

◆ irbeacon_enable_mod()

void irbeacon_enable_mod ( irbeacon_t * ctx)

Enable MOD function.

Parameters
ctxClick object.

@description Function enables the device by seting MOD pin.

◆ irbeacon_init()

IRBEACON_RETVAL irbeacon_init ( irbeacon_t * ctx,
irbeacon_cfg_t * cfg )

Initialization function.

Parameters
irbeaconClick object.
cfgClick configuration structure.

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

◆ irbeacon_pwm_start()

void irbeacon_pwm_start ( irbeacon_t * ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ irbeacon_pwm_stop()

void irbeacon_pwm_stop ( irbeacon_t * ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ irbeacon_reset_mod()

void irbeacon_reset_mod ( irbeacon_t * ctx)

Reset MOD function.

Parameters
ctxClick object.

@description Function resets the device.

Note
This function has small 100ms delay.

◆ irbeacon_set_duty_cycle()

void irbeacon_set_duty_cycle ( irbeacon_t * ctx,
float duty_cycle )

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.