Public function

Functions
void	earthquake_cfg_setup (earthquake_cfg_t *cfg)
	Config Object Initialization function.
EARTHQUAKE_RETVAL	earthquake_init (earthquake_t *ctx, earthquake_cfg_t *cfg)
	Initialization function.
void	earthquake_generic_write (earthquake_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	earthquake_generic_read (earthquake_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
uint8_t	earthquake_proc_notify (earthquake_t *ctx)
	Shutoff output function.
uint8_t	earthquake_shutoff_output (earthquake_t *ctx)
	Shutoff output function.
uint8_t	earthquake_read_status (earthquake_t *ctx)
	Read status function.
uint16_t	earthquake_read_si (earthquake_t *ctx)
	Read SI function.
void	earthquake_clear_memory (earthquake_t *ctx)
	Clear Memory function.

Detailed Description

Function Documentation

earthquake_cfg_setup()

void earthquake_cfg_setup

(

earthquake_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

earthquake_clear_memory()

void earthquake_clear_memory

(

earthquake_t *

ctx

)

Clear Memory function.

Parameters

ctx	Click object.

Returns

combined values of SI_H and SI_L registers

@description This function clears earthquake data, self-diagnostic data, latest offset data and initial installation data.

earthquake_generic_read()

void earthquake_generic_read	(	earthquake_t *	ctx,
		uint16_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf.
len	Number of the bytes to be read

@description This function reads data from the desired register.

earthquake_generic_write()

void earthquake_generic_write	(	earthquake_t *	ctx,
		uint16_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

earthquake_init()

EARTHQUAKE_RETVAL earthquake_init	(	earthquake_t *	ctx,
		earthquake_cfg_t *	cfg )

Initialization function.

Parameters

earthquake	Click object.
cfg	Click configuration structure.

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

earthquake_proc_notify()

uint8_t earthquake_proc_notify

(

earthquake_t *

ctx

)

Shutoff output function.

Parameters

ctx	Click object.

Returns

• 0 : when idle;
• 1 : when working;

@description This function reads state od INT2 pin. An open-drain output, goes active during earthquake calculations, offset acquisition, and self-diagnostic processing.

earthquake_read_si()

uint16_t earthquake_read_si

(

earthquake_t *

ctx

)

Read SI function.

Parameters

ctx	Click object.

Returns

combined values of SI_H and SI_L registers

@description This function reads and combines data from SI_H and SI_L registers.

earthquake_read_status()

uint8_t earthquake_read_status

(

earthquake_t *

ctx

)

Read status function.

Parameters

ctx	Click object.

Returns

value that represents status

• 0 : Normal Mode standby
• 1 : Normal Mode not in standby
• 2 : Initial Installation Mode
• 3 : Offset Acquisition Mode
• 4 : Self-Diagnostic Mode

@description This function reads data from a STATE register.

earthquake_shutoff_output()

uint8_t earthquake_shutoff_output

(

earthquake_t *

ctx

)

Shutoff output function.

Parameters

ctx	Click object.

Returns

• 0 : when idle;
• 1 : when working;

@description This function reads state od INT1 pin. An open-drain output, goes active (ON) when the shutoff judgment condition and collapse detection condition are met.