#include <max31865.h>

Inheritance diagram for esphome::max31865::MAX31865Sensor:

Public Member Functions
void	set_reference_resistance (float reference_resistance)

void	set_nominal_resistance (float nominal_resistance)

void	set_filter (MAX31865ConfigFilter filter)

void	set_num_rtd_wires (uint8_t rtd_wires)

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	update () override

Public Member Functions inherited from esphome::sensor::Sensor
	Sensor ()

int8_t	get_accuracy_decimals ()
	Get the accuracy in decimals, using the manual override if set. More...

void	set_accuracy_decimals (int8_t accuracy_decimals)
	Manually set the accuracy in decimals. More...

StateClass	get_state_class ()
	Get the state class, using the manual override if set. More...

void	set_state_class (StateClass state_class)
	Manually set the state class. More...

bool	get_force_update () const
	Get whether force update mode is enabled. More...

void	set_force_update (bool force_update)
	Set force update mode. More...

void	add_filter (Filter *filter)
	Add a filter to the filter chain. Will be appended to the back. More...

void	add_filters (const std::vector< Filter *> &filters)
	Add a list of vectors to the back of the filter chain. More...

void	set_filters (const std::vector< Filter *> &filters)
	Clear the filters and replace them by filters. More...

void	clear_filters ()
	Clear the entire filter chain. More...

float	get_state () const
	Getter-syntax for .state. More...

float	get_raw_state () const
	Getter-syntax for .raw_state. More...

void	publish_state (float state)
	Publish a new state to the front-end. More...

void	add_on_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time a filtered value arrives. More...

void	add_on_raw_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time the sensor sends a raw value. More...

bool	has_state () const
	Return whether this sensor has gotten a full state (that passed through all filters) yet. More...

virtual std::string	unique_id ()
	Override this method to set the unique ID of this sensor. More...

void	internal_send_state_to_frontend (float state)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string	get_unit_of_measurement ()
	Get the unit of measurement, using the manual override if set. More...

void	set_unit_of_measurement (const char *unit_of_measurement)
	Manually set the unit of measurement. More...

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

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

Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_4MHZ >
	SPIDevice ()

	SPIDevice (SPIComponent parent, GPIOPin cs_pin)

void	spi_setup () override

void	spi_teardown () override

void	set_spi_parent (SPIComponent *parent)

void	set_cs_pin (GPIOPin *cs)

void	set_data_rate (uint32_t data_rate)

void	set_bit_order (SPIBitOrder order)

void	set_mode (SPIMode mode)

uint8_t	read_byte ()

void	read_array (uint8_t *data, size_t length)

void	write (uint16_t data, size_t num_bits)
	Write a single data item, up to 32 bits. More...

void	write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)

void	write_byte (uint8_t data)

void	transfer_array (uint8_t *data, size_t length)
	Write the array data, replace with received data. More...

void	transfer_array (std::array< uint8_t, N > &data)

uint8_t	transfer_byte (uint8_t data)

void	write_byte16 (uint16_t data)
	Write 16 bit data. More...

void	write_array16 (const uint16_t *data, size_t length)
	Write an array of data as 16 bit values, byte-swapping if required. More...

void	enable ()

void	disable ()

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)

Public Member Functions inherited from esphome::spi::SPIClient
	SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)

bool	spi_is_ready ()

Protected Member Functions
void	read_data_ ()

void	write_config_ (uint8_t mask, uint8_t bits, uint8_t start_position=0)

void	write_register_ (uint8_t reg, uint8_t value)

uint8_t	read_register_ (uint8_t reg)

uint16_t	read_register_16_ (uint8_t reg)

float	calc_temperature_ (float rtd_ratio)

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

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

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
float	reference_resistance_

float	rtd_nominal_resistance_

MAX31865ConfigFilter	filter_

uint8_t	rtd_wires_

uint8_t	base_config_

bool	has_fault_ = false

bool	has_warn_ = false

Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)>	raw_callback_
	Storage for raw state callbacks. More...

CallbackManager< void(float)>	callback_
	Storage for filtered state callbacks. More...

Filter *	filter_list_ {nullptr}
	Store all active filters. More...

optional< int8_t >	accuracy_decimals_
	Accuracy in decimals override. More...

optional< StateClass >	state_class_ {STATE_CLASS_NONE}
	State class override. More...

bool	force_update_ {false}
	Force update mode. More...

bool	has_state_ {false}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char *	unit_of_measurement_ {nullptr}
	Unit of measurement override. More...

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

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}

Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder	bit_order_ {BIT_ORDER_MSB_FIRST}

SPIMode	mode_ {MODE0}

uint32_t	data_rate_ {1000000}

SPIComponent *	parent_ {nullptr}

GPIOPin *	cs_ {nullptr}

SPIDelegate *	delegate_ {nullptr}

Additional Inherited Members
Data Fields inherited from esphome::sensor::Sensor
float	state
	This member variable stores the last state that has passed through all filters. More...

float	raw_state
	This member variable stores the current raw state of the sensor, without any filters applied. More...

Detailed Description

Definition at line 26 of file max31865.h.

Member Function Documentation

◆ calc_temperature_()

float esphome::max31865::MAX31865Sensor::calc_temperature_ ( float rtd_ratio )

protected

Definition at line 191 of file max31865.cpp.

◆ dump_config()

void esphome::max31865::MAX31865Sensor::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 82 of file max31865.cpp.

◆ get_setup_priority()

float esphome::max31865::MAX31865Sensor::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 92 of file max31865.cpp.

◆ read_data_()

void esphome::max31865::MAX31865Sensor::read_data_ ( )

protected

Definition at line 94 of file max31865.cpp.

◆ read_register_()

uint8_t esphome::max31865::MAX31865Sensor::read_register_ ( uint8_t reg )

protected

Definition at line 171 of file max31865.cpp.

◆ read_register_16_()

uint16_t esphome::max31865::MAX31865Sensor::read_register_16_ ( uint8_t reg )

protected

Definition at line 180 of file max31865.cpp.

◆ set_filter()

void esphome::max31865::MAX31865Sensor::set_filter ( MAX31865ConfigFilter filter )

inline

Definition at line 33 of file max31865.h.

◆ set_nominal_resistance()

void esphome::max31865::MAX31865Sensor::set_nominal_resistance ( float nominal_resistance )

inline

Definition at line 32 of file max31865.h.

◆ set_num_rtd_wires()

void esphome::max31865::MAX31865Sensor::set_num_rtd_wires ( uint8_t rtd_wires )

inline

Definition at line 34 of file max31865.h.

◆ set_reference_resistance()

void esphome::max31865::MAX31865Sensor::set_reference_resistance ( float reference_resistance )

inline

Definition at line 31 of file max31865.h.

◆ setup()

void esphome::max31865::MAX31865Sensor::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 67 of file max31865.cpp.

◆ update()

void esphome::max31865::MAX31865Sensor::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 12 of file max31865.cpp.

◆ write_config_()

void esphome::max31865::MAX31865Sensor::write_config_	(	uint8_t	mask,
		uint8_t	bits,
		uint8_t	start_position = `0`
	)

protected

Definition at line 154 of file max31865.cpp.

◆ write_register_()

void esphome::max31865::MAX31865Sensor::write_register_	(	uint8_t	reg,
		uint8_t	value
	)

protected

Definition at line 163 of file max31865.cpp.

Field Documentation

◆ base_config_

uint8_t esphome::max31865::MAX31865Sensor::base_config_

protected

Definition at line 46 of file max31865.h.

◆ filter_

MAX31865ConfigFilter esphome::max31865::MAX31865Sensor::filter_

protected

Definition at line 44 of file max31865.h.

◆ has_fault_

bool esphome::max31865::MAX31865Sensor::has_fault_ = false

protected

Definition at line 47 of file max31865.h.

◆ has_warn_

bool esphome::max31865::MAX31865Sensor::has_warn_ = false

protected

Definition at line 48 of file max31865.h.

◆ reference_resistance_

float esphome::max31865::MAX31865Sensor::reference_resistance_

protected

Definition at line 42 of file max31865.h.

◆ rtd_nominal_resistance_

float esphome::max31865::MAX31865Sensor::rtd_nominal_resistance_

protected

Definition at line 43 of file max31865.h.

◆ rtd_wires_

uint8_t esphome::max31865::MAX31865Sensor::rtd_wires_

protected

Definition at line 45 of file max31865.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calc_temperature_()

◆ dump_config()

◆ get_setup_priority()

◆ read_data_()

◆ read_register_()

◆ read_register_16_()

◆ set_filter()

◆ set_nominal_resistance()

◆ set_num_rtd_wires()

◆ set_reference_resistance()

◆ setup()

◆ update()

◆ write_config_()

◆ write_register_()

Field Documentation

◆ base_config_

◆ filter_

◆ has_fault_

◆ has_warn_

◆ reference_resistance_

◆ rtd_nominal_resistance_

◆ rtd_wires_