Schema per le definizioni dei tipi - Integrazioni gestite per AWS IoT Device Management
$id$refnometitolodescriptionExtrinsICIDProprietà estrinseche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Schema per le definizioni dei tipi

Le seguenti sezioni descrivono in dettaglio lo schema utilizzato per le definizioni dei tipi.

$id

L'elemento $id identifica la definizione dello schema. Deve seguire questa struttura:

  • Inizia con il prefisso /schema-versions/ URI

  • Includi il tipo di definition schema

  • Usa una barra (/) come separatore di percorso URI

  • Includi l'identità dello schema, con frammenti separati da punti () .

  • Usa il @ carattere per separare l'ID e la versione dello schema

  • Termina con la versione semver, usando period (.) per separare i frammenti di versione

L'identità dello schema deve iniziare con uno spazio dei nomi radice lungo 3-12 caratteri, seguito da uno spazio dei nomi secondario e da un nome opzionali.

La versione semver include una versione MAJOR (fino a 3 cifre), una versione MINOR (fino a 3 cifre) e una versione PATCH opzionale (fino a 4 cifre).

Nota

Non è possibile utilizzare i namespace riservati o aws matter

Esempio $id
/schema-version/capability/aws.Recording@1.0

$ref

L'elemento $ref fa riferimento a una definizione di tipo esistente all'interno del sistema. Segue gli stessi vincoli dell'elemento. $id

Nota

È necessario che esista una definizione o una funzionalità del tipo con il valore fornito nel $ref file.

Esempio $ref
/schema-version/definition/aws.capability@1.0

nome

L'elemento name è una stringa che rappresenta il nome dell'entità nel documento dello schema. Spesso contiene abbreviazioni e deve seguire queste regole:

  • Contiene solo caratteri alfanumerici, punti (.), barre (/), trattini (-) e spazi

  • Inizia con una lettera

  • Massimo 192 caratteri

L'elemento name viene utilizzato nell'interfaccia utente e nella documentazione della console di Amazon Web Services.

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

titolo

L'elemento title è una stringa descrittiva per l'entità rappresentata dal documento dello schema. Può contenere qualsiasi carattere e viene utilizzato nella documentazione.

Esempio Titoli di esempio
Real-time Communication (RTC) Session Controller
Energy EVSE Capability

description

L'descriptionelemento fornisce una spiegazione dettagliata dell'entità rappresentata dal documento dello schema. Può contenere qualsiasi carattere e viene utilizzato nella documentazione.

Esempio Descrizione di esempio
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.

ExtrinsICID

L'extrinsicIdelemento rappresenta un identificatore gestito all'esterno del sistema IoT di Amazon Web Services. Per le funzionalità di Matter, viene mappato a clusterId attributeIdcommandId,eventId,, ofieldId, a seconda del contesto.

extrinsicIdPuò essere un numero intero decimale con stringhe (1-10 cifre) o un intero esadecimale con stringhe (prefisso 0x o 0X, seguito da 1-8 cifre esadecimali).

Nota

Per, l' AWS ID fornitore (VID) è 0x1577 e per Matter è 0. Il sistema garantisce che gli schemi personalizzati non utilizzino queste funzionalità riservate. VIDs

Esempio: ExtrinsICIDS
0018
0x001A
0x15771002

Proprietà estrinseche

L'extrinsicPropertieselemento contiene un insieme di proprietà definite in un sistema esterno ma mantenute all'interno del modello di dati. Per quanto riguarda le funzionalità di Matter, esegue il mapping a diversi elementi non modellati o parzialmente modellati all'interno del cluster, dell'attributo, del comando o dell'evento ZCL.

Le proprietà estrinseche devono rispettare questi vincoli:

  • I nomi delle proprietà devono essere alfanumerici senza spazi o caratteri speciali

  • I valori delle proprietà possono essere qualsiasi valore dello schema JSON

  • Massimo 20 proprietà

Il sistema supporta diverse funzionalitàextrinsicProperties, tra cui accessapiMaturity,cli,cliFunctionName, e altre ancora. Queste proprietà facilitano le trasformazioni tra ACL e modelli di dati AWS (e viceversa).

Nota

Le proprietà estrinseche sono supportate per gli elementi actionevent,property, e struct fields di una funzionalità, ma non per la capacità o il cluster stesso.