as3935 example driver function

as3935 example driver modules More...

Collaboration diagram for as3935 example driver function:

Macros
#define	AS3935_BASIC_DEFAULT_AFE_GAIN   AS3935_AFE_GAIN_INDOOR
	as3935 basic example default definition
#define	AS3935_BASIC_DEFAULT_NOISE_FLOOR_LEVEL   AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_860_INDOOR_62
#define	AS3935_BASIC_DEFAULT_WATCHDOG_THRESHOLD   2
#define	AS3935_BASIC_DEFAULT_LIGHTNING_MIN_NUMBER   AS3935_LIGHTNING_MIN_NUMBER_1
#define	AS3935_BASIC_DEFAULT_SPIKE_REJECTION   2
#define	AS3935_BASIC_DEFAULT_FREQUENCY_DIVISION_RATION   AS3935_FREQUENCY_DIVISION_RATION_16
#define	AS3935_BASIC_DEFAULT_MASK_DISTURBER   AS3935_BOOL_FALSE
#define	AS3935_BASIC_DEFAULT_CAP   0

Functions
uint8_t	as3935_basic_irq_handler (void)
	basic irq handler
uint8_t	as3935_basic_init (as3935_interface_t interface, as3935_address_t addr_pin, void(*callback)(uint8_t type))
	basic example init
uint8_t	as3935_basic_deinit (void)
	basic example deinit
uint8_t	as3935_basic_read_single_lightning_energy (uint32_t *energy)
	basic example read single lightning energy
uint8_t	as3935_basic_read_distance (int8_t *km)
	basic example read distance
uint8_t	as3935_basic_clear_statistics (void)
	basic example clear statistics

Detailed Description

as3935 example driver modules

Macro Definition Documentation

AS3935_BASIC_DEFAULT_AFE_GAIN

#define AS3935_BASIC_DEFAULT_AFE_GAIN   AS3935_AFE_GAIN_INDOOR

as3935 basic example default definition

indoor

Definition at line 56 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_CAP

#define AS3935_BASIC_DEFAULT_CAP   0

0pf

Definition at line 63 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_FREQUENCY_DIVISION_RATION

#define AS3935_BASIC_DEFAULT_FREQUENCY_DIVISION_RATION   AS3935_FREQUENCY_DIVISION_RATION_16

division ratio 16

Definition at line 61 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_LIGHTNING_MIN_NUMBER

#define AS3935_BASIC_DEFAULT_LIGHTNING_MIN_NUMBER   AS3935_LIGHTNING_MIN_NUMBER_1

1 minimum number of lightning

Definition at line 59 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_MASK_DISTURBER

#define AS3935_BASIC_DEFAULT_MASK_DISTURBER   AS3935_BOOL_FALSE

disable

Definition at line 62 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_NOISE_FLOOR_LEVEL

#define AS3935_BASIC_DEFAULT_NOISE_FLOOR_LEVEL   AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_860_INDOOR_62

outdoor 860 μVrms, indoor 62 μVrms

Definition at line 57 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_SPIKE_REJECTION

#define AS3935_BASIC_DEFAULT_SPIKE_REJECTION   2

2

Definition at line 60 of file driver_as3935_basic.h.

AS3935_BASIC_DEFAULT_WATCHDOG_THRESHOLD

#define AS3935_BASIC_DEFAULT_WATCHDOG_THRESHOLD   2

2

Definition at line 58 of file driver_as3935_basic.h.

Function Documentation

as3935_basic_clear_statistics()

uint8_t as3935_basic_clear_statistics

(

void

)

basic example clear statistics

Returns

status code

• 0 success
• 1 clear statistics failed

Note

none

Definition at line 385 of file driver_as3935_basic.c.

Here is the call graph for this function:

as3935_basic_deinit()

uint8_t as3935_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 321 of file driver_as3935_basic.c.

Here is the call graph for this function:

as3935_basic_init()

uint8_t as3935_basic_init	(	as3935_interface_t	interface,
		as3935_address_t	addr_pin,
		void(*	callback )(uint8_t type) )

basic example init

Parameters

[in]	interface	chip interface
[in]	addr_pin	iic device address
[in]	*callback	pointer to a callback address

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 68 of file driver_as3935_basic.c.

Here is the call graph for this function:

as3935_basic_irq_handler()

uint8_t as3935_basic_irq_handler

(

void

)

basic irq handler

Returns

status code

• 0 success
• 1 run failed

Note

none

Definition at line 48 of file driver_as3935_basic.c.

Here is the call graph for this function:

as3935_basic_read_distance()

uint8_t as3935_basic_read_distance

(

int8_t *

km

)

basic example read distance

Parameters

[out]

*km

pointer to a km data buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 365 of file driver_as3935_basic.c.

Here is the call graph for this function:

as3935_basic_read_single_lightning_energy()

uint8_t as3935_basic_read_single_lightning_energy

(

uint32_t *

energy

)

basic example read single lightning energy

Parameters

[out]

*energy

pointer to an energy buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 346 of file driver_as3935_basic.c.

Here is the call graph for this function: