{"_id":"5845a4aa9f6fbb1b00430830","__v":0,"version":{"_id":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","__v":2,"createdAt":"2016-12-05T17:32:24.708Z","releaseDate":"2016-12-05T17:32:24.708Z","categories":["5845a4a89f6fbb1b004307b8","5845a4a89f6fbb1b004307b9","5845a4a89f6fbb1b004307ba","5845a4a89f6fbb1b004307bb","5845a4a89f6fbb1b004307bc","5845a4a89f6fbb1b004307bd","5845a4a89f6fbb1b004307be","5845a4a89f6fbb1b004307bf","5845a4a89f6fbb1b004307c0","592deb23644f060f008e5aa6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"25.0.0","version":"25"},"parentDoc":null,"user":"55bafe141b0d663700781682","category":{"_id":"5845a4a89f6fbb1b004307be","project":"54d3007669578e0d002730c9","__v":0,"version":"5845a4a89f6fbb1b004307b7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-30T07:08:52.789Z","from_sync":false,"order":6,"slug":"domains","title":"Domains (Deprecated)"},"project":"54d3007669578e0d002730c9","updates":["582f81088ea0800f0035639b"],"next":{"pages":[],"description":""},"createdAt":"2015-08-05T15:36:04.833Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":23,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Domains are being deprecated\",\n  \"body\": \"Domains are being deprecated. If you're currently using domains, please consider using our new [Prebuilt Agents](https://docs.api.ai/docs/prebuilt-agents).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This domain is supported in the following languages:\\n* English\"\n}\n[/block]\n* [Smart Home: Lights: On/Off](#smart-home-lights-onoff)\n* [Smart Home: Lights: Up/Down](#smart-home-lights-updown)\n* [Smart Home: Thermostat: On/Off](#smart-home-thermostat-onoff)\n* [Smart Home: Thermostat: Up/Down](#smart-home-thermostat-updown)\n* [Smart Home: Locks: Lock/Unlock](#smart-home-locks-lockunlock)\n* [Smart Home: Locks: Close/Open](#smart-home-locks-closeopen)\n* [Smart Home: Appliances: On/Off](#smart-home-appliances-onoff)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Lights: On/Off\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nsmarthome.lights_on| Requests to turn the lights on  \nsmarthome.lights_off| Requests to turn the lights off  \n  \n## Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nlocation| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn on the lights in the kitchen (location=kitchen)  \ntype| _data_| string| optional| Defines the type: _sleep_, _romantic_, _party_, _dome_| romantic lights (type=romantic)  \ncolor| _data_| string| optional| Defines the lights color. _See the list of available values:_ [Color List](#section-color-list)| green light for kitchen. (color=green)  \naction_condition| _data_| object| optional| |\ncondition_name| *action_condition*| string| required| Defines the condition, when the action should be performed: _leave_, _enter_| turn on the lights when I enter (condition_name=enter)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off the lights when I leave bathroom (location=bathroom)  \ntime| *action_condition*| string| optional| Defines the time, when the action should be performed| turn on the lights at 6 pm (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off the lights after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off the lights from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn off the light at 8 pm every day. (recurrence=[1,2,3,4,5,6,7])  \nall| _data_| string| optional| Specifies that all lights are requested. Available values: _true_ | switch off all the lights. (all=true)  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Lights: Up/Down\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nsmarthome.lights_up| Requests to turn the lights up  \nsmarthome.lights_down| Requests to turn the lights down  \n  \n## Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nlocation| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn up the lights in the kitchen (location=kitchen)  \naction_amount| _data_| object| optional| |\npercent_change| *action_amount*| string| optional| Defines the percent of action to perform| turn down lights for 20% (percent_change=20)  \npercent_final| *action_amount*| string| optional| Defines the percent until the action to perform| turn down lights until 40% (percent_final=40)  \nunits_change| *action_amount*| string| optional| Defines the units of action to perform| turn down lights for 20 points (units_change=20)  \nunits_final| *action_amount*| string| optional| Defines the units until the action to perform| turn down lights until 40 points (units_final=40)  \naction_condition| _data_| object| optional| |\ncondition_name| *action_condition*| string| required| Defines the condition, when the action should be performed: _leave_, _enter_| turn down lights when I leave (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn up the lights when I enter bathroom (location=bathroom)  \ntime| *action_condition*| string| optional| Defines the time, when the action should be performed| turn up the lights at 10 pm (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn down the lights after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn up the lights from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn down the lights at 8 pm every Tuesday. (recurrence=[2]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Thermostat: On/Off\"\n}\n[/block]\n## Action\n\nName| Description  \n---|---  \nsmarthome.thermostat_on| Requests to turn heating on  \nsmarthome.thermostat_off| Requests to turn heating off  \n  \n## Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nlocation| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn off heating in the kitchen (location=kitchen)  \ntype| _data_| string| optional| Defines the type: _sleep_, _romantic_, _night_| night heating (type=night)  \naction_condition| _data_| string| optional| |\ncondition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn off the heating when I go out (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off the heating when I leave bathroom (location=bathroom)  \naction_time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn off the heating at 10 pm (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off the heating after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off the heating from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn off the heating at 7 am on weekends. (recurrence=[6,7]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Thermostat: Up/Down\"\n}\n[/block]\n### Action\n\nName| Description  \n---|---  \nsmarthome.thermostat_up| Requests to turn heating up  \nsmarthome.thermostat_down| Requests to turn heating down  \n  \n### Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nlocation| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn up heating in the kitchen (location=kitchen)  \naction_amount| _data_| object| optional| |\npercent_change| *action_amount*| string| optional| Defines the percent of action to perform| turn down heating for 20% (percent_change=20)  \npercent_final| *action_amount*| string| optional| Defines the percent until the action to perform| turn down heating until 40% (percent_final=40)  \nunits_change| *action_amount*| string| optional| Defines the units of action to perform| turn down heating for 20 degrees (units_change=20)  \nunits_final| *action_amount*| string| optional| Defines the units until the action to perform| turn down heating until 40 degrees (units_final=40)  \naction_condition| _data_| string| optional| |\ncondition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn down the heating when I go out (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn down the heating when I leave bathroom (location=bathroom)  \naction_time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn up the heating at 6 am (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn down the heating after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn down the heating from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn down the heating at 7 am on weekends. (recurrence=[6,7]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Locks: Lock/Unlock\"\n}\n[/block]\n### Action\n\nName| Description  \n---|---  \nsmarthome.locks_lock| Requests to lock  \nsmarthome.locks_unlock| Requests to unlock  \n  \n### Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nunit_type| data| object| optional| |\ntype| *unit_type*| string| optional| Defines the type of the unit: _door_, _window_| lock the door (type=door)  \nlocation| *unit_type*| string| optional| Defines the location of the unit. _See the of available values:_ [Location List](#section-location-list)| lock the front door (location=front)  \naction_condition| _data_| object| optional| |\ncondition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| lock the door when I go out (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| unlock the window when I leave bathroom (location=bathroom)  \ntime| *action_condition*| string| optional| Defines the time, when the action should be performed| lock the door at 10 pm (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| lock the door after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| lock the door from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| make sure the door is locked at 7 pm every day. (recurrence=[1,2,3,4,5,6,7]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Locks: Close/Open\"\n}\n[/block]\n### Action\n\nName| Description  \n---|---  \nsmarthome.locks_close| Requests to close  \nsmarthome.locks_open| Requests to open  \n  \n### Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nunit_type| data| object| optional| |\ntype| *unit_type*| string| optional| Defines the type of the unit: _door_, _window_| close the door (type=door)  \nlocation| *unit_type*| string| optional| Defines the location of the unit. _See the of available values:_ [Location List](#section-location-list)| close the front door (location=front)  \naction_condition| _data_| object| optional| |\ncondition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| close the door when I go out (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| open the window when I leave bathroom (location=bathroom)  \ntime| *action_condition*| string| optional| Defines the time, when the action should be performed| open the door at 7 am (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| close the door after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| close the door from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| make sure the door is closed at 7 pm every day. (recurrence=[1,2,3,4,5,6,7]) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Smart Home: Appliances: On/Off\"\n}\n[/block]\n### Action\n\nName| Description  \n---|---  \nsmarthome.appliances_on| Requests to turn appliances on  \nsmarthome.appliances_off| Requests to turn appliances off  \n  \n### Data\n\nName| Parent| Data type| Required / Optional| Description| Request examples  \n---|---|---|---|---|---  \nappliance_name| _data_| string| required| Defines the appliance. _See the list of all available values:_ [Appliance List](#section-appliance-list)| turn on TV (appliance_name=TV)  \nlocation| _data_| string| optional| Defines the location of the appliance. _See the of available values:_ [Location List](#section-location-list)| turn on TV in the kitchen (location=kitchen)  \naction_condition| _data_| object| optional| |\ncondition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn off TV when I leave (condition_name=leave)  \nlocation| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off TV when I leave kitchen (location=kitchen)  \ntime| *action_condition*| string| optional| Defines the time, when the action should be performed| turn off TV at 10 pm (time=stiDate)  \ntime_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off TV after 10 pm (time_range_start=stiDate)  \ntime_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off TV from 10 pm till 8 am (time_range_end=stiDate)  \nrecurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn the computer off at 7 pm on weekends. (recurrence=[6,7])  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reference\"\n}\n[/block]\n## Appliance List\n\nair conditioner\ncoffee machine\ncomputer\ndishwasher\nhumidifier\nmicrowave\nrefrigerator\ntv\nvideo player\nwater cooker\nwater heater\nwashing machine\n\n## Location List\n\nbedroom  \nback _(only for Smart Home: Locks)_  \nbackroom  \nbasement  \nbathroom  \nboardroom  \nboiler room  \nbreakfast room  \nclean room  \ncloakroom  \ncommon room  \nconference room  \ndining room  \ndressing room  \nfamily room  \nfront _(only for Smart Home: Locks)_\nfoyer  \nfront room  \ngarage  \nguest room  \ngreen room  \nhall  \nhallway  \nhome  \nhomeroom  \nkitchen  \nkitchenette  \nladies room  \nlaundry room  \nlibrary  \nliving room  \nlobby  \nlounge  \nlunchroom  \nmens room  \noffice  \nstudio  \nvisitors room  \nwaiting room  \nwashroom  \nwater closet  \nwomens room  \nworkroom\n\n## Color List\n\nblue  \ndaylight  \ngreen  \norange  \npink  \npurple  \nred  \nsoft white  \nwarm white  \nwhite  \nyellow","excerpt":"","slug":"smart-home","type":"basic","title":"Smart Home"}
[block:callout] { "type": "warning", "title": "Domains are being deprecated", "body": "Domains are being deprecated. If you're currently using domains, please consider using our new [Prebuilt Agents](https://docs.api.ai/docs/prebuilt-agents)." } [/block] [block:callout] { "type": "info", "body": "This domain is supported in the following languages:\n* English" } [/block] * [Smart Home: Lights: On/Off](#smart-home-lights-onoff) * [Smart Home: Lights: Up/Down](#smart-home-lights-updown) * [Smart Home: Thermostat: On/Off](#smart-home-thermostat-onoff) * [Smart Home: Thermostat: Up/Down](#smart-home-thermostat-updown) * [Smart Home: Locks: Lock/Unlock](#smart-home-locks-lockunlock) * [Smart Home: Locks: Close/Open](#smart-home-locks-closeopen) * [Smart Home: Appliances: On/Off](#smart-home-appliances-onoff) [block:api-header] { "type": "basic", "title": "Smart Home: Lights: On/Off" } [/block] ## Action Name| Description ---|--- smarthome.lights_on| Requests to turn the lights on smarthome.lights_off| Requests to turn the lights off ## Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- location| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn on the lights in the kitchen (location=kitchen) type| _data_| string| optional| Defines the type: _sleep_, _romantic_, _party_, _dome_| romantic lights (type=romantic) color| _data_| string| optional| Defines the lights color. _See the list of available values:_ [Color List](#section-color-list)| green light for kitchen. (color=green) action_condition| _data_| object| optional| | condition_name| *action_condition*| string| required| Defines the condition, when the action should be performed: _leave_, _enter_| turn on the lights when I enter (condition_name=enter) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off the lights when I leave bathroom (location=bathroom) time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn on the lights at 6 pm (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off the lights after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off the lights from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn off the light at 8 pm every day. (recurrence=[1,2,3,4,5,6,7]) all| _data_| string| optional| Specifies that all lights are requested. Available values: _true_ | switch off all the lights. (all=true) [block:api-header] { "type": "basic", "title": "Smart Home: Lights: Up/Down" } [/block] ## Action Name| Description ---|--- smarthome.lights_up| Requests to turn the lights up smarthome.lights_down| Requests to turn the lights down ## Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- location| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn up the lights in the kitchen (location=kitchen) action_amount| _data_| object| optional| | percent_change| *action_amount*| string| optional| Defines the percent of action to perform| turn down lights for 20% (percent_change=20) percent_final| *action_amount*| string| optional| Defines the percent until the action to perform| turn down lights until 40% (percent_final=40) units_change| *action_amount*| string| optional| Defines the units of action to perform| turn down lights for 20 points (units_change=20) units_final| *action_amount*| string| optional| Defines the units until the action to perform| turn down lights until 40 points (units_final=40) action_condition| _data_| object| optional| | condition_name| *action_condition*| string| required| Defines the condition, when the action should be performed: _leave_, _enter_| turn down lights when I leave (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn up the lights when I enter bathroom (location=bathroom) time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn up the lights at 10 pm (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn down the lights after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn up the lights from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn down the lights at 8 pm every Tuesday. (recurrence=[2]) [block:api-header] { "type": "basic", "title": "Smart Home: Thermostat: On/Off" } [/block] ## Action Name| Description ---|--- smarthome.thermostat_on| Requests to turn heating on smarthome.thermostat_off| Requests to turn heating off ## Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- location| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn off heating in the kitchen (location=kitchen) type| _data_| string| optional| Defines the type: _sleep_, _romantic_, _night_| night heating (type=night) action_condition| _data_| string| optional| | condition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn off the heating when I go out (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off the heating when I leave bathroom (location=bathroom) action_time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn off the heating at 10 pm (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off the heating after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off the heating from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn off the heating at 7 am on weekends. (recurrence=[6,7]) [block:api-header] { "type": "basic", "title": "Smart Home: Thermostat: Up/Down" } [/block] ### Action Name| Description ---|--- smarthome.thermostat_up| Requests to turn heating up smarthome.thermostat_down| Requests to turn heating down ### Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- location| _data_| string| optional| Defines the location of the unit. _See the list of available values:_ [Location List](#section-location-list)| turn up heating in the kitchen (location=kitchen) action_amount| _data_| object| optional| | percent_change| *action_amount*| string| optional| Defines the percent of action to perform| turn down heating for 20% (percent_change=20) percent_final| *action_amount*| string| optional| Defines the percent until the action to perform| turn down heating until 40% (percent_final=40) units_change| *action_amount*| string| optional| Defines the units of action to perform| turn down heating for 20 degrees (units_change=20) units_final| *action_amount*| string| optional| Defines the units until the action to perform| turn down heating until 40 degrees (units_final=40) action_condition| _data_| string| optional| | condition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn down the heating when I go out (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn down the heating when I leave bathroom (location=bathroom) action_time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn up the heating at 6 am (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn down the heating after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn down the heating from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn down the heating at 7 am on weekends. (recurrence=[6,7]) [block:api-header] { "type": "basic", "title": "Smart Home: Locks: Lock/Unlock" } [/block] ### Action Name| Description ---|--- smarthome.locks_lock| Requests to lock smarthome.locks_unlock| Requests to unlock ### Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- unit_type| data| object| optional| | type| *unit_type*| string| optional| Defines the type of the unit: _door_, _window_| lock the door (type=door) location| *unit_type*| string| optional| Defines the location of the unit. _See the of available values:_ [Location List](#section-location-list)| lock the front door (location=front) action_condition| _data_| object| optional| | condition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| lock the door when I go out (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| unlock the window when I leave bathroom (location=bathroom) time| *action_condition*| string| optional| Defines the time, when the action should be performed| lock the door at 10 pm (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| lock the door after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| lock the door from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| make sure the door is locked at 7 pm every day. (recurrence=[1,2,3,4,5,6,7]) [block:api-header] { "type": "basic", "title": "Smart Home: Locks: Close/Open" } [/block] ### Action Name| Description ---|--- smarthome.locks_close| Requests to close smarthome.locks_open| Requests to open ### Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- unit_type| data| object| optional| | type| *unit_type*| string| optional| Defines the type of the unit: _door_, _window_| close the door (type=door) location| *unit_type*| string| optional| Defines the location of the unit. _See the of available values:_ [Location List](#section-location-list)| close the front door (location=front) action_condition| _data_| object| optional| | condition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| close the door when I go out (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| open the window when I leave bathroom (location=bathroom) time| *action_condition*| string| optional| Defines the time, when the action should be performed| open the door at 7 am (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| close the door after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| close the door from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| make sure the door is closed at 7 pm every day. (recurrence=[1,2,3,4,5,6,7]) [block:api-header] { "type": "basic", "title": "Smart Home: Appliances: On/Off" } [/block] ### Action Name| Description ---|--- smarthome.appliances_on| Requests to turn appliances on smarthome.appliances_off| Requests to turn appliances off ### Data Name| Parent| Data type| Required / Optional| Description| Request examples ---|---|---|---|---|--- appliance_name| _data_| string| required| Defines the appliance. _See the list of all available values:_ [Appliance List](#section-appliance-list)| turn on TV (appliance_name=TV) location| _data_| string| optional| Defines the location of the appliance. _See the of available values:_ [Location List](#section-location-list)| turn on TV in the kitchen (location=kitchen) action_condition| _data_| object| optional| | condition_name| *action_condition*| string| optional| Defines the condition, when the action should be performed: _leave_, _enter_| turn off TV when I leave (condition_name=leave) location| *action_condition*| string| optional| Defines the location of the condition, where the action should be performed. _See the list of available values:_ [Location List](#section-location-list)| turn off TV when I leave kitchen (location=kitchen) time| *action_condition*| string| optional| Defines the time, when the action should be performed| turn off TV at 10 pm (time=stiDate) time_range_start| *action_condition*| string| optional| Defines start of time range, when the action should be performed| turn off TV after 10 pm (time_range_start=stiDate) time_range_end| *action_condition*| string| optional| Defines end of time range, when the action should be performed| turn off TV from 10 pm till 8 am (time_range_end=stiDate) recurrence| *action_condition*| list| optional| Defines the recurrence to repeat the action. Available values: 1, 2, 3, 4, 5, 6, 7 _**Note:** Monday is 1._| turn the computer off at 7 pm on weekends. (recurrence=[6,7]) [block:api-header] { "type": "basic", "title": "Reference" } [/block] ## Appliance List air conditioner coffee machine computer dishwasher humidifier microwave refrigerator tv video player water cooker water heater washing machine ## Location List bedroom back _(only for Smart Home: Locks)_ backroom basement bathroom boardroom boiler room breakfast room clean room cloakroom common room conference room dining room dressing room family room front _(only for Smart Home: Locks)_ foyer front room garage guest room green room hall hallway home homeroom kitchen kitchenette ladies room laundry room library living room lobby lounge lunchroom mens room office studio visitors room waiting room washroom water closet womens room workroom ## Color List blue daylight green orange pink purple red soft white warm white white yellow