homeassistant.components.rest_command Namespace Reference

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
	COMMAND_SCHEMA
string	CONF_CONTENT_TYPE = "content_type"
	CONFIG_SCHEMA
string	DEFAULT_METHOD = "get"
int	DEFAULT_TIMEOUT = 10
bool	DEFAULT_VERIFY_SSL = True
string	DOMAIN = "rest_command"
list	SUPPORT_REST_METHODS = ["get", "patch", "post", "put", "delete"]

Detailed Description

Support for exposing regular REST commands as services.

Function Documentation

async_setup()

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

Set up the REST command component.

Definition at line 71 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 40 of file __init__.py.

COMMAND_SCHEMA

homeassistant.components.rest_command.COMMAND_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_URL): cv.template,
        vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.All(
            vol.Lower, vol.In(SUPPORT_REST_METHODS)
        ),
        vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.template}),
        vol.Inclusive(CONF_USERNAME, "authentication"): cv.string,
        vol.Inclusive(CONF_PASSWORD, "authentication"): cv.string,
        vol.Optional(CONF_PAYLOAD): cv.template,
        vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): vol.Coerce(int),
        vol.Optional(CONF_CONTENT_TYPE): cv.string,
        vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
    }
)

Definition at line 50 of file __init__.py.

CONF_CONTENT_TYPE

string homeassistant.components.rest_command.CONF_CONTENT_TYPE = "content_type"

Definition at line 48 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.rest_command.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {DOMAIN: cv.schema_with_slug_keys(COMMAND_SCHEMA)}, extra=vol.ALLOW_EXTRA
)

Definition at line 66 of file __init__.py.

DEFAULT_METHOD

string homeassistant.components.rest_command.DEFAULT_METHOD = "get"

Definition at line 43 of file __init__.py.

DEFAULT_TIMEOUT

int homeassistant.components.rest_command.DEFAULT_TIMEOUT = 10

Definition at line 42 of file __init__.py.

DEFAULT_VERIFY_SSL

bool homeassistant.components.rest_command.DEFAULT_VERIFY_SSL = True

Definition at line 44 of file __init__.py.

DOMAIN

string homeassistant.components.rest_command.DOMAIN = "rest_command"

Definition at line 38 of file __init__.py.

SUPPORT_REST_METHODS

list homeassistant.components.rest_command.SUPPORT_REST_METHODS = ["get", "patch", "post", "put", "delete"]

Definition at line 46 of file __init__.py.