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

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

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

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

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

חובה.

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

volumeCanMuteAndUnmute בוליאני

חובה.

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

volumeDefaultPercentage Integer

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

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

levelStepSize Integer

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

גודל השלב שמוגדר כברירת מחדל לשאילתות עם נפח חיפושים יחסי, כמו 'Volume up on <device_name> (הגדלת הנפח ב-<device_name>).

commandOnlyVolume בוליאני

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

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

דוגמאות

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

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

מכשיר STATES

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

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

חובה.

האחוז הנוכחי של עוצמת הקול. תקופת ההתחייבות צריכה להיות בין >0 ל-volumeMaxLevel.

isMuted בוליאני

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

דוגמאות

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

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

COMMANDS של מכשיר

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

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

חובה.

שלילי ל-'decrease'.

דוגמאות

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

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

מכשיר ERRORS

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