LibDriver AS3935
Loading...
Searching...
No Matches
driver_as3935_basic.h File Reference

driver as3935 basic header file More...

Include dependency graph for driver_as3935_basic.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

driver as3935 basic header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version
1.0.0
Author
Shifeng Li
Date
2025-12-23

history

Date Version Author Description
2025/12/23 1.0 Shifeng Li first upload

Definition in file driver_as3935_basic.h.