mycroft.skills.common_iot_skill.IoTRequest Class Reference

Public Member Functions
def	__init__
def	__repr__ (self)
def	from_dict
def	to_dict (self)
def	version (self)

Public Attributes
	action
	attribute
	entity
	scene
	thing
	value

Detailed Description

This class represents a request from a user to control
an IoT device. It contains all of the information an IoT
skill should need in order to determine if it can handle
a user's request. The information is supplied as properties
on the request. At present, those properties are:

action (see the Action enum above)
thing (see the Thing enum above)
entity
scene
value

The 'action' is mandatory, and will always be not None. The
other fields may be None.

The 'entity' is intended to be used for user-defined values
specific to a skill. For example, in a skill controlling Lights,
an 'entity' might represent a group of lights. For a smart-lock
skill, it might represent a specific lock, e.g. 'front door.'

The 'scene' value is also intended to to be used for user-defined
values. Skills that extend CommonIotSkill are expected to register
their own scenes. The controller skill will have the ability to
trigger multiple skills, so common scene names may trigger many
skills, for a coherent experience.

The 'value' property will be a number value. This is intended to
be used for requests such as "set the heat to 70 degrees" and
"set the lights to 50% brightness."

Skills that extend CommonIotSkill will be expected to register
their own entities. See the documentation in CommonIotSkill for
more details.

Definition at line 146 of file common_iot_skill.py.

Constructor & Destructor Documentation

def mycroft.skills.common_iot_skill.IoTRequest.__init__	(		self,
			action
	)

Definition at line 184 of file common_iot_skill.py.

Member Function Documentation

def mycroft.skills.common_iot_skill.IoTRequest.__repr__

(

self

)

Definition at line 202 of file common_iot_skill.py.

def mycroft.skills.common_iot_skill.IoTRequest.from_dict	(		cls,
			data
	)

Definition at line 237 of file common_iot_skill.py.

def mycroft.skills.common_iot_skill.IoTRequest.to_dict

(

self

)

Definition at line 226 of file common_iot_skill.py.

def mycroft.skills.common_iot_skill.IoTRequest.version

(

self

)

Definition at line 221 of file common_iot_skill.py.

Member Data Documentation

mycroft.skills.common_iot_skill.IoTRequest.action

Definition at line 195 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequest.attribute

Definition at line 197 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequest.entity

Definition at line 198 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequest.scene

Definition at line 199 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequest.thing

Definition at line 196 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequest.value

Definition at line 200 of file common_iot_skill.py.

---

The documentation for this class was generated from the following file:

• common_iot_skill.py