homeassistant.helpers.entity_registry.RegistryEntry Class Reference

Inheritance diagram for homeassistant.helpers.entity_registry.RegistryEntry:

Public Member Functions
dict[str, Any]	as_partial_dict (self)
json_fragment	as_storage_fragment (self)
bool	disabled (self)
bytes|None	display_json_repr (self)
dict[str, Any]	extended_dict (self)
bool	hidden (self)
bytes|None	partial_json_repr (self)
None	write_unavailable_state (self, HomeAssistant hass)

Public Attributes
	domain

Static Public Attributes
	bool
	converter
	datetime
	default
	dict
	eq
	factory
	False
	init
	int
	None
	ReadOnlyEntityOptionsType
	repr
	str

Private Member Functions
dict[str, Any]|None	_as_display_dict (self)
str	_domain_default (self)

Detailed Description

Entity Registry Entry.

Definition at line 170 of file entity_registry.py.

Member Function Documentation

_as_display_dict()

dict[str, Any] | None homeassistant.helpers.entity_registry.RegistryEntry._as_display_dict (   self )

private

Return a partial dict representation of the entry.

This version only includes what's needed for display.
Returns None if there's no data needed for display.

Definition at line 226 of file entity_registry.py.

_domain_default()

str homeassistant.helpers.entity_registry.RegistryEntry._domain_default (   self )

private

Compute domain value.

Definition at line 211 of file entity_registry.py.

as_partial_dict()

dict[str, Any] homeassistant.helpers.entity_registry.RegistryEntry.as_partial_dict

(

self

)

Return a partial dict representation of the entry.

Definition at line 276 of file entity_registry.py.

as_storage_fragment()

json_fragment homeassistant.helpers.entity_registry.RegistryEntry.as_storage_fragment

(

self

)

Return a json fragment for storage.

Definition at line 336 of file entity_registry.py.

disabled()

bool homeassistant.helpers.entity_registry.RegistryEntry.disabled

(

self

)

Return if entry is disabled.

Definition at line 216 of file entity_registry.py.

display_json_repr()

bytes | None homeassistant.helpers.entity_registry.RegistryEntry.display_json_repr

(

self

)

Return a cached partial JSON representation of the entry.

This version only includes what's needed for display.

Definition at line 256 of file entity_registry.py.

extended_dict()

dict[str, Any] homeassistant.helpers.entity_registry.RegistryEntry.extended_dict

(

self

)

Return a extended dict representation of the entry.

Definition at line 305 of file entity_registry.py.

hidden()

bool homeassistant.helpers.entity_registry.RegistryEntry.hidden

(

self

)

Return if entry is hidden.

Definition at line 221 of file entity_registry.py.

partial_json_repr()

bytes | None homeassistant.helpers.entity_registry.RegistryEntry.partial_json_repr

(

self

)

Return a cached partial JSON representation of the entry.

Definition at line 320 of file entity_registry.py.

write_unavailable_state()

None homeassistant.helpers.entity_registry.RegistryEntry.write_unavailable_state	(		self,
		HomeAssistant	hass
	)

Write the unavailable state to the state machine.

Definition at line 374 of file entity_registry.py.

Member Data Documentation

bool

homeassistant.helpers.entity_registry.RegistryEntry.bool

static

Definition at line 194 of file entity_registry.py.

converter

homeassistant.helpers.entity_registry.RegistryEntry.converter

static

Definition at line 192 of file entity_registry.py.

datetime

homeassistant.helpers.entity_registry.RegistryEntry.datetime

static

Definition at line 182 of file entity_registry.py.

default

homeassistant.helpers.entity_registry.RegistryEntry.default

static

Definition at line 176 of file entity_registry.py.

dict

homeassistant.helpers.entity_registry.RegistryEntry.dict

static

Definition at line 208 of file entity_registry.py.

domain

homeassistant.helpers.entity_registry.RegistryEntry.domain

Definition at line 248 of file entity_registry.py.

eq

homeassistant.helpers.entity_registry.RegistryEntry.eq

static

Definition at line 208 of file entity_registry.py.

factory

homeassistant.helpers.entity_registry.RegistryEntry.factory

static

Definition at line 177 of file entity_registry.py.

False

homeassistant.helpers.entity_registry.RegistryEntry.False

static

Definition at line 185 of file entity_registry.py.

init

homeassistant.helpers.entity_registry.RegistryEntry.init

static

Definition at line 185 of file entity_registry.py.

int

homeassistant.helpers.entity_registry.RegistryEntry.int

static

Definition at line 205 of file entity_registry.py.

None

homeassistant.helpers.entity_registry.RegistryEntry.None

static

Definition at line 176 of file entity_registry.py.

ReadOnlyEntityOptionsType

homeassistant.helpers.entity_registry.RegistryEntry.ReadOnlyEntityOptionsType

static

Definition at line 198 of file entity_registry.py.

repr

homeassistant.helpers.entity_registry.RegistryEntry.repr

static

Definition at line 185 of file entity_registry.py.

str

homeassistant.helpers.entity_registry.RegistryEntry.str

static

Definition at line 173 of file entity_registry.py.

---

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

• core/homeassistant/helpers/entity_registry.py