#include <uptime_text_sensor.h>

Inheritance diagram for esphome::uptime::UptimeTextSensor:

Public Member Functions
	UptimeTextSensor (const char days_text, const char hours_text, const char minutes_text, const char seconds_text, const char *separator, bool expand)

void	update () override

void	dump_config () override

void	setup () override

float	get_setup_priority () const override

void	set_days (const char *days_text)

void	set_hours (const char *hours_text)

void	set_minutes (const char *minutes_text)

void	set_seconds (const char *seconds_text)

Public Member Functions inherited from esphome::text_sensor::TextSensor
std::string	get_state () const
	Getter-syntax for .state.

std::string	get_raw_state () const
	Getter-syntax for .raw_state.

void	publish_state (const std::string &state)

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

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

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

void	clear_filters ()
	Clear the entire filter chain.

void	add_on_state_callback (std::function< void(std::string)> callback)

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

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

bool	has_state ()

void	internal_send_state_to_frontend (const std::string &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.

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

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

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

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

void	call_setup () override

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

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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

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.

void	mark_failed (const char *message)

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.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	insert_buffer_ (std::string &buffer, const char *key, unsigned value) const

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

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.

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

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

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.

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.

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

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

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

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

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

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

Protected Attributes
const char *	days_text_

const char *	hours_text_

const char *	minutes_text_

const char *	seconds_text_

const char *	separator_

bool	expand_ {}

uint32_t	uptime_ {0}

uint32_t	last_ms_ {0}

Protected Attributes inherited from esphome::text_sensor::TextSensor
CallbackManager< void(std::string)>	raw_callback_
	Storage for raw state callbacks.

CallbackManager< void(std::string)>	callback_
	Storage for filtered state callbacks.

Filter *	filter_list_ {nullptr}
	Store all active filters.

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.

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.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

Additional Inherited Members
Data Fields inherited from esphome::text_sensor::TextSensor
std::string	state

std::string	raw_state

Detailed Description

Definition at line 11 of file uptime_text_sensor.h.

Constructor & Destructor Documentation

◆ UptimeTextSensor()

esphome::uptime::UptimeTextSensor::UptimeTextSensor	(	const char *	days_text,
		const char *	hours_text,
		const char *	minutes_text,
		const char *	seconds_text,
		const char *	separator,
		bool	expand )

inline

Definition at line 13 of file uptime_text_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::uptime::UptimeTextSensor::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 65 of file uptime_text_sensor.cpp.

◆ get_setup_priority()

float esphome::uptime::UptimeTextSensor::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file uptime_text_sensor.cpp.

◆ insert_buffer_()

void esphome::uptime::UptimeTextSensor::insert_buffer_	(	std::string &	buffer,
		const char *	key,
		unsigned	value ) const

protected

Definition at line 19 of file uptime_text_sensor.cpp.

◆ set_days()

void esphome::uptime::UptimeTextSensor::set_days ( const char * days_text )

inline

Definition at line 26 of file uptime_text_sensor.h.

◆ set_hours()

void esphome::uptime::UptimeTextSensor::set_hours ( const char * hours_text )

inline

Definition at line 27 of file uptime_text_sensor.h.

◆ set_minutes()

void esphome::uptime::UptimeTextSensor::set_minutes ( const char * minutes_text )

inline

Definition at line 28 of file uptime_text_sensor.h.

◆ set_seconds()

void esphome::uptime::UptimeTextSensor::set_seconds ( const char * seconds_text )

inline

Definition at line 29 of file uptime_text_sensor.h.

◆ setup()

void esphome::uptime::UptimeTextSensor::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file uptime_text_sensor.cpp.

◆ update()

void esphome::uptime::UptimeTextSensor::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 24 of file uptime_text_sensor.cpp.

Field Documentation

◆ days_text_

const char* esphome::uptime::UptimeTextSensor::days_text_

protected

Definition at line 33 of file uptime_text_sensor.h.

◆ expand_

bool esphome::uptime::UptimeTextSensor::expand_ {}

protected

Definition at line 38 of file uptime_text_sensor.h.

◆ hours_text_

const char* esphome::uptime::UptimeTextSensor::hours_text_

protected

Definition at line 34 of file uptime_text_sensor.h.

◆ last_ms_

uint32_t esphome::uptime::UptimeTextSensor::last_ms_ {0}

protected

Definition at line 40 of file uptime_text_sensor.h.

◆ minutes_text_

const char* esphome::uptime::UptimeTextSensor::minutes_text_

protected

Definition at line 35 of file uptime_text_sensor.h.

◆ seconds_text_

const char* esphome::uptime::UptimeTextSensor::seconds_text_

protected

Definition at line 36 of file uptime_text_sensor.h.

◆ separator_

const char* esphome::uptime::UptimeTextSensor::separator_

protected

Definition at line 37 of file uptime_text_sensor.h.

◆ uptime_

uint32_t esphome::uptime::UptimeTextSensor::uptime_ {0}

protected

Definition at line 39 of file uptime_text_sensor.h.

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

esphome/components/uptime/text_sensor/uptime_text_sensor.h
esphome/components/uptime/text_sensor/uptime_text_sensor.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UptimeTextSensor()

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ insert_buffer_()

◆ set_days()

◆ set_hours()

◆ set_minutes()

◆ set_seconds()

◆ setup()

◆ update()

Field Documentation

◆ days_text_

◆ expand_

◆ hours_text_

◆ last_ms_

◆ minutes_text_

◆ seconds_text_

◆ separator_

◆ uptime_