Esquema para definições de tipo

As seções a seguir detalham o esquema usado para definições de tipo.

$ id

O elemento $id identifica a definição do esquema. Ele deve seguir esta estrutura:

• Comece com o prefixo /schema-versions/ URI

• Incluir o definition tipo de esquema

• Use uma barra (/) como separador de caminho de URI

• Inclua a identidade do esquema, com fragmentos separados por pontos () .

• Use o @ caractere para separar o ID do esquema e a versão

• Termine com a versão semver, usando pontos (.) para separar os fragmentos da versão

A identidade do esquema deve começar com um namespace raiz de 3 a 12 caracteres, seguido por um nome e um subnamespace opcionais.

A versão semver inclui uma versão MAJOR (até 3 dígitos), uma versão MINOR (até 3 dígitos) e uma versão PATCH opcional (até 4 dígitos).

nota

Você não pode usar os namespaces aws reservados ou matter

exemplo Exemplo $id

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

$ ref

O elemento $ref faz referência a uma definição de tipo existente no sistema. Ele segue as mesmas restrições do $id elemento.

nota

Deve existir uma definição de tipo ou capacidade com o valor fornecido no $ref arquivo.

exemplo Exemplo $ref

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

nome

O elemento name é uma string que representa o nome da entidade no documento do esquema. Geralmente contém abreviações e deve seguir estas regras:

• Contém somente caracteres alfanuméricos, pontos (.), barras (/), hífens (-) e espaços

• Comece com uma letra

• Máximo de 192 caracteres

O elemento name é usado na interface de usuário e na documentação do console da Amazon Web Services.

exemplo Nomes de exemplo

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

título

O elemento title é uma string descritiva para a entidade representada pelo documento do esquema. Ele pode conter qualquer caractere e é usado na documentação.

exemplo Exemplos de títulos

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

description

O description elemento fornece uma explicação detalhada da entidade representada pelo documento do esquema. Ele pode conter qualquer caractere e é usado na documentação.

exemplo Descrição do exemplo

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.

ID extrínseco

O extrinsicId elemento representa um identificador gerenciado fora do sistema de IoT da Amazon Web Services. Para os recursos do MatterclusterId, ele mapeia para attributeId commandIdeventId,,fieldId, ou, dependendo do contexto.

O extrinsicId pode ser um inteiro decimal em sequência (1 a 10 dígitos) ou um inteiro hexadecimal em sequência (prefixo 0x ou 0X, seguido por 1 a 8 dígitos hexadecimais).

nota

Para AWS, o ID do fornecedor (VID) é 0x1577 e, para o Matter, é 0. O sistema garante que os esquemas personalizados não os usem reservados VIDs para recursos.

exemplo Exemplo de extrinsicidas

0018
0x001A
0x15771002

Propriedades extrínsecas

O extrinsicProperties elemento contém um conjunto de propriedades definidas em um sistema externo, mas mantidas dentro do modelo de dados. Para os recursos do Matter, ele mapeia para diferentes elementos não modelados ou parcialmente modelados dentro do cluster, atributo, comando ou evento ZCL.

As propriedades extrínsecas devem seguir estas restrições:

• Os nomes das propriedades devem ser alfanuméricos, sem espaços ou caracteres especiais

• Os valores das propriedades podem ser qualquer valor do esquema JSON

• Máximo de 20 propriedades

O sistema oferece suporte a vários extrinsicPropertiesaccess, incluindoapiMaturity,cli,cliFunctionName, e outros. Essas propriedades facilitam a ACL para AWS (e vice-versa) as transformações do modelo de dados.

nota

As propriedades extrínsecas são suportadas para os elementos actionevent,property, e struct fields de um recurso, mas não para o recurso ou cluster em si.