homeassistant.components.remember_the_milk Namespace Reference

Namespaces
	entity

Classes
class	RememberTheMilkConfiguration

Functions
def	_create_instance (hass, account_name, api_key, shared_secret, token, stored_rtm_config, component)
def	_register_new_account (hass, account_name, api_key, shared_secret, stored_rtm_config, component)
bool	setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_ID_MAP = "id_map"
string	CONF_LIST_ID = "list_id"
string	CONF_SHARED_SECRET = "shared_secret"
string	CONF_TASK_ID = "task_id"
string	CONF_TIMESERIES_ID = "timeseries_id"
string	CONFIG_FILE_NAME = ".remember_the_milk.conf"
	CONFIG_SCHEMA
string	DEFAULT_NAME = DOMAIN
string	DOMAIN = "remember_the_milk"
	RTM_SCHEMA
string	SERVICE_COMPLETE_TASK = "complete_task"
string	SERVICE_CREATE_TASK = "create_task"
	SERVICE_SCHEMA_COMPLETE_TASK = vol.Schema({vol.Required(CONF_ID): cv.string})
	SERVICE_SCHEMA_CREATE_TASK

Detailed Description

Support to interact with Remember The Milk.

Function Documentation

_create_instance()

def homeassistant.components.remember_the_milk._create_instance (   hass,   account_name,   api_key,   shared_secret,   token,   stored_rtm_config,   component  )

private

Definition at line 86 of file __init__.py.

_register_new_account()

def homeassistant.components.remember_the_milk._register_new_account (   hass,   account_name,   api_key,   shared_secret,   stored_rtm_config,   component  )

private

Definition at line 107 of file __init__.py.

setup()

bool homeassistant.components.remember_the_milk.setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Remember the milk component.

Definition at line 55 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.remember_the_milk._LOGGER = logging.getLogger(__name__)

private

Definition at line 21 of file __init__.py.

CONF_ID_MAP

string homeassistant.components.remember_the_milk.CONF_ID_MAP = "id_map"

Definition at line 27 of file __init__.py.

CONF_LIST_ID

string homeassistant.components.remember_the_milk.CONF_LIST_ID = "list_id"

Definition at line 28 of file __init__.py.

CONF_SHARED_SECRET

string homeassistant.components.remember_the_milk.CONF_SHARED_SECRET = "shared_secret"

Definition at line 26 of file __init__.py.

CONF_TASK_ID

string homeassistant.components.remember_the_milk.CONF_TASK_ID = "task_id"

Definition at line 30 of file __init__.py.

CONF_TIMESERIES_ID

string homeassistant.components.remember_the_milk.CONF_TIMESERIES_ID = "timeseries_id"

Definition at line 29 of file __init__.py.

CONFIG_FILE_NAME

string homeassistant.components.remember_the_milk.CONFIG_FILE_NAME = ".remember_the_milk.conf"

Definition at line 44 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.remember_the_milk.CONFIG_SCHEMA

Initial value:

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

Definition at line 40 of file __init__.py.

DEFAULT_NAME

string homeassistant.components.remember_the_milk.DEFAULT_NAME = DOMAIN

Definition at line 24 of file __init__.py.

DOMAIN

string homeassistant.components.remember_the_milk.DOMAIN = "remember_the_milk"

Definition at line 23 of file __init__.py.

RTM_SCHEMA

homeassistant.components.remember_the_milk.RTM_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Required(CONF_API_KEY): cv.string,
        vol.Required(CONF_SHARED_SECRET): cv.string,
    }
)

Definition at line 32 of file __init__.py.

SERVICE_COMPLETE_TASK

string homeassistant.components.remember_the_milk.SERVICE_COMPLETE_TASK = "complete_task"

Definition at line 46 of file __init__.py.

SERVICE_CREATE_TASK

string homeassistant.components.remember_the_milk.SERVICE_CREATE_TASK = "create_task"

Definition at line 45 of file __init__.py.

SERVICE_SCHEMA_COMPLETE_TASK

homeassistant.components.remember_the_milk.SERVICE_SCHEMA_COMPLETE_TASK = vol.Schema({vol.Required(CONF_ID): cv.string})

Definition at line 52 of file __init__.py.

SERVICE_SCHEMA_CREATE_TASK

homeassistant.components.remember_the_milk.SERVICE_SCHEMA_CREATE_TASK

Initial value:

=  vol.Schema(
    {vol.Required(CONF_NAME): cv.string, vol.Optional(CONF_ID): cv.string}
)

Definition at line 48 of file __init__.py.