#include <nextion_switch.h>

Inheritance diagram for esphome::nextion::NextionSwitch:

Public Member Functions
	NextionSwitch (NextionBase *nextion)

void	update () override

void	update_component () override

void	process_bool (const std::string &variable_name, bool on) override

void	set_state (bool state) override

void	set_state (bool state, bool publish) override

void	set_state (bool state, bool publish, bool send_to_nextion) override

void	send_state_to_nextion () override

NextionQueueType	get_queue_type () override

void	set_state_from_string (const std::string &state_value, bool publish, bool send_to_nextion) override

void	set_state_from_int (int state_value, bool publish, bool send_to_nextion) override

Public Member Functions inherited from esphome::nextion::NextionComponent
void	update_component_settings () override

void	update_component_settings (bool force_update) override

void	set_background_color (Color bco)

void	set_background_pressed_color (Color bco2)

void	set_foreground_color (Color pco)

void	set_foreground_pressed_color (Color pco2)

void	set_font_id (uint8_t font_id)

void	set_visible (bool visible)

Public Member Functions inherited from esphome::nextion::NextionComponentBase
virtual	~NextionComponentBase ()=default

void	set_variable_name (const std::string &variable_name, const std::string &variable_name_to_send="")

virtual void	process_sensor (const std::string &variable_name, int state)

virtual void	process_touch (uint8_t page_id, uint8_t component_id, bool on)

virtual void	process_text (const std::string &variable_name, const std::string &text_value)

virtual void	set_state (float state)

virtual void	set_state (float state, bool publish)

virtual void	set_state (float state, bool publish, bool send_to_nextion)

virtual void	set_state (const std::string &state)

virtual void	set_state (const std::string &state, bool publish)

virtual void	set_state (const std::string &state, bool publish, bool send_to_nextion)

uint8_t	get_component_id ()

void	set_component_id (uint8_t component_id)

uint8_t	get_wave_channel_id ()

void	set_wave_channel_id (uint8_t wave_chan_id)

std::vector< uint8_t >	get_wave_buffer ()

size_t	get_wave_buffer_size ()

void	clear_wave_buffer (size_t buffer_sent)

std::string	get_variable_name ()

std::string	get_variable_name_to_send ()

virtual std::string	get_queue_type_string ()

bool	get_needs_to_send_update ()

uint8_t	get_wave_chan_id ()

void	set_wave_max_length (int wave_max_length)

Public Member Functions inherited from esphome::switch_::Switch
	Switch ()

void	publish_state (bool state)
	Publish a state to the front-end from the back-end. More...

void	turn_on ()
	Turn this switch on. More...

void	turn_off ()
	Turn this switch off. More...

void	toggle ()
	Toggle this switch. More...

void	set_inverted (bool inverted)
	Set whether the state should be treated as inverted. More...

void	add_on_state_callback (std::function< void(bool)> &&callback)
	Set callback for state changes. More...

optional< bool >	get_initial_state ()
	Returns the initial state of the switch, as persisted previously, or empty if never persisted. More...

optional< bool >	get_initial_state_with_restore_mode ()
	Returns the initial state of the switch, after applying restore mode rules. More...

virtual bool	assumed_state ()
	Return whether this switch uses an assumed state - i.e. More...

bool	is_inverted () const

void	set_restore_mode (SwitchRestoreMode restore_mode)

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::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	setup ()
	Where the component's initialization should happen. More...

virtual void	loop ()
	This method will be called repeatedly. More...

virtual void	dump_config ()

virtual float	get_setup_priority () const
	priority of setup(). 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...

Protected Member Functions
void	write_state (bool state) override

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

Additional Inherited Members
Data Fields inherited from esphome::switch_::Switch
bool	state
	The current reported state of the binary sensor. More...

SwitchRestoreMode	restore_mode {SWITCH_RESTORE_DEFAULT_OFF}
	Indicates whether or not state is to be retrieved from flash and how. More...

Protected Attributes inherited from esphome::nextion::NextionComponent
NextionBase *	nextion_

bool	bco_needs_update_ = false

bool	bco_is_set_ = false

Color	bco_

bool	bco2_needs_update_ = false

bool	bco2_is_set_ = false

Color	bco2_

bool	pco_needs_update_ = false

bool	pco_is_set_ = false

Color	pco_

bool	pco2_needs_update_ = false

bool	pco2_is_set_ = false

Color	pco2_

uint8_t	font_id_ = 0

bool	font_id_needs_update_ = false

bool	font_id_is_set_ = false

bool	visible_ = true

bool	visible_needs_update_ = false

bool	visible_is_set_ = false

Protected Attributes inherited from esphome::nextion::NextionComponentBase
std::string	variable_name_

std::string	variable_name_to_send_

uint8_t	component_id_ = 0

uint8_t	wave_chan_id_ = UINT8_MAX

std::vector< uint8_t >	wave_buffer_

int	wave_max_length_ = 255

bool	needs_to_send_update_

Protected Attributes inherited from esphome::switch_::Switch
CallbackManager< void(bool)>	state_callback_ {}

bool	inverted_ {false}

Deduplicator< bool >	publish_dedup_

ESPPreferenceObject	rtc_

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::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}

Detailed Description

Definition at line 11 of file nextion_switch.h.

Constructor & Destructor Documentation

◆ NextionSwitch()

esphome::nextion::NextionSwitch::NextionSwitch ( NextionBase * nextion )

inline

Definition at line 13 of file nextion_switch.h.

Member Function Documentation

◆ get_queue_type()

NextionQueueType esphome::nextion::NextionSwitch::get_queue_type ( )

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 24 of file nextion_switch.h.

◆ process_bool()

void esphome::nextion::NextionSwitch::process_bool	(	const std::string &	variable_name,
		bool	on
	)

overridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 10 of file nextion_switch.cpp.

◆ send_state_to_nextion()

void esphome::nextion::NextionSwitch::send_state_to_nextion ( )

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 23 of file nextion_switch.h.

◆ set_state() [1/3]

void esphome::nextion::NextionSwitch::set_state ( bool state )

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 19 of file nextion_switch.h.

◆ set_state() [2/3]

void esphome::nextion::NextionSwitch::set_state	(	bool	state,
		bool	publish
	)

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 20 of file nextion_switch.h.

◆ set_state() [3/3]

void esphome::nextion::NextionSwitch::set_state	(	bool	state,
		bool	publish,
		bool	send_to_nextion
	)

overridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 26 of file nextion_switch.cpp.

◆ set_state_from_int()

void esphome::nextion::NextionSwitch::set_state_from_int	(	int	state_value,
		bool	publish,
		bool	send_to_nextion
	)

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 26 of file nextion_switch.h.

◆ set_state_from_string()

void esphome::nextion::NextionSwitch::set_state_from_string	(	const std::string &	state_value,
		bool	publish,
		bool	send_to_nextion
	)

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 25 of file nextion_switch.h.

◆ update()

void esphome::nextion::NextionSwitch::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 20 of file nextion_switch.cpp.

◆ update_component()

void esphome::nextion::NextionSwitch::update_component ( )

inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 16 of file nextion_switch.h.

◆ write_state()

void esphome::nextion::NextionSwitch::write_state ( bool state )

overrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 49 of file nextion_switch.cpp.

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

/opt/build/esphome/esphome/components/nextion/switch/nextion_switch.h
/opt/build/esphome/esphome/components/nextion/switch/nextion_switch.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NextionSwitch()

Member Function Documentation

◆ get_queue_type()

◆ process_bool()

◆ send_state_to_nextion()

◆ set_state() [1/3]

◆ set_state() [2/3]

◆ set_state() [3/3]

◆ set_state_from_int()

◆ set_state_from_string()

◆ update()

◆ update_component()

◆ write_state()