noise  2.0.0.0
Functions
Public function

Functions

void noise_cfg_setup (noise_cfg_t *cfg)
 Config Object Initialization function. More...
 
NOISE_RETVAL noise_init (noise_t *ctx, noise_cfg_t *cfg)
 Initialization function. More...
 
void noise_default_cfg (noise_t *ctx)
 Click Default Configuration function. More...
 
void noise_generic_transfer (noise_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void noise_write_command_register (noise_t *ctx, uint16_t command_and_data_bits)
 Write to Command Register. More...
 
uint8_t noise_set_command_register (noise_t *ctx, uint8_t configuration, uint16_t threshold)
 Set Command Register. More...
 
void noise_set_state (noise_t *ctx, uint8_t state)
 Enable/disable click. More...
 
void noise_reset (noise_t *ctx)
 Reset Click. More...
 
uint8_t noise_check_int_pin (noise_t *ctx)
 Get INT pin state. More...
 
uint16_t noise_generic_read (noise_t *ctx)
 Read ADC Value. More...
 

Detailed Description

Function Documentation

◆ noise_cfg_setup()

void noise_cfg_setup ( noise_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.

◆ noise_check_int_pin()

uint8_t noise_check_int_pin ( noise_t ctx)

Get INT pin state.

Parameters
ctxClick object.
Returns
State of INT pin ( eighter 0 or 1 )

@description This function gets int pin state.

◆ noise_default_cfg()

void noise_default_cfg ( noise_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function performs default configuration for Noise click. Typically, it's setting threshold to default value.

◆ noise_generic_read()

uint16_t noise_generic_read ( noise_t ctx)

Read ADC Value.

Parameters
ctxClick object.
Returns
Read ADC value

@description This function reads value from adc.

◆ noise_generic_transfer()

void noise_generic_transfer ( noise_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ noise_init()

NOISE_RETVAL noise_init ( noise_t ctx,
noise_cfg_t cfg 
)

Initialization function.

Parameters
noiseClick object.
cfgClick configuration structure.

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

◆ noise_reset()

void noise_reset ( noise_t ctx)

Reset Click.

Parameters
ctxClick object.

@description This function performs click reset.

◆ noise_set_command_register()

uint8_t noise_set_command_register ( noise_t ctx,
uint8_t  configuration,
uint16_t  threshold 
)

Set Command Register.

Parameters
ctxClick object.
configurationConfiguration.
thresholdThreshold.

@description This function sets command register.

Returns
0 - success ; 1 - ( threshold value ) error
Note
Threshold is integer from [0, 4095] segment.
When measured noise level is above threshold, alarm is triggered. 

◆ noise_set_state()

void noise_set_state ( noise_t ctx,
uint8_t  state 
)

Enable/disable click.

Parameters
ctxClick object.
stateState to set click on.

@description This function switches click on or off.

◆ noise_write_command_register()

void noise_write_command_register ( noise_t ctx,
uint16_t  command_and_data_bits 
)

Write to Command Register.

Parameters
ctxClick object.
command_and_data_bitsCommand and data to send.

@description This function writes data to click's command register.