#include <as3935.h>

Inheritance diagram for esphome::as3935::AS3935Component:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	loop () override

void	set_irq_pin (GPIOPin *irq_pin)

void	set_distance_sensor (sensor::Sensor *distance_sensor)

void	set_energy_sensor (sensor::Sensor *energy_sensor)

void	set_thunder_alert_binary_sensor (binary_sensor::BinarySensor *thunder_alert_binary_sensor)

void	set_indoor (bool indoor)

void	write_indoor (bool indoor)

void	set_noise_level (uint8_t noise_level)

void	write_noise_level (uint8_t noise_level)

void	set_watchdog_threshold (uint8_t watchdog_threshold)

void	write_watchdog_threshold (uint8_t watchdog_threshold)

void	set_spike_rejection (uint8_t spike_rejection)

void	write_spike_rejection (uint8_t write_spike_rejection)

void	set_lightning_threshold (uint8_t lightning_threshold)

void	write_lightning_threshold (uint8_t lightning_threshold)

void	set_mask_disturber (bool mask_disturber)

void	write_mask_disturber (bool enabled)

void	set_div_ratio (uint8_t div_ratio)

void	write_div_ratio (uint8_t div_ratio)

void	set_capacitance (uint8_t capacitance)

void	write_capacitance (uint8_t capacitance)

Public Member Functions inherited from esphome::Component
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 ()

virtual bool	can_proceed ()

bool	status_has_warning ()

bool	status_has_error ()

void	status_set_warning ()

void	status_set_error ()

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...

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()> &&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()> &&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
sensor::Sensor *	distance_sensor_ {nullptr}

sensor::Sensor *	energy_sensor_ {nullptr}

binary_sensor::BinarySensor *	thunder_alert_binary_sensor_ {nullptr}

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_

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}

Detailed Description

Definition at line 54 of file as3935.h.

Member Function Documentation

◆ clear_statistics_()

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

protected

Definition at line 187 of file as3935.cpp.

◆ dump_config()

void esphome::as3935::AS3935Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

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

Definition at line 26 of file as3935.cpp.

◆ get_distance_to_storm_()

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

protected

Definition at line 198 of file as3935.cpp.

◆ get_lightning_energy_()

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

protected

Definition at line 203 of file as3935.cpp.

◆ get_setup_priority()

float esphome::as3935::AS3935Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 34 of file as3935.cpp.

◆ loop()

void esphome::as3935::AS3935Component::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 36 of file as3935.cpp.

◆ read_interrupt_register_()

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

protected

Definition at line 175 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 220 of file as3935.cpp.

◆ set_capacitance()

void esphome::as3935::AS3935Component::set_capacitance ( uint8_t capacitance )

inline

Definition at line 81 of file as3935.h.

◆ set_distance_sensor()

void esphome::as3935::AS3935Component::set_distance_sensor ( sensor::Sensor * distance_sensor )

inline

Definition at line 62 of file as3935.h.

◆ set_div_ratio()

void esphome::as3935::AS3935Component::set_div_ratio ( uint8_t div_ratio )

inline

Definition at line 79 of file as3935.h.

◆ set_energy_sensor()

void esphome::as3935::AS3935Component::set_energy_sensor ( sensor::Sensor * energy_sensor )

inline

Definition at line 63 of file as3935.h.

◆ set_indoor()

void esphome::as3935::AS3935Component::set_indoor ( bool indoor )

inline

Definition at line 67 of file as3935.h.

◆ set_irq_pin()

void esphome::as3935::AS3935Component::set_irq_pin ( GPIOPin * irq_pin )

inline

Definition at line 61 of file as3935.h.

◆ set_lightning_threshold()

void esphome::as3935::AS3935Component::set_lightning_threshold ( uint8_t lightning_threshold )

inline

Definition at line 75 of file as3935.h.

◆ set_mask_disturber()

void esphome::as3935::AS3935Component::set_mask_disturber ( bool mask_disturber )

inline

Definition at line 77 of file as3935.h.

◆ set_noise_level()

void esphome::as3935::AS3935Component::set_noise_level ( uint8_t noise_level )

inline

Definition at line 69 of file as3935.h.

◆ set_spike_rejection()

void esphome::as3935::AS3935Component::set_spike_rejection ( uint8_t spike_rejection )

inline

Definition at line 73 of file as3935.h.

◆ set_thunder_alert_binary_sensor()

void esphome::as3935::AS3935Component::set_thunder_alert_binary_sensor ( binary_sensor::BinarySensor * thunder_alert_binary_sensor )

inline

Definition at line 64 of file as3935.h.

◆ set_watchdog_threshold()

void esphome::as3935::AS3935Component::set_watchdog_threshold ( uint8_t watchdog_threshold )

inline

Definition at line 71 of file as3935.h.

◆ setup()

void esphome::as3935::AS3935Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::as3935_spi::SPIAS3935Component.

Definition at line 9 of file as3935.cpp.

◆ write_capacitance()

void esphome::as3935::AS3935Component::write_capacitance ( uint8_t capacitance )

Definition at line 162 of file as3935.cpp.

◆ write_div_ratio()

void esphome::as3935::AS3935Component::write_div_ratio ( uint8_t div_ratio )

Definition at line 138 of file as3935.cpp.

◆ write_indoor()

void esphome::as3935::AS3935Component::write_indoor ( bool indoor )

Definition at line 59 of file as3935.cpp.

◆ write_lightning_threshold()

void esphome::as3935::AS3935Component::write_lightning_threshold ( uint8_t lightning_threshold )

Definition at line 105 of file as3935.cpp.

◆ write_mask_disturber()

void esphome::as3935::AS3935Component::write_mask_disturber ( bool enabled )

Definition at line 126 of file as3935.cpp.

◆ write_noise_level()

void esphome::as3935::AS3935Component::write_noise_level ( uint8_t noise_level )

Definition at line 82 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.

◆ write_spike_rejection()

void esphome::as3935::AS3935Component::write_spike_rejection ( uint8_t write_spike_rejection )

Definition at line 94 of file as3935.cpp.

◆ write_watchdog_threshold()

void esphome::as3935::AS3935Component::write_watchdog_threshold ( uint8_t watchdog_threshold )

Definition at line 70 of file as3935.cpp.

Field Documentation

◆ capacitance_

uint8_t esphome::as3935::AS3935Component::capacitance_

protected

Definition at line 107 of file as3935.h.

◆ distance_sensor_

sensor::Sensor* esphome::as3935::AS3935Component::distance_sensor_ {nullptr}

protected

Definition at line 95 of file as3935.h.

◆ div_ratio_

uint8_t esphome::as3935::AS3935Component::div_ratio_

protected

Definition at line 106 of file as3935.h.

◆ energy_sensor_

sensor::Sensor* esphome::as3935::AS3935Component::energy_sensor_ {nullptr}

protected

Definition at line 96 of file as3935.h.

◆ indoor_

bool esphome::as3935::AS3935Component::indoor_

protected

Definition at line 100 of file as3935.h.

◆ irq_pin_

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

protected

Definition at line 98 of file as3935.h.

◆ lightning_threshold_

uint8_t esphome::as3935::AS3935Component::lightning_threshold_

protected

Definition at line 104 of file as3935.h.

◆ mask_disturber_

bool esphome::as3935::AS3935Component::mask_disturber_

protected

Definition at line 105 of file as3935.h.

◆ noise_level_

uint8_t esphome::as3935::AS3935Component::noise_level_

protected

Definition at line 101 of file as3935.h.

◆ spike_rejection_

uint8_t esphome::as3935::AS3935Component::spike_rejection_

protected

Definition at line 103 of file as3935.h.

◆ thunder_alert_binary_sensor_

binary_sensor::BinarySensor* esphome::as3935::AS3935Component::thunder_alert_binary_sensor_ {nullptr}

protected

Definition at line 97 of file as3935.h.

◆ watchdog_threshold_

uint8_t esphome::as3935::AS3935Component::watchdog_threshold_

protected

Definition at line 102 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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clear_statistics_()

◆ dump_config()

◆ get_distance_to_storm_()

◆ get_lightning_energy_()

◆ get_setup_priority()

◆ loop()

◆ read_interrupt_register_()

◆ read_register()

◆ read_register_()

◆ set_capacitance()

◆ set_distance_sensor()

◆ set_div_ratio()

◆ set_energy_sensor()

◆ set_indoor()

◆ set_irq_pin()

◆ set_lightning_threshold()

◆ set_mask_disturber()

◆ set_noise_level()

◆ set_spike_rejection()

◆ set_thunder_alert_binary_sensor()

◆ set_watchdog_threshold()

◆ setup()

◆ write_capacitance()

◆ write_div_ratio()

◆ write_indoor()

◆ write_lightning_threshold()

◆ write_mask_disturber()

◆ write_noise_level()

◆ write_register()

◆ write_spike_rejection()

◆ write_watchdog_threshold()

Field Documentation

◆ capacitance_

◆ distance_sensor_

◆ div_ratio_

◆ energy_sensor_

◆ indoor_

◆ irq_pin_

◆ lightning_threshold_

◆ mask_disturber_

◆ noise_level_

◆ spike_rejection_

◆ thunder_alert_binary_sensor_

◆ watchdog_threshold_