#include <power_switch.h>

Inheritance diagram for esphome::pcm5122::PCM5122PowerSwitch:

Public Member Functions
void	set_power_mode (PCM5122PowerSwitchMode mode)

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.

void	control (bool target_state)
	Control this switch using a boolean state value.

void	turn_on ()
	Turn this switch on.

void	turn_off ()
	Turn this switch off.

void	toggle ()
	Toggle this switch.

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

template<typename F >
void	add_on_state_callback (F &&callback)
	Set callback for state changes.

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

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

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

bool	is_inverted () const

void	set_restore_mode (SwitchRestoreMode restore_mode)

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

bool	has_own_name () const

uint32_t	get_object_id_hash () const

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

	ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal)

bool	is_disabled_by_default () const

EntityCategory	get_entity_category () const

const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const

template<typename T = int>
StringRef	get_device_class_ref () const

template<typename T = int>
std::string	get_device_class () const

	ESPDEPRECATED ("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_device_class_ref() const

ESPDEPRECATED("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std StringRef	get_unit_of_measurement_ref () const

ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
	Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())

template<typename T = int>
StringRef	get_icon_ref () const

template<typename T = int>
std::string	get_icon () const

	ESPDEPRECATED ("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_icon_ref() const

ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t	get_device_id () const

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

Public Member Functions inherited from esphome::Parented< PCM5122 >
	Parented ()

	Parented (PCM5122 *parent)

PCM5122 *	get_parent () const
	Get the parent of this object.

void	set_parent (PCM5122 *parent)
	Set the parent of this object.

Protected Member Functions
void	write_state (bool state) override

Protected Member Functions inherited from esphome::switch_::Switch
Protected Member Functions inherited from esphome::EntityBase
friend	void::setup ()

friend	void::original_setup ()

void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.

void	set_device_ (Device *device)

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.

void	calc_object_id_ ()

Protected Attributes
PCM5122PowerSwitchMode	mode_ {PCM5122_POWER_SWITCH_MODE_POWERDOWN}

Protected Attributes inherited from esphome::switch_::Switch
ESPPreferenceObject	rtc_

LazyCallbackManager< void(bool)>	state_callback_ {}

Deduplicator< bool >	publish_dedup_

bool	inverted_ {false}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

uint8_t	device_class_idx_ {}

uint8_t	uom_idx_ {}

uint8_t	icon_idx_ {}

Protected Attributes inherited from esphome::Parented< PCM5122 >
PCM5122 *	parent_

Additional Inherited Members
Data Fields inherited from esphome::switch_::Switch
SwitchRestoreMode	restore_mode {SWITCH_RESTORE_DEFAULT_OFF}
	Indicates whether or not state is to be retrieved from flash and how.

bool	state
	The current reported state of the binary sensor.

Detailed Description

Definition at line 14 of file power_switch.h.

Member Function Documentation

◆ set_power_mode()

void esphome::pcm5122::PCM5122PowerSwitch::set_power_mode ( PCM5122PowerSwitchMode mode )

inline

Definition at line 16 of file power_switch.h.

◆ write_state()

void esphome::pcm5122::PCM5122PowerSwitch::write_state ( bool state )

overrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 5 of file power_switch.cpp.

Field Documentation

◆ mode_

PCM5122PowerSwitchMode esphome::pcm5122::PCM5122PowerSwitch::mode_ {PCM5122_POWER_SWITCH_MODE_POWERDOWN}

protected

Definition at line 21 of file power_switch.h.

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

esphome/components/pcm5122/switch/power_switch.h
esphome/components/pcm5122/switch/power_switch.cpp

Public Member Functions

Protected Member Functions