Skema Karakteristik Volume Smart Home

action.devices.traits.Volume - Ciri ini dimiliki oleh perangkat yang dapat mengubah volume (misalnya, menyetel volume ke level tertentu, membisukan, atau mengaktifkan suara).

ATRIBUT Perangkat

Perangkat dengan karakteristik ini dapat melaporkan atribut berikut sebagai bagian dari operasi SYNC. Untuk mempelajari lebih lanjut cara menangani intent SYNC, lihat Fulfillment intent.

Atribut Jenis Deskripsi
volumeMaxLevel Bilangan Bulat

Wajib.

Tingkat volume maksimum, dengan asumsi nilai dasar 0 (bisukan). Asisten akan menyesuaikan perintah adverbia (misalnya, 'buat tv sedikit lebih keras') dengan tepat.
volumeCanMuteAndUnmute Boolean

Wajib.

Menunjukkan apakah perangkat dapat menonaktifkan dan mengaktifkan volume. Bisukan adalah opsi terpisah karena perilaku 'bisukan' akan menurunkan volume ke 0 sambil mengingat volume sebelumnya, sehingga membunyikan kembali akan memulihkannya. Hal ini tercermin dalam status volume—jika volume 5, dan pengguna membisukan, volume tetap 5 dan isMuted adalah benar.
volumeDefaultPercentage Bilangan Bulat

(Default: 40)

Volume (dalam persentase) untuk volume default yang ditentukan oleh pengguna atau produsen. Skala harus 0-100.

Nilai harus antara 0 dan 100.
levelStepSize Bilangan Bulat

(Default: 1)

Ukuran langkah default untuk kueri volume relatif seperti 'naikkan volume di <device_name>.
commandOnlyVolume Boolean

(Default: false)

Menunjukkan apakah perangkat beroperasi menggunakan komunikasi satu arah (benar) atau dua arah (salah). Misalnya, jika pengontrol dapat mengonfirmasi status perangkat baru setelah mengirim permintaan, kolom ini akan bernilai salah (false). Jika tidak mungkin mengonfirmasi apakah permintaan berhasil dieksekusi atau mendapatkan status perangkat (misalnya, jika perangkat adalah remote inframerah tradisional), tetapkan kolom ini ke benar (true).

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

STATUS Perangkat

Entitas dengan sifat ini dapat melaporkan status berikut sebagai bagian dari operasi QUERY. Untuk mempelajari lebih lanjut cara menangani intent QUERY, lihat Fulfillment intent.

Negara bagian Jenis Deskripsi
currentVolume Bilangan Bulat

Wajib.

Persentase volume saat ini. Nilai ini harus antara >0 dan volumeMaxLevel.

Nilai minimum: 0.
isMuted Boolean

Wajib jika atribut volumeCanMuteAndUnmute disetel ke benar. Benar jika perangkat disetel ke senyap; salah jika tidak. Jika isMuted benar (true), perangkat akan tetap menampilkan currentVolume untuk titik yang diingat.

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

PERINTAH perangkat

Perangkat dengan trait ini dapat merespons perintah berikut sebagai bagian dari operasi EXECUTE. Untuk mempelajari lebih lanjut cara menangani intent EXECUTE, lihat Fulfillment intent.

action.devices.commands.mute

Membisukan atau membunyikan perangkat.

Parameter

Parameter Jenis Deskripsi
mute Boolean

Wajib.

Apakah akan membisukan atau membunyikan perangkat.

Contoh

Membisukan perangkat speaker

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

action.devices.commands.setVolume

Setel volume ke tingkat yang diminta, berdasarkan volumeMaxLevel.

Parameter

Parameter Jenis Deskripsi
volumeLevel Bilangan Bulat

Wajib.

Volume baru, dari 0 menjadi volumeMaxLevel.

Nilai minimum: 0.

Contoh

Menyetel volume absolut perangkat speaker

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

action.devices.commands.volumeRelative

Menyetel volume naik atau turun n langkah, berdasarkan volumeMaxLevel. Untuk perintah yang menggunakan skala relatif, Asisten akan memilih n dengan tepat untuk menyesuaikan skala ke langkah-langkah yang tersedia. Misalnya, Make the TV much louder akan menetapkan jumlah langkah yang lebih tinggi daripada Make the TV a tiny bit louder.

Parameter

Parameter Jenis Deskripsi
relativeSteps Bilangan Bulat

Wajib.

negatif untuk 'penurunan'.

Contoh

Menyetel volume relatif perangkat speaker dalam mode khusus perintah

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

ERROR Perangkat

Lihat daftar lengkap error dan pengecualian.
  • volumeAlreadyMax: Perangkat menerima perintah VolumeUp saat sudah berada pada volume tertinggi.
  • volumeAlreadyMin: Perangkat menerima perintah VolumeDown saat sudah berada pada volume terendah.