Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tag Namespace Reference

Namespaces

 const
 
 trigger
 

Classes

class  TagDictStorageCollectionWebsocket
 
class  TagEntity
 
class  TagIDExistsError
 
class  TagIDManager
 
class  TagStorageCollection
 
class  TagStore
 

Functions

er.RegistryEntry _create_entry (er.EntityRegistry entity_registry, str tag_id, str|None name)
 
None async_scan_tag (HomeAssistant hass, str tag_id, str|None device_id, Context|None context=None)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
 
string LAST_SCANNED = "last_scanned"
 
string LAST_SCANNED_BY_DEVICE_ID = "last_scanned_by_device_id"
 
 STORAGE_KEY = DOMAIN
 
int STORAGE_VERSION = 1
 
int STORAGE_VERSION_MINOR = 3
 
 VolDictType
 

Detailed Description

The Tag integration.

Function Documentation

◆ _create_entry()

er.RegistryEntry homeassistant.components.tag._create_entry ( er.EntityRegistry  entity_registry,
str  tag_id,
str | None   name 
)
private
Create an entity registry entry for a tag.

Definition at line 76 of file __init__.py.

◆ async_scan_tag()

None homeassistant.components.tag.async_scan_tag ( HomeAssistant  hass,
str  tag_id,
str | None  device_id,
Context | None   context = None 
)
Handle when a tag is scanned.

Definition at line 322 of file __init__.py.

◆ async_setup()

bool homeassistant.components.tag.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Tag component.

Definition at line 230 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.tag._LOGGER = logging.getLogger(__name__)
private

Definition at line 28 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.tag.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 53 of file __init__.py.

◆ LAST_SCANNED

string homeassistant.components.tag.LAST_SCANNED = "last_scanned"

Definition at line 30 of file __init__.py.

◆ LAST_SCANNED_BY_DEVICE_ID

string homeassistant.components.tag.LAST_SCANNED_BY_DEVICE_ID = "last_scanned_by_device_id"

Definition at line 31 of file __init__.py.

◆ STORAGE_KEY

homeassistant.components.tag.STORAGE_KEY = DOMAIN

Definition at line 32 of file __init__.py.

◆ STORAGE_VERSION

int homeassistant.components.tag.STORAGE_VERSION = 1

Definition at line 33 of file __init__.py.

◆ STORAGE_VERSION_MINOR

int homeassistant.components.tag.STORAGE_VERSION_MINOR = 3

Definition at line 34 of file __init__.py.

◆ VolDictType

homeassistant.components.tag.VolDictType

Definition at line 38 of file __init__.py.