ESPHome  2024.7.0
Public Member Functions | Static Protected Member Functions | Protected Attributes
esphome::spi::SPIComponent Class Reference

#include <spi.h>

Inheritance diagram for esphome::spi::SPIComponent:
esphome::Component

Public Member Functions

SPIDelegateregister_device (SPIClient *device, SPIMode mode, SPIBitOrder bit_order, uint32_t data_rate, GPIOPin *cs_pin)
 
void unregister_device (SPIClient *device)
 
void set_clk (GPIOPin *clk)
 
void set_miso (GPIOPin *sdi)
 
void set_mosi (GPIOPin *sdo)
 
void set_data_pins (std::vector< uint8_t > pins)
 
void set_interface (SPIInterface interface)
 
void set_interface_name (const char *name)
 
float get_setup_priority () const override
 
void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 () const
 
bool is_ready () const
 
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...
 

Static Protected Member Functions

static SPIBusget_bus (SPIInterface interface, GPIOPin *clk, GPIOPin *sdo, GPIOPin *sdi, const std::vector< uint8_t > &data_pins)
 

Protected Attributes

GPIOPinclk_pin_ {nullptr}
 
GPIOPinsdi_pin_ {nullptr}
 
GPIOPinsdo_pin_ {nullptr}
 
std::vector< uint8_t > data_pins_ {}
 
SPIInterface interface_ {}
 
bool using_hw_ {false}
 
const char * interface_name_ {nullptr}
 
SPIBusspi_bus_ {}
 
std::map< SPIClient *, SPIDelegate * > devices_
 
- 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

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

Detailed Description

Definition at line 328 of file spi.h.

Member Function Documentation

◆ dump_config()

void esphome::spi::SPIComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 67 of file spi.cpp.

◆ get_bus()

SPIBus * esphome::spi::SPIComponent::get_bus ( SPIInterface  interface,
GPIOPin clk,
GPIOPin sdo,
GPIOPin sdi,
const std::vector< uint8_t > &  data_pins 
)
staticprotected

Definition at line 88 of file spi_arduino.cpp.

◆ get_setup_priority()

float esphome::spi::SPIComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 348 of file spi.h.

◆ register_device()

SPIDelegate * esphome::spi::SPIComponent::register_device ( SPIClient device,
SPIMode  mode,
SPIBitOrder  bit_order,
uint32_t  data_rate,
GPIOPin cs_pin 
)

Definition at line 18 of file spi.cpp.

◆ set_clk()

void esphome::spi::SPIComponent::set_clk ( GPIOPin clk)
inline

Definition at line 334 of file spi.h.

◆ set_data_pins()

void esphome::spi::SPIComponent::set_data_pins ( std::vector< uint8_t >  pins)
inline

Definition at line 339 of file spi.h.

◆ set_interface()

void esphome::spi::SPIComponent::set_interface ( SPIInterface  interface)
inline

Definition at line 341 of file spi.h.

◆ set_interface_name()

void esphome::spi::SPIComponent::set_interface_name ( const char *  name)
inline

Definition at line 346 of file spi.h.

◆ set_miso()

void esphome::spi::SPIComponent::set_miso ( GPIOPin sdi)
inline

Definition at line 336 of file spi.h.

◆ set_mosi()

void esphome::spi::SPIComponent::set_mosi ( GPIOPin sdo)
inline

Definition at line 338 of file spi.h.

◆ setup()

void esphome::spi::SPIComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 38 of file spi.cpp.

◆ unregister_device()

void esphome::spi::SPIComponent::unregister_device ( SPIClient device)

Definition at line 29 of file spi.cpp.

Field Documentation

◆ clk_pin_

GPIOPin* esphome::spi::SPIComponent::clk_pin_ {nullptr}
protected

Definition at line 354 of file spi.h.

◆ data_pins_

std::vector<uint8_t> esphome::spi::SPIComponent::data_pins_ {}
protected

Definition at line 357 of file spi.h.

◆ devices_

std::map<SPIClient *, SPIDelegate *> esphome::spi::SPIComponent::devices_
protected

Definition at line 363 of file spi.h.

◆ interface_

SPIInterface esphome::spi::SPIComponent::interface_ {}
protected

Definition at line 359 of file spi.h.

◆ interface_name_

const char* esphome::spi::SPIComponent::interface_name_ {nullptr}
protected

Definition at line 361 of file spi.h.

◆ sdi_pin_

GPIOPin* esphome::spi::SPIComponent::sdi_pin_ {nullptr}
protected

Definition at line 355 of file spi.h.

◆ sdo_pin_

GPIOPin* esphome::spi::SPIComponent::sdo_pin_ {nullptr}
protected

Definition at line 356 of file spi.h.

◆ spi_bus_

SPIBus* esphome::spi::SPIComponent::spi_bus_ {}
protected

Definition at line 362 of file spi.h.

◆ using_hw_

bool esphome::spi::SPIComponent::using_hw_ {false}
protected

Definition at line 360 of file spi.h.


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