הסכימה של מאפיין נפח הקול בבית חכם

action.devices.traits.Volume – המאפיין הזה שייך למכשירים שאפשר לשנות בהם את עוצמת הקול (לדוגמה, הגדרת עוצמת הקול לרמה מסוימת, השבתת הקול או הפעלת הקול).

מאפייני המכשיר

מכשירים עם המאפיין הזה עשויים לדווח על המאפיינים הבאים כחלק מהפעולה SYNC. למידע נוסף על טיפול בכוונות מסוג SYNC, ראו ביצוע כוונות.

מאפיינים סוג תיאור
volumeMaxLevel Integer

חובה.

עוצמת הקול המקסימלית, בהנחה שהבסיס הוא 0 (השתקה). Assistant תתאים את הפקודות עם תארים (למשל 'להגביה קצת את הטלוויזיה') בהתאם.

volumeCanMuteAndUnmute בוליאני

חובה.

מציין אם אפשר להשתיק את המכשיר ולהפעיל אותו מחדש. השתקה היא אפשרות נפרדת, כי כשמפעילים את האפשרות 'השתקה' עוצמת הקול יורדת ל-0, אבל עוצמת הקול הקודמת נשמרת כדי שאפשר יהיה לשחזר אותה כשמבטלים את ההשתקה. המצב הזה משתקף במצב עוצמת הקול – אם עוצמת הקול היא 5 והמשתמש משבית אותה, עוצמת הקול נשארת 5 ו-isMuted הוא true.

volumeDefaultPercentage Integer

(ברירת המחדל: 40)

עוצמת הקול (באחוזים) של עוצמת הקול שמוגדרת כברירת מחדל על ידי המשתמש או היצרן. הערך בקנה המידה חייב להיות בין 0 ל-100.

levelStepSize Integer

(ברירת המחדל: 1)

גודל הצעד שמוגדר כברירת מחדל לשאילתות של נפח יחסי, כמו 'הגברת עוצמת הקול ב-<device_name>'.

commandOnlyVolume בוליאני

(ברירת המחדל: false)

מציין אם המכשיר פועל באמצעות תקשורת חד-כיוונית (true) או דו-כיוונית (false). לדוגמה, אם הבקר יכול לאשר את מצב המכשיר החדש אחרי שליחת הבקשה, השדה הזה יהיה שקר. אם אי אפשר לאשר שהבקשה בוצעה או לקבל את מצב המכשיר (לדוגמה, אם המכשיר הוא שלט רחוק מסורתי אינפרה אדום), מגדירים את השדה הזה כ-true.

דוגמאות

רמקול שאפשר להשתיק ושהוא מדווח על המצב הנוכחי

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

מצבי המכשיר

ישויות עם המאפיין הזה יכולות לדווח על המצבים הבאים כחלק מהפעולה QUERY. למידע נוסף על טיפול בכוונות מסוג QUERY, ראו ביצוע כוונות.

מדינות סוג תיאור
currentVolume Integer

חובה.

אחוז הנפח הנוכחי. הערך חייב להיות בין >0 לבין volumeMaxLevel.

isMuted בוליאני

חובה אם המאפיין volumeCanMuteAndUnmute מוגדר כ-true. הערך true אם המכשיר מושתק, ואם לא, הערך false. אם הערך של isMuted הוא true, המכשיר עדיין מחזיר את הערך currentVolume לנקודה שנשמרה.

דוגמאות

רמקול שאפשר להשתיק ושהוא מדווח על המצב הנוכחי

{
  "currentVolume": 5,
  "isMuted": false
}

פקודות למכשיר

מכשירים עם המאפיין הזה עשויים להגיב לפקודות הבאות כחלק מהפעולה EXECUTE. למידע נוסף על טיפול בכוונות מסוג EXECUTE, ראו ביצוע כוונות.

action.devices.commands.mute

השתקה או ביטול ההשתקה של המכשיר.

פרמטרים

פרמטרים סוג תיאור
mute בוליאני

חובה.

האם להשתיק את המכשיר או לבטל את ההשתקה שלו.

דוגמאות

השתקת מכשיר הרמקול

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

הגדרת עוצמת הקול לרמה המבוקשת, על סמך volumeMaxLevel.

פרמטרים

פרמטרים סוג תיאור
volumeLevel Integer

חובה.

נפח חדש, מ-0 ל-volumeMaxLevel.

דוגמאות

הגדרת עוצמת קול מוחלטת של מכשיר הרמקול

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

הגדרת עוצמת הקול ב-n שלבים, על סמך volumeMaxLevel. בפקודות שמשתמשות בסולם יחסי, Assistant תבחר את הערך של n בהתאם למספר השלבים הזמינים. לדוגמה, הפקודה הגברת עוצמת הקול בטלוויזיה הרבה תגדיר מספר שלבים גבוה יותר מהפקודה הגברת עוצמת הקול בטלוויזיה קצת.

פרמטרים

פרמטרים סוג תיאור
relativeSteps Integer

חובה.

שלילי עבור 'ירידה'.

דוגמאות

הגדרת עוצמת הקול היחסית של מכשיר הרמקולים במצב 'פקודה בלבד'

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

שגיאות במכשיר

הרשימה המלאה של השגיאות והחריגות
  • volumeAlreadyMax: המכשיר מקבל את הפקודה VolumeUp כשהוא כבר בעוצמת הקול הגבוהה ביותר.
  • volumeAlreadyMin: המכשיר מקבל את הפקודה VolumeDown כשעוצמת הקול כבר נמוכה ככל האפשר.