ESPHome  1.15.3
Public Member Functions | Protected Member Functions
esphome::as3935_spi::SPIAS3935Component Class Reference

#include <as3935_spi.h>

Inheritance diagram for esphome::as3935_spi::SPIAS3935Component:
esphome::as3935::AS3935Component esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ > esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::as3935::AS3935Component
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
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ >
 SPIDevice ()=default
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs)
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void spi_setup ()
 
void enable ()
 
void disable ()
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
std::array< uint8_t, N > read_array ()
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 
void transfer_array (std::array< uint8_t, N > &data)
 

Protected Member Functions

void write_register (uint8_t reg, uint8_t mask, uint8_t bits, uint8_t start_position) override
 
uint8_t read_register (uint8_t reg) override
 
- Protected Member Functions inherited from esphome::as3935::AS3935Component
uint8_t read_interrupt_register_ ()
 
void clear_statistics_ ()
 
uint8_t get_distance_to_storm_ ()
 
uint32_t get_lightning_energy_ ()
 
uint8_t read_register_ (uint8_t reg, uint8_t mask)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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...
 

Additional Inherited Members

- Protected Attributes inherited from esphome::as3935::AS3935Component
sensor::Sensordistance_sensor_
 
sensor::Sensorenergy_sensor_
 
binary_sensor::BinarySensorthunder_alert_binary_sensor_
 
GPIOPinirq_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}
 
- Protected Attributes inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ >
SPIComponentparent_
 
GPIOPincs_
 

Detailed Description

Definition at line 14 of file as3935_spi.h.

Member Function Documentation

◆ dump_config()

void esphome::as3935_spi::SPIAS3935Component::dump_config ( )
overridevirtual

Reimplemented from esphome::as3935::AS3935Component.

Definition at line 16 of file as3935_spi.cpp.

◆ read_register()

uint8_t esphome::as3935_spi::SPIAS3935Component::read_register ( uint8_t  reg)
overrideprotectedvirtual

Implements esphome::as3935::AS3935Component.

Definition at line 33 of file as3935_spi.cpp.

◆ setup()

void esphome::as3935_spi::SPIAS3935Component::setup ( )
overridevirtual

Reimplemented from esphome::as3935::AS3935Component.

Definition at line 9 of file as3935_spi.cpp.

◆ write_register()

void esphome::as3935_spi::SPIAS3935Component::write_register ( uint8_t  reg,
uint8_t  mask,
uint8_t  bits,
uint8_t  start_position 
)
overrideprotectedvirtual

Implements esphome::as3935::AS3935Component.

Definition at line 21 of file as3935_spi.cpp.


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