homeassistant.components.scrape Namespace Reference

Namespaces
	config_flow
	const
	coordinator
	sensor

Functions
bool	async_remove_config_entry_device (HomeAssistant hass, ConfigEntry entry, DeviceEntry device)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ScrapeConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	update_listener (HomeAssistant hass, ConfigEntry entry)

Variables
	COMBINED_SCHEMA
	CONFIG_SCHEMA
	ScrapeConfigEntry
	SENSOR_SCHEMA

Detailed Description

The scrape component.

Function Documentation

async_remove_config_entry_device()

bool homeassistant.components.scrape.async_remove_config_entry_device	(	HomeAssistant	hass,
		ConfigEntry	entry,
		DeviceEntry	device
	)

Remove Scrape config entry from a device.

Definition at line 126 of file __init__.py.

async_setup()

bool homeassistant.components.scrape.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Scrape from yaml config.

Definition at line 63 of file __init__.py.

async_setup_entry()

bool homeassistant.components.scrape.async_setup_entry	(	HomeAssistant	hass,
		ScrapeConfigEntry	entry
	)

Set up Scrape from a config entry.

Definition at line 95 of file __init__.py.

async_unload_entry()

bool homeassistant.components.scrape.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload Scrape config entry.

Definition at line 116 of file __init__.py.

update_listener()

None homeassistant.components.scrape.update_listener	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Handle options update.

Definition at line 121 of file __init__.py.

Variable Documentation

COMBINED_SCHEMA

homeassistant.components.scrape.COMBINED_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_SCAN_INTERVAL): cv.time_period,
        **RESOURCE_SCHEMA,
        vol.Optional(SENSOR_DOMAIN): vol.All(
            cv.ensure_list, [vol.Schema(SENSOR_SCHEMA)]
        ),
    }
)

Definition at line 47 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.scrape.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {vol.Optional(DOMAIN): vol.All(cv.ensure_list, [COMBINED_SCHEMA])},
    extra=vol.ALLOW_EXTRA,
)

Definition at line 57 of file __init__.py.

ScrapeConfigEntry

homeassistant.components.scrape.ScrapeConfigEntry

Definition at line 34 of file __init__.py.

SENSOR_SCHEMA

homeassistant.components.scrape.SENSOR_SCHEMA

Initial value:

=  vol.Schema(
    {
        **TEMPLATE_SENSOR_BASE_SCHEMA.schema,
        vol.Optional(CONF_AVAILABILITY): cv.template,
        vol.Optional(CONF_ATTRIBUTE): cv.string,
        vol.Optional(CONF_INDEX, default=0): cv.positive_int,
        vol.Required(CONF_SELECT): cv.string,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
    }
)

Definition at line 36 of file __init__.py.