homeassistant.components.recorder.services Namespace Reference

Functions
None	_async_register_disable_service (HomeAssistant hass, Recorder instance)
None	_async_register_enable_service (HomeAssistant hass, Recorder instance)
None	_async_register_purge_entities_service (HomeAssistant hass, Recorder instance)
None	_async_register_purge_service (HomeAssistant hass, Recorder instance)
None	async_register_services (HomeAssistant hass, Recorder instance)

Variables
string	ATTR_DOMAINS = "domains"
string	ATTR_ENTITY_GLOBS = "entity_globs"
string	SERVICE_DISABLE = "disable"
	SERVICE_DISABLE_SCHEMA = vol.Schema({})
string	SERVICE_ENABLE = "enable"
	SERVICE_ENABLE_SCHEMA = vol.Schema({})
string	SERVICE_PURGE = "purge"
string	SERVICE_PURGE_ENTITIES = "purge_entities"
	SERVICE_PURGE_ENTITIES_SCHEMA
	SERVICE_PURGE_SCHEMA

Detailed Description

Support for recorder services.

Function Documentation

_async_register_disable_service()

None homeassistant.components.recorder.services._async_register_disable_service ( HomeAssistant  hass, Recorder  instance  )

private

Definition at line 125 of file services.py.

_async_register_enable_service()

None homeassistant.components.recorder.services._async_register_enable_service ( HomeAssistant  hass, Recorder  instance  )

private

Definition at line 111 of file services.py.

_async_register_purge_entities_service()

None homeassistant.components.recorder.services._async_register_purge_entities_service ( HomeAssistant  hass, Recorder   instance  )

private

Definition at line 88 of file services.py.

_async_register_purge_service()

None homeassistant.components.recorder.services._async_register_purge_service ( HomeAssistant  hass, Recorder  instance  )

private

Definition at line 68 of file services.py.

async_register_services()

None homeassistant.components.recorder.services.async_register_services	(	HomeAssistant	hass,
		Recorder	instance
	)

Register recorder services.

Definition at line 139 of file services.py.

Variable Documentation

ATTR_DOMAINS

string homeassistant.components.recorder.services.ATTR_DOMAINS = "domains"

Definition at line 37 of file services.py.

ATTR_ENTITY_GLOBS

string homeassistant.components.recorder.services.ATTR_ENTITY_GLOBS = "entity_globs"

Definition at line 38 of file services.py.

SERVICE_DISABLE

string homeassistant.components.recorder.services.SERVICE_DISABLE = "disable"

Definition at line 27 of file services.py.

SERVICE_DISABLE_SCHEMA

homeassistant.components.recorder.services.SERVICE_DISABLE_SCHEMA = vol.Schema({})

Definition at line 64 of file services.py.

SERVICE_ENABLE

string homeassistant.components.recorder.services.SERVICE_ENABLE = "enable"

Definition at line 26 of file services.py.

SERVICE_ENABLE_SCHEMA

homeassistant.components.recorder.services.SERVICE_ENABLE_SCHEMA = vol.Schema({})

Definition at line 63 of file services.py.

SERVICE_PURGE

string homeassistant.components.recorder.services.SERVICE_PURGE = "purge"

Definition at line 24 of file services.py.

SERVICE_PURGE_ENTITIES

string homeassistant.components.recorder.services.SERVICE_PURGE_ENTITIES = "purge_entities"

Definition at line 25 of file services.py.

SERVICE_PURGE_ENTITIES_SCHEMA

homeassistant.components.recorder.services.SERVICE_PURGE_ENTITIES_SCHEMA

Initial value:

=  vol.All(
    vol.Schema(
        {
            vol.Optional(ATTR_ENTITY_ID, default=[]): cv.entity_ids,
            vol.Optional(ATTR_DOMAINS, default=[]): vol.All(
                cv.ensure_list, [cv.string]
            ),
            vol.Optional(ATTR_ENTITY_GLOBS, default=[]): vol.All(
                cv.ensure_list, [cv.string]
            ),
            vol.Optional(ATTR_KEEP_DAYS, default=0): cv.positive_int,
        }
    ),
    vol.Any(
        vol.Schema({vol.Required(ATTR_ENTITY_ID): vol.IsTrue()}, extra=vol.ALLOW_EXTRA),
        vol.Schema({vol.Required(ATTR_DOMAINS): vol.IsTrue()}, extra=vol.ALLOW_EXTRA),
        vol.Schema(
            {vol.Required(ATTR_ENTITY_GLOBS): vol.IsTrue()}, extra=vol.ALLOW_EXTRA
        ),
        msg="At least one of entity_id, domains, or entity_globs must have a value",
    ),
)

Definition at line 40 of file services.py.

SERVICE_PURGE_SCHEMA

homeassistant.components.recorder.services.SERVICE_PURGE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(ATTR_KEEP_DAYS): cv.positive_int,
        vol.Optional(ATTR_REPACK, default=False): cv.boolean,
        vol.Optional(ATTR_APPLY_FILTER, default=False): cv.boolean,
    }
)

Definition at line 29 of file services.py.