Schema für Typdefinitionen

In den folgenden Abschnitten wird das für Typdefinitionen verwendete Schema detailliert beschrieben.

$id

Das $id-Element identifiziert die Schemadefinition. Es muss dieser Struktur folgen:

• Beginnen Sie mit dem /schema-versions/ URI-Präfix

• Schließen Sie den definition Schematyp ein

• Verwenden Sie einen Schrägstrich (/) als URI-Pfadtrennzeichen

• Fügen Sie die Schema-Identität ein, wobei die Fragmente durch Punkte (.) getrennt sind

• Verwenden Sie das @ Zeichen, um die Schema-ID und die Version zu trennen

• Beenden Sie mit der Serverversion und verwenden Sie Punkte (.), um Versionsfragmente zu trennen

Die Schema-Identität muss mit einem Stamm-Namespace beginnen, der 3-12 Zeichen lang ist, gefolgt von einem optionalen Unternamespace und einem Namen.

Die Semver-Version umfasst eine HAUPTVERSION (bis zu 3 Ziffern), eine NEBENVERSION (bis zu 3 Ziffern) und eine optionale PATCH-Version (bis zu 4 Ziffern).

Anmerkung

Sie können die reservierten aws Namespaces nicht verwenden oder matter

Beispiel $id

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

$ref

Das $ref-Element verweist auf eine bestehende Typdefinition innerhalb des Systems. Es folgt denselben Einschränkungen wie das $id Element.

Anmerkung

Es muss eine Typdefinition oder Fähigkeit mit dem in der $ref Datei angegebenen Wert vorhanden sein.

Beispiel $ref

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

Name

Das Namenselement ist eine Zeichenfolge, die den Entitätsnamen im Schemadokument darstellt. Es enthält häufig Abkürzungen und muss den folgenden Regeln entsprechen:

• Enthält nur alphanumerische Zeichen, Punkte (.), Schrägstriche (/), Bindestriche (-) und Leerzeichen

• Beginne mit einem Buchstaben

• Maximal 192 Zeichen

Das name-Element wird in der Benutzeroberfläche und in der Dokumentation der Amazon Web Services Services-Konsole verwendet.

Beispielnamen

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

Titel

Das Titelelement ist eine beschreibende Zeichenfolge für die Entität, die durch das Schemadokument repräsentiert wird. Es kann beliebige Zeichen enthalten und wird in der Dokumentation verwendet.

Beispieltitel

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

description

Das description Element bietet eine detaillierte Erläuterung der Entität, die durch das Schemadokument repräsentiert wird. Es kann beliebige Zeichen enthalten und wird in der Dokumentation verwendet.

Beispiel für eine Beschreibung

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.

Extrinsische ID

Das extrinsicId Element stellt eine Kennung dar, die außerhalb des IoT-Systems von Amazon Web Services verwaltet wird. Bei Matter-Funktionen wird es je nach Kontext clusterId attributeId commandIdeventId,fieldId,, oder zugeordnet.

Dabei extrinsicId kann es sich entweder um eine stringifizierte dezimale Ganzzahl (1—10 Ziffern) oder um eine stringifizierte hexadezimale Ganzzahl (0x- oder 0X-Präfix, gefolgt von 1—8 hexadezimalen Ziffern) handeln.

Anmerkung

Für AWS ist die Lieferanten-ID (VID) 0x1577 und für Matter 0. Das System stellt sicher, dass benutzerdefinierte Schemas diese für Funktionen reservierten VIDs Daten nicht verwenden.

Beispiel: ExtrinsICIDs

0018
0x001A
0x15771002

Extrinsische Eigenschaften

Das extrinsicProperties Element enthält eine Reihe von Eigenschaften, die in einem externen System definiert sind, aber innerhalb des Datenmodells verwaltet werden. Bei Matter-Fähigkeiten ist es verschiedenen unmodellierten oder teilweise modellierten Elementen innerhalb eines ZCL-Clusters, -Attributs, -Befehls oder -Ereignisses zugeordnet.

Extrinsische Eigenschaften müssen den folgenden Einschränkungen entsprechen:

• Eigenschaftsnamen müssen alphanumerisch ohne Leerzeichen oder Sonderzeichen sein

• Eigenschaftswerte können beliebige JSON-Schemawerte sein

• Maximal 20 Eigenschaften

Das System unterstützt verschiedeneextrinsicProperties, darunter accessapiMaturity,cli,cliFunctionName, und andere. Diese Eigenschaften erleichtern Transformationen von ACL zu Datenmodellen AWS (und umgekehrt).

Anmerkung

Extrinsische Eigenschaften werden für die Elementeaction, eventproperty, und struct fields einer Fähigkeit unterstützt, nicht jedoch für die Fähigkeit oder den Cluster selbst.