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

Namespaces

 api
 
 application_credentials
 
 camera
 
 climate
 
 config_flow
 
 const
 
 device_info
 
 device_trigger
 
 diagnostics
 
 event
 
 events
 
 media_source
 
 sensor
 

Classes

class  NestEventMediaThumbnailView
 
class  NestEventMediaView
 
class  NestEventViewBase
 
class  SignalUpdateCallback
 

Functions

None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
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__)
 
 CONFIG_SCHEMA
 
int EVENT_MEDIA_CACHE_SIZE = 256
 
list PLATFORMS = [Platform.CAMERA, Platform.CLIMATE, Platform.EVENT, Platform.SENSOR]
 
 SENSOR_SCHEMA
 
int THUMBNAIL_SIZE_PX = 175
 

Detailed Description

Support for Nest devices.

Function Documentation

◆ async_remove_entry()

None homeassistant.components.nest.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Handle removal of pubsub subscriptions created during config flow.

Definition at line 274 of file __init__.py.

◆ async_setup()

bool homeassistant.components.nest.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up Nest components with dispatch between old/new flows.

Definition at line 114 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.nest.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Nest from a config entry with dispatch between old/new flows.

Definition at line 194 of file __init__.py.

◆ async_unload_entry()

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

Definition at line 259 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 76 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.nest.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_CLIENT_ID): cv.string,
6  vol.Required(CONF_CLIENT_SECRET): cv.string,
7  # Required to use the new API (optional for compatibility)
8  vol.Optional(CONF_PROJECT_ID): cv.string,
9  vol.Optional(CONF_SUBSCRIBER_ID): cv.string,
10  # Config that only currently works on the old API
11  vol.Optional(CONF_STRUCTURE): vol.All(cv.ensure_list, [cv.string]),
12  vol.Optional(CONF_SENSORS): SENSOR_SCHEMA,
13  vol.Optional(CONF_BINARY_SENSORS): SENSOR_SCHEMA,
14  }
15  )
16  },
17  extra=vol.ALLOW_EXTRA,
18 )

Definition at line 83 of file __init__.py.

◆ EVENT_MEDIA_CACHE_SIZE

int homeassistant.components.nest.EVENT_MEDIA_CACHE_SIZE = 256

Definition at line 109 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.nest.PLATFORMS = [Platform.CAMERA, Platform.CLIMATE, Platform.EVENT, Platform.SENSOR]

Definition at line 103 of file __init__.py.

◆ SENSOR_SCHEMA

homeassistant.components.nest.SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Optional(CONF_MONITORED_CONDITIONS): vol.All(cv.ensure_list)}
3 )

Definition at line 79 of file __init__.py.

◆ THUMBNAIL_SIZE_PX

int homeassistant.components.nest.THUMBNAIL_SIZE_PX = 175

Definition at line 111 of file __init__.py.