homeassistant.components.snips Namespace Reference

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
def	resolve_slot_values (slot)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_CAN_BE_ENQUEUED = "can_be_enqueued"
string	ATTR_CUSTOM_DATA = "custom_data"
string	ATTR_INTENT_FILTER = "intent_filter"
string	ATTR_SITE_ID = "site_id"
string	ATTR_TEXT = "text"
string	CONF_ACTION = "action"
string	CONF_FEEDBACK = "feedback_sounds"
string	CONF_INTENTS = "intents"
string	CONF_PROBABILITY = "probability_threshold"
string	CONF_SITE_IDS = "site_ids"
	CONFIG_SCHEMA
string	DOMAIN = "snips"
string	FEEDBACK_OFF_TOPIC = "hermes/feedback/sound/toggleOff"
string	FEEDBACK_ON_TOPIC = "hermes/feedback/sound/toggleOn"
	INTENT_SCHEMA
string	INTENT_TOPIC = "hermes/intent/#"
string	SERVICE_FEEDBACK_OFF = "feedback_off"
string	SERVICE_FEEDBACK_ON = "feedback_on"
string	SERVICE_SAY = "say"
string	SERVICE_SAY_ACTION = "say_action"
	SERVICE_SCHEMA_FEEDBACK
	SERVICE_SCHEMA_SAY
	SERVICE_SCHEMA_SAY_ACTION

Detailed Description

Support for Snips on-device ASR and NLU.

Function Documentation

async_setup()

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

Activate Snips component.

Definition at line 92 of file __init__.py.

resolve_slot_values()

def homeassistant.components.snips.resolve_slot_values

(

slot

)

Convert snips builtin types to usable values.

Definition at line 221 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 36 of file __init__.py.

ATTR_CAN_BE_ENQUEUED

string homeassistant.components.snips.ATTR_CAN_BE_ENQUEUED = "can_be_enqueued"

Definition at line 33 of file __init__.py.

ATTR_CUSTOM_DATA

string homeassistant.components.snips.ATTR_CUSTOM_DATA = "custom_data"

Definition at line 32 of file __init__.py.

ATTR_INTENT_FILTER

string homeassistant.components.snips.ATTR_INTENT_FILTER = "intent_filter"

Definition at line 34 of file __init__.py.

ATTR_SITE_ID

string homeassistant.components.snips.ATTR_SITE_ID = "site_id"

Definition at line 31 of file __init__.py.

ATTR_TEXT

string homeassistant.components.snips.ATTR_TEXT = "text"

Definition at line 30 of file __init__.py.

CONF_ACTION

string homeassistant.components.snips.CONF_ACTION = "action"

Definition at line 16 of file __init__.py.

CONF_FEEDBACK

string homeassistant.components.snips.CONF_FEEDBACK = "feedback_sounds"

Definition at line 17 of file __init__.py.

CONF_INTENTS

string homeassistant.components.snips.CONF_INTENTS = "intents"

Definition at line 15 of file __init__.py.

CONF_PROBABILITY

string homeassistant.components.snips.CONF_PROBABILITY = "probability_threshold"

Definition at line 18 of file __init__.py.

CONF_SITE_IDS

string homeassistant.components.snips.CONF_SITE_IDS = "site_ids"

Definition at line 19 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.snips.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Optional(CONF_FEEDBACK): cv.boolean,
                vol.Optional(CONF_PROBABILITY, default=0): vol.Coerce(float),
                vol.Optional(CONF_SITE_IDS, default=["default"]): vol.All(
                    cv.ensure_list, [cv.string]
                ),
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 38 of file __init__.py.

DOMAIN

string homeassistant.components.snips.DOMAIN = "snips"

Definition at line 14 of file __init__.py.

FEEDBACK_OFF_TOPIC

string homeassistant.components.snips.FEEDBACK_OFF_TOPIC = "hermes/feedback/sound/toggleOff"

Definition at line 28 of file __init__.py.

FEEDBACK_ON_TOPIC

string homeassistant.components.snips.FEEDBACK_ON_TOPIC = "hermes/feedback/sound/toggleOn"

Definition at line 27 of file __init__.py.

INTENT_SCHEMA

homeassistant.components.snips.INTENT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required("input"): str,
        vol.Required("intent"): {vol.Required("intentName"): str},
        vol.Optional("slots"): [
            {
                vol.Required("slotName"): str,
                vol.Required("value"): {
                    vol.Required("kind"): str,
                    vol.Optional("value"): cv.match_all,
                    vol.Optional("rawValue"): cv.match_all,
                },
            }
        ],
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 53 of file __init__.py.

INTENT_TOPIC

string homeassistant.components.snips.INTENT_TOPIC = "hermes/intent/#"

Definition at line 26 of file __init__.py.

SERVICE_FEEDBACK_OFF

string homeassistant.components.snips.SERVICE_FEEDBACK_OFF = "feedback_off"

Definition at line 24 of file __init__.py.

SERVICE_FEEDBACK_ON

string homeassistant.components.snips.SERVICE_FEEDBACK_ON = "feedback_on"

Definition at line 23 of file __init__.py.

SERVICE_SAY

string homeassistant.components.snips.SERVICE_SAY = "say"

Definition at line 21 of file __init__.py.

SERVICE_SAY_ACTION

string homeassistant.components.snips.SERVICE_SAY_ACTION = "say_action"

Definition at line 22 of file __init__.py.

SERVICE_SCHEMA_FEEDBACK

homeassistant.components.snips.SERVICE_SCHEMA_FEEDBACK

Initial value:

=  vol.Schema(
    {vol.Optional(ATTR_SITE_ID, default="default"): str}
)

Definition at line 87 of file __init__.py.

SERVICE_SCHEMA_SAY

homeassistant.components.snips.SERVICE_SCHEMA_SAY

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_TEXT): str,
        vol.Optional(ATTR_SITE_ID, default="default"): str,
        vol.Optional(ATTR_CUSTOM_DATA, default=""): str,
    }
)

Definition at line 71 of file __init__.py.

SERVICE_SCHEMA_SAY_ACTION

homeassistant.components.snips.SERVICE_SCHEMA_SAY_ACTION

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_TEXT): str,
        vol.Optional(ATTR_SITE_ID, default="default"): str,
        vol.Optional(ATTR_CUSTOM_DATA, default=""): str,
        vol.Optional(ATTR_CAN_BE_ENQUEUED, default=True): cv.boolean,
        vol.Optional(ATTR_INTENT_FILTER): vol.All(cv.ensure_list),
    }
)

Definition at line 78 of file __init__.py.