راهنمای فر خانه هوشمند
action.devices.types.OVEN - تعامل با اجاق ها شامل توانایی پخت یا کباب کردن در دماهای خاص است. دمای فیزیکی داخل فر با گرم شدن اجاق متفاوت است، بنابراین ممکن است این مورد نیز کنترل شود. فر دارای زمان پختی است که مدت زمان پخت را محدود می کند.
این نوع نشان می‌دهد که دستگاه نماد Oven و برخی از مترادف‌ها و نام‌های مستعار مرتبط را دریافت می‌کند.
فرها دارای دستور زبان مبتنی بر نوع برایaction.devices.traits.OnOff و action.devices.traits.TemperatureControl هستند:- اگر دستگاه از
OnOffپشتیبانی می کند، فر را از قبل گرم کنید دستورaction.devices.commands.OnOffرا ارسال می کند. - اگر دستگاه از
TemperatureControlپشتیبانی می کند، فر را با دمای 350 درجه از قبل گرم کنید، فرمانی برای تنظیم فر روی آن دما ارسال می شود.
قابلیت های دستگاه
برای جزئیات پیاده‌سازی، مانند ویژگی‌ها و حالت‌هایی که سرویس شما باید از آنها پشتیبانی کند، و نحوه ایجاد پاسخ‌های EXECUTE و QUERY، به اسناد ویژگی مربوطه مراجعه کنید.
صفات مورد نیاز
این صفات و دستورات، در صورت وجود برای دستگاه شما، مورد نیاز هستند. اگر دستگاه شما از این ویژگی ها پشتیبانی نمی کند، کد خطای functionNotSupported را در پاسخ QUERY یا EXECUTE وارد کنید. برای اطلاعات بیشتر به خطاها و استثناها مراجعه کنید.
صفات توصیه شده
این ویژگی‌ها در صورت وجود برای دستگاه شما توصیه می‌شوند. با این حال، شما آزاد هستید که تمام ویژگی‌های موجود را با هم ترکیب کنید تا به بهترین نحو با عملکرد محصول موجود خود مطابقت داشته باشد.
الزامات کیفیت
- تأخیر: باید کمتر یا مساوی 3000 میلی‌ثانیه باشد.
- قابلیت اطمینان: باید بیشتر یا مساوی 97 درصد باشد.
دستگاه نمونه: فر ساده
این بخش شامل نمونه‌هایی از محموله‌های هدف است که بر اساس نوع دستگاه و ویژگی‌های بالا، یک «فر» رایج را نشان می‌دهد. اگر ویژگی‌هایی را در پیاده‌سازی خود اضافه یا حذف می‌کنید، پاسخ‌های خود را متناسب با آن تغییر دهید تا آن تغییرات را منعکس کند.
نمونه پاسخ SYNC
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.OVEN",
"traits": [
"action.devices.traits.Cook",
"action.devices.traits.OnOff",
"action.devices.traits.TemperatureControl",
"action.devices.traits.Timer",
"action.devices.traits.StartStop"
],
"name": {
"name": "Simple oven"
},
"willReportState": true,
"attributes": {
"supportedCookingModes": [
"BAKE",
"CONVECTION_BAKE",
"ROAST"
],
"maxTimerLimitSec": 3600,
"temperatureRange": {
"minThresholdCelsius": 65,
"maxThresholdCelsius": 288
},
"temperatureUnitForUX": "F"
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}نمونه پاسخ QUERY
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": true,
"isRunning": true,
"temperatureSetpointCelsius": 175,
"currentCookingMode": "BAKE",
"timerRemainingSec": -1
}
}
}
}نمونه دستورات EXECUTE
پختن
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Cook مراجعه کنید.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Cook",
"params": {
"start": true,
"cookingMode": "ROAST"
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentCookingMode": "ROAST"
}
}
]
}
}روشن خاموش
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.OnOff مراجعه کنید.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}تنظیم دما
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.TemperatureControl مراجعه کنید.
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.SetTemperature",
"params": {
"temperature": 200
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"temperatureSetpointCelsius": 200,
"temperatureAmbientCelsius": 100
}
}
]
}
}TimerStart
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerStart",
"params": {
"timerTimeSec": 300
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300
}
}
]
}
}تایمر تنظیم کنید
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerAdjust",
"params": {
"timerTimeSec": -10
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 290
}
}
]
}
}تایمر مکث
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerPause"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": true
}
}
]
}
}تایمر رزومه
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerResume"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": false
}
}
]
}
}تایمر لغو
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerCancel"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": -1
}
}
]
}
}شروع پایان
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.StartStop مراجعه کنید.
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.StartStop",
"params": {
"start": true
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"isRunning": true
}
}
]
}
}خطاهای دستگاه
لیست کامل خطاها و استثناها را ببینید. ،راهنمای فر خانه هوشمند
action.devices.types.OVEN - تعامل با اجاق ها شامل توانایی پخت یا کباب کردن در دماهای خاص است. دمای فیزیکی داخل فر با گرم شدن اجاق متفاوت است، بنابراین ممکن است این مورد نیز کنترل شود. فر دارای زمان پختی است که مدت زمان پخت را محدود می کند.
این نوع نشان می‌دهد که دستگاه نماد Oven و برخی از مترادف‌ها و نام‌های مستعار مرتبط را دریافت می‌کند.
فرها دارای دستور زبان مبتنی بر نوع برایaction.devices.traits.OnOff و action.devices.traits.TemperatureControl هستند:- اگر دستگاه از
OnOffپشتیبانی می کند، فر را از قبل گرم کنید دستورaction.devices.commands.OnOffرا ارسال می کند. - اگر دستگاه از
TemperatureControlپشتیبانی می کند، فر را با دمای 350 درجه از قبل گرم کنید، فرمانی برای تنظیم فر روی آن دما ارسال می شود.
قابلیت های دستگاه
برای جزئیات پیاده‌سازی، مانند ویژگی‌ها و حالت‌هایی که سرویس شما باید از آنها پشتیبانی کند، و نحوه ساخت پاسخ‌های EXECUTE و QUERY، به اسناد ویژگی مربوطه مراجعه کنید.
صفات مورد نیاز
این صفات و دستورات، در صورت وجود برای دستگاه شما، مورد نیاز هستند. اگر دستگاه شما از این ویژگی ها پشتیبانی نمی کند، کد خطای functionNotSupported را در پاسخ QUERY یا EXECUTE وارد کنید. برای اطلاعات بیشتر به خطاها و استثناها مراجعه کنید.
صفات توصیه شده
این ویژگی‌ها در صورت وجود برای دستگاه شما توصیه می‌شوند. با این حال، شما آزاد هستید که تمام ویژگی‌های موجود را با هم ترکیب کنید تا به بهترین نحو با عملکرد محصول موجود خود مطابقت داشته باشد.
الزامات کیفیت
- تأخیر: باید کمتر یا مساوی 3000 میلی‌ثانیه باشد.
- قابلیت اطمینان: باید بیشتر یا مساوی 97 درصد باشد.
دستگاه نمونه: فر ساده
این بخش شامل نمونه‌هایی از محموله‌های هدف است که بر اساس نوع دستگاه و ویژگی‌های بالا، یک «فر» رایج را نشان می‌دهد. اگر ویژگی‌هایی را در پیاده‌سازی خود اضافه یا حذف می‌کنید، پاسخ‌های خود را متناسب با آن تغییر دهید تا آن تغییرات را منعکس کند.
نمونه پاسخ SYNC
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.OVEN",
"traits": [
"action.devices.traits.Cook",
"action.devices.traits.OnOff",
"action.devices.traits.TemperatureControl",
"action.devices.traits.Timer",
"action.devices.traits.StartStop"
],
"name": {
"name": "Simple oven"
},
"willReportState": true,
"attributes": {
"supportedCookingModes": [
"BAKE",
"CONVECTION_BAKE",
"ROAST"
],
"maxTimerLimitSec": 3600,
"temperatureRange": {
"minThresholdCelsius": 65,
"maxThresholdCelsius": 288
},
"temperatureUnitForUX": "F"
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}نمونه پاسخ QUERY
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": true,
"isRunning": true,
"temperatureSetpointCelsius": 175,
"currentCookingMode": "BAKE",
"timerRemainingSec": -1
}
}
}
}نمونه دستورات EXECUTE
پختن
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Cook مراجعه کنید.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Cook",
"params": {
"start": true,
"cookingMode": "ROAST"
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentCookingMode": "ROAST"
}
}
]
}
}روشن خاموش
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.OnOff مراجعه کنید.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}تنظیم دما
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.TemperatureControl مراجعه کنید.
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.SetTemperature",
"params": {
"temperature": 200
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"temperatureSetpointCelsius": 200,
"temperatureAmbientCelsius": 100
}
}
]
}
}TimerStart
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerStart",
"params": {
"timerTimeSec": 300
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300
}
}
]
}
}تایمر تنظیم کنید
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerAdjust",
"params": {
"timerTimeSec": -10
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 290
}
}
]
}
}تایمر مکث
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerPause"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": true
}
}
]
}
}تایمر رزومه
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerResume"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": false
}
}
]
}
}تایمر لغو
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.Timer مراجعه کنید.
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerCancel"
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": -1
}
}
]
}
}شروع پایان
برای جزئیات بیشتر در مورد پارامترهای فرمان، به مرجع action.devices.traits.StartStop مراجعه کنید.
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.StartStop",
"params": {
"start": true
}
}
]
}
]
}
}
]
}{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"isRunning": true
}
}
]
}
}