driver_as3935.h

Go to the documentation of this file.

 
#ifndef DRIVER_AS3935_H
#define DRIVER_AS3935_H
 
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    AS3935_INTERFACE_IIC = 0x00,        
    AS3935_INTERFACE_SPI = 0x01,        
} as3935_interface_t;

typedef enum
{
    AS3935_ADDRESS_1 = 0x02,        
    AS3935_ADDRESS_2 = 0x04,        
    AS3935_ADDRESS_3 = 0x06,        
} as3935_address_t;

typedef enum
{
    AS3935_BOOL_FALSE = 0x00,        
    AS3935_BOOL_TRUE  = 0x01,        
} as3935_bool_t;

typedef enum
{
    AS3935_AFE_GAIN_INDOOR  = 0x12,        
    AS3935_AFE_GAIN_OUTDOOR = 0x0E,        
} as3935_afe_gain_t;

typedef enum
{
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_390_INDOOR_28   = 0x0,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_630_INDOOR_45   = 0x1,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_860_INDOOR_62   = 0x2,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_1100_INDOOR_78  = 0x3,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_1140_INDOOR_95  = 0x4,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_1570_INDOOR_112 = 0x5,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_1800_INDOOR_130 = 0x6,        
    AS3935_NOISE_FLOOR_LEVEL_OUTDOOR_2000_INDOOR_146 = 0x7,        
} as3935_noise_floor_level_t;

typedef enum
{
    AS3935_LIGHTNING_MIN_NUMBER_1  = 0x0,        
    AS3935_LIGHTNING_MIN_NUMBER_5  = 0x1,        
    AS3935_LIGHTNING_MIN_NUMBER_9  = 0x2,        
    AS3935_LIGHTNING_MIN_NUMBER_16 = 0x3,        
} as3935_lightning_min_number_t;

typedef enum
{
    AS3935_FREQUENCY_DIVISION_RATION_16  = 0x0,        
    AS3935_FREQUENCY_DIVISION_RATION_32  = 0x1,        
    AS3935_FREQUENCY_DIVISION_RATION_64  = 0x2,        
    AS3935_FREQUENCY_DIVISION_RATION_128 = 0x3,        
} as3935_frequency_division_ration_t;

typedef enum
{
    AS3935_INTERRUPT_STATUS_NOISE_LEVEL_TOO_HIGH = 0x01,        
    AS3935_INTERRUPT_STATUS_DISTURBER_DETECTED   = 0x04,        
    AS3935_INTERRUPT_STATUS_LIGHTNING_INTERRUPT  = 0x08,        
} as3935_interrupt_status_t;

typedef struct as3935_handle_s
{
    uint8_t iic_addr;                                                                   
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*spi_init)(void);                                                          
    uint8_t (*spi_deinit)(void);                                                        
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);                       
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);                      
    void (*receive_callback)(uint8_t type);                                             
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t inited;                                                                     
    uint8_t iic_spi;                                                                    
} as3935_handle_t;

typedef struct as3935_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} as3935_info_t;



#define DRIVER_AS3935_LINK_INIT(HANDLE, STRUCTURE)              memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_AS3935_LINK_IIC_INIT(HANDLE, FUC)                (HANDLE)->iic_init = FUC

#define DRIVER_AS3935_LINK_IIC_DEINIT(HANDLE, FUC)              (HANDLE)->iic_deinit = FUC

#define DRIVER_AS3935_LINK_IIC_READ(HANDLE, FUC)                (HANDLE)->iic_read = FUC

#define DRIVER_AS3935_LINK_IIC_WRITE(HANDLE, FUC)               (HANDLE)->iic_write = FUC

#define DRIVER_AS3935_LINK_SPI_INIT(HANDLE, FUC)                (HANDLE)->spi_init = FUC

#define DRIVER_AS3935_LINK_SPI_DEINIT(HANDLE, FUC)              (HANDLE)->spi_deinit = FUC

#define DRIVER_AS3935_LINK_SPI_READ(HANDLE, FUC)                (HANDLE)->spi_read = FUC

#define DRIVER_AS3935_LINK_SPI_WRITE(HANDLE, FUC)               (HANDLE)->spi_write = FUC

#define DRIVER_AS3935_LINK_DELAY_MS(HANDLE, FUC)                (HANDLE)->delay_ms = FUC

#define DRIVER_AS3935_LINK_DEBUG_PRINT(HANDLE, FUC)             (HANDLE)->debug_print = FUC

#define DRIVER_AS3935_LINK_RECEIVE_CALLBACK(HANDLE, FUC)        (HANDLE)->receive_callback = FUC



uint8_t as3935_info(as3935_info_t *info);

uint8_t as3935_set_interface(as3935_handle_t *handle, as3935_interface_t interface);

uint8_t as3935_get_interface(as3935_handle_t *handle, as3935_interface_t *interface);

uint8_t as3935_set_addr_pin(as3935_handle_t *handle, as3935_address_t addr_pin);

uint8_t as3935_get_addr_pin(as3935_handle_t *handle, as3935_address_t *addr_pin);

uint8_t as3935_irq_handler(as3935_handle_t *handle);

uint8_t as3935_init(as3935_handle_t *handle);

uint8_t as3935_deinit(as3935_handle_t *handle);

uint8_t as3935_read_single_lightning_energy(as3935_handle_t *handle, uint32_t *energy);

uint8_t as3935_read_distance(as3935_handle_t *handle, uint8_t *raw, int8_t *km);

uint8_t as3935_set_power_down(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_power_down(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_set_afe_gain_boost(as3935_handle_t *handle, as3935_afe_gain_t gain);

uint8_t as3935_get_afe_gain_boost(as3935_handle_t *handle, as3935_afe_gain_t *gain);

uint8_t as3935_set_noise_floor_level(as3935_handle_t *handle, as3935_noise_floor_level_t level);

uint8_t as3935_get_noise_floor_level(as3935_handle_t *handle, as3935_noise_floor_level_t *level);

uint8_t as3935_set_watchdog_threshold(as3935_handle_t *handle, uint8_t threshold);

uint8_t as3935_get_watchdog_threshold(as3935_handle_t *handle, uint8_t *threshold);

uint8_t as3935_set_clear_statistics(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_clear_statistics(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_set_lightning_min_number(as3935_handle_t *handle, as3935_lightning_min_number_t number);

uint8_t as3935_get_lightning_min_number(as3935_handle_t *handle, as3935_lightning_min_number_t *number);

uint8_t as3935_set_spike_rejection(as3935_handle_t *handle, uint8_t rejection);

uint8_t as3935_get_spike_rejection(as3935_handle_t *handle, uint8_t *rejection);

uint8_t as3935_set_frequency_division_ration(as3935_handle_t *handle, as3935_frequency_division_ration_t division);

uint8_t as3935_get_frequency_division_ration(as3935_handle_t *handle, as3935_frequency_division_ration_t *division);

uint8_t as3935_set_mask_disturber(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_mask_disturber(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_get_interrupt_status(as3935_handle_t *handle, as3935_interrupt_status_t *status);

uint8_t as3935_set_lc_osc_display_on_irq(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_display_lc_osc_on_irq(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_set_system_rc_osc_display_on_irq(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_system_rc_osc_display_on_irq(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_set_timer_rc_osc_display_on_irq(as3935_handle_t *handle, as3935_bool_t enable);

uint8_t as3935_get_timer_rc_osc_display_on_irq(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_set_internal_tuning_capacitor(as3935_handle_t *handle, uint8_t cap);

uint8_t as3935_get_internal_tuning_capacitor(as3935_handle_t *handle, uint8_t *cap);

uint8_t as3935_get_timer_rc_osc_calibration_done(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_get_timer_rc_osc_calibration_not_ok(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_get_system_rc_osc_calibration_done(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_get_system_rc_osc_calibration_not_ok(as3935_handle_t *handle, as3935_bool_t *enable);

uint8_t as3935_reset_default(as3935_handle_t *handle);

uint8_t as3935_set_calibrate_rc_osc(as3935_handle_t *handle);

uint8_t as3935_internal_tuning_capacitor_convert_to_register(as3935_handle_t *handle, float pf, uint8_t *reg);

uint8_t as3935_internal_tuning_capacitor_convert_to_data(as3935_handle_t *handle, uint8_t reg, float *pf);



uint8_t as3935_set_reg(as3935_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t as3935_get_reg(as3935_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif