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

Namespaces

 trigger
 

Classes

class  GeolocationEvent
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_DISTANCE = "distance"
 
string ATTR_SOURCE = "source"
 
dictionary CACHED_PROPERTIES_WITH_ATTR_
 
string DOMAIN = "geo_location"
 
string ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
 PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL = timedelta(seconds=60)
 

Detailed Description

Support for Geolocation.

Function Documentation

◆ async_setup()

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

Definition at line 36 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.geo_location.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up a config entry.

Definition at line 45 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.geo_location.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 50 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 20 of file __init__.py.

◆ ATTR_DISTANCE

string homeassistant.components.geo_location.ATTR_DISTANCE = "distance"

Definition at line 29 of file __init__.py.

◆ ATTR_SOURCE

string homeassistant.components.geo_location.ATTR_SOURCE = "source"

Definition at line 30 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.geo_location.CACHED_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "source",
3  "distance",
4  "latitude",
5  "longitude",
6 }

Definition at line 55 of file __init__.py.

◆ DOMAIN

string homeassistant.components.geo_location.DOMAIN = "geo_location"

Definition at line 22 of file __init__.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.geo_location.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 24 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.geo_location.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 25 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.geo_location.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 26 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.geo_location.SCAN_INTERVAL = timedelta(seconds=60)

Definition at line 27 of file __init__.py.