Skema untuk definisi tipe

Bagian berikut merinci skema yang digunakan untuk definisi tipe.

$ id

Elemen $id mengidentifikasi definisi skema. Itu harus mengikuti struktur ini:

• Mulai dengan awalan /schema-versions/ URI

• Sertakan definition jenis skema

• Gunakan garis miring maju (/) sebagai pemisah jalur URI

• Sertakan identitas skema, dengan fragmen yang dipisahkan oleh periode () .

• Gunakan @ karakter untuk memisahkan ID skema dan versi

• Akhiri dengan versi semver, menggunakan period (.) untuk memisahkan fragmen versi

Identitas skema harus dimulai dengan namespace root yang panjangnya 3-12 karakter, diikuti oleh sub-namespace dan nama opsional.

Versi semver mencakup versi MAJOR (hingga 3 digit), versi MINOR (hingga 3 digit), dan versi PATCH opsional (hingga 4 digit).

catatan

Anda tidak dapat menggunakan ruang nama aws yang dicadangkan atau matter

contoh Contoh $ id

/schema-version/capability/aws.Recording@1.0

$ ref

Elemen $ref mereferensikan definisi tipe yang ada dalam sistem. Ini mengikuti kendala yang sama dengan elemen. $id

catatan

Definisi atau kemampuan tipe harus ada dengan nilai yang disediakan dalam $ref file.

contoh Contoh $ ref

/schema-version/definition/aws.capability@1.0

name

Elemen nama adalah string yang mewakili nama entitas dalam dokumen skema. Ini sering berisi singkatan dan harus mengikuti aturan ini:

• Hanya berisi karakter alfanumerik, titik (.), garis miring maju (/), tanda hubung (-), dan spasi

• Mulailah dengan surat

• Maksimal 192 karakter

Elemen nama digunakan di UI dan dokumentasi konsol Amazon Web Services.

contoh Contoh nama

Door Lock
On/Off
Wi-Fi Network Management
PM2.5 Concentration Measurement
RTCSessionController
Energy EVSE

title

Elemen judul adalah string deskriptif untuk entitas yang diwakili oleh dokumen skema. Ini dapat berisi karakter apa pun dan digunakan dalam dokumentasi.

contoh Judul contoh

Real-time Communication (RTC) Session Controller
Energy EVSE Capability

deskripsi

descriptionElemen memberikan penjelasan rinci tentang entitas yang diwakili oleh dokumen skema. Ini dapat berisi karakter apa pun dan digunakan dalam dokumentasi.

contoh Deskripsi contoh

Electric Vehicle Supply Equipment (EVSE) is equipment used to charge an Electric Vehicle (EV) or Plug-In Hybrid Electric Vehicle. 
            This capability provides an interface to the functionality of Electric Vehicle Supply Equipment (EVSE) management.

Ekstrinsicid

extrinsicIdElemen tersebut mewakili pengenal yang dikelola di luar sistem IoT Amazon Web Services. Untuk kemampuan Matter, ia memetakan keclusterId,attributeId,commandId,eventId, ataufieldId, tergantung pada konteksnya.

extrinsicIdDapat berupa bilangan bulat desimal stringifikasi (1-10 digit) atau bilangan bulat heksadesimal stringifikasi (awalan 0x atau 0X, diikuti oleh 1-8 digit heksadesimal).

catatan

Untuk AWS, Vendor ID (VID) adalah 0x1577, dan untuk Matter, itu adalah 0. Sistem memastikan bahwa skema khusus tidak menggunakan ini yang dicadangkan VIDs untuk kemampuan.

contoh Contoh ekstrinsicids

0018
0x001A
0x15771002

ExtrinsicProperties

extrinsicPropertiesElemen berisi seperangkat properti yang didefinisikan dalam sistem eksternal tetapi dipertahankan dalam model data. Untuk kemampuan Matter, ia memetakan ke berbagai elemen yang tidak dimodelkan atau sebagian dimodelkan dalam cluster, atribut, perintah, atau peristiwa ZCL.

Properti Ekstrinsik harus mengikuti kendala ini:

• Nama properti harus alfanumerik tanpa spasi atau karakter khusus

• Nilai properti dapat berupa nilai skema JSON

• Maksimal 20 properti

Sistem ini mendukung berbagaiextrinsicProperties, termasukaccess,apiMaturity,cli,cliFunctionName, dan lain-lain. Properti ini memfasilitasi ACL untuk AWS (dan sebaliknya) transformasi model data.

catatan

Properti ekstrinsik didukung untukaction,, eventproperty, dan elemen struct bidang kemampuan, tetapi tidak untuk kemampuan atau cluster itu sendiri.