#include <as3935.h>

Inheritance diagram for esphome::as3935::AS3935Component:

Protected Member Functions
uint8_t	read_interrupt_register_ ()

void	clear_statistics_ ()

uint8_t	get_distance_to_storm_ ()

uint32_t	get_lightning_energy_ ()

virtual uint8_t	read_register (uint8_t reg)=0

uint8_t	read_register_ (uint8_t reg, uint8_t mask)

virtual void	write_register (uint8_t reg, uint8_t mask, uint8_t bits, uint8_t start_position)=0

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
GPIOPin *	irq_pin_

bool	indoor_

uint8_t	noise_level_

uint8_t	watchdog_threshold_

uint8_t	spike_rejection_

uint8_t	lightning_threshold_

bool	mask_disturber_

uint8_t	div_ratio_

uint8_t	capacitance_

bool	tune_antenna_

bool	calibration_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Additional Inherited Members
Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen. More...

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed ()

bool	is_ready ()

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Detailed Description

Definition at line 64 of file as3935.h.

Member Function Documentation

◆ clear_statistics_()

void esphome::as3935::AS3935Component::clear_statistics_ ( )

protected

Definition at line 205 of file as3935.cpp.

◆ get_distance_to_storm_()

uint8_t esphome::as3935::AS3935Component::get_distance_to_storm_ ( )

protected

Definition at line 216 of file as3935.cpp.

◆ get_lightning_energy_()

uint32_t esphome::as3935::AS3935Component::get_lightning_energy_ ( )

protected

Definition at line 221 of file as3935.cpp.

◆ read_interrupt_register_()

uint8_t esphome::as3935::AS3935Component::read_interrupt_register_ ( )

protected

Definition at line 193 of file as3935.cpp.

◆ read_register()

virtual uint8_t esphome::as3935::AS3935Component::read_register ( uint8_t reg )

protectedpure virtual

Implemented in esphome::as3935_spi::SPIAS3935Component, and esphome::as3935_i2c::I2CAS3935Component.

◆ read_register_()

uint8_t esphome::as3935::AS3935Component::read_register_	(	uint8_t	reg,
		uint8_t	mask
	)

protected

Definition at line 319 of file as3935.cpp.

◆ write_register()

virtual void esphome::as3935::AS3935Component::write_register	(	uint8_t	reg,
		uint8_t	mask,
		uint8_t	bits,
		uint8_t	start_position
	)

protectedpure virtual

Implemented in esphome::as3935_spi::SPIAS3935Component, and esphome::as3935_i2c::I2CAS3935Component.

Field Documentation

◆ calibration_

bool esphome::as3935::AS3935Component::calibration_

protected

Definition at line 128 of file as3935.h.

◆ capacitance_

uint8_t esphome::as3935::AS3935Component::capacitance_

protected

Definition at line 126 of file as3935.h.

◆ div_ratio_

uint8_t esphome::as3935::AS3935Component::div_ratio_

protected

Definition at line 125 of file as3935.h.

◆ indoor_

bool esphome::as3935::AS3935Component::indoor_

protected

Definition at line 119 of file as3935.h.

◆ irq_pin_

GPIOPin* esphome::as3935::AS3935Component::irq_pin_

protected

Definition at line 117 of file as3935.h.

◆ lightning_threshold_

uint8_t esphome::as3935::AS3935Component::lightning_threshold_

protected

Definition at line 123 of file as3935.h.

◆ mask_disturber_

bool esphome::as3935::AS3935Component::mask_disturber_

protected

Definition at line 124 of file as3935.h.

◆ noise_level_

uint8_t esphome::as3935::AS3935Component::noise_level_

protected

Definition at line 120 of file as3935.h.

◆ spike_rejection_

uint8_t esphome::as3935::AS3935Component::spike_rejection_

protected

Definition at line 122 of file as3935.h.

◆ tune_antenna_

bool esphome::as3935::AS3935Component::tune_antenna_

protected

Definition at line 127 of file as3935.h.

◆ watchdog_threshold_

uint8_t esphome::as3935::AS3935Component::watchdog_threshold_

protected

Definition at line 121 of file as3935.h.

The documentation for this class was generated from the following files:

/opt/build/esphome/esphome/components/as3935/as3935.h
/opt/build/esphome/esphome/components/as3935/as3935.cpp

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear_statistics_()

◆ get_distance_to_storm_()

◆ get_lightning_energy_()

◆ read_interrupt_register_()

◆ read_register()

◆ read_register_()

◆ write_register()

Field Documentation

◆ calibration_

◆ capacitance_

◆ div_ratio_

◆ indoor_

◆ irq_pin_

◆ lightning_threshold_

◆ mask_disturber_

◆ noise_level_

◆ spike_rejection_

◆ tune_antenna_

◆ watchdog_threshold_