유형 정의 스키마

다음 섹션에서는 유형 정의에 사용되는 스키마를 자세히 설명합니다.

$id

$id 요소는 스키마 정의를 식별합니다. 다음 구조를 따라야 합니다.

• /schema-versions/ URI 접두사로 시작

• definition 스키마 유형 포함

• URI 경로 구분자로 슬래시(/) 사용

• 조각을 마침표(.)로 구분하여 스키마 자격 증명 포함

• @ 문자를 사용하여 스키마 ID와 버전을 구분합니다.

• 마침표(.)를 사용하여 버전 조각을 구분하는 셈버 버전으로 끝납니다.

스키마 자격 증명은 3~12자 길이의 루트 네임스페이스로 시작한 다음 선택적 하위 네임스페이스와 이름으로 시작해야 합니다.

셈버 버전에는 메이저 버전(최대 3자리), 마이너 버전(최대 3자리) 및 선택적 패치 버전(최대 4자리)이 포함됩니다.

참고

예약된 네임스페이스 aws 또는를 사용할 수 없습니다. matter

예 $id 예제

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

$ref

$ref 요소는 시스템 내의 기존 유형 정의를 참조합니다. $id 요소와 동일한 제약 조건을 따릅니다.

참고

형식 정의 또는 기능은 $ref 파일에 제공된 값과 함께 존재해야 합니다.

예 $ref 예제

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

name

이름 요소는 스키마 문서의 엔터티 이름을 나타내는 문자열입니다. 종종 약어가 포함되어 있으며 다음 규칙을 따라야 합니다.

• 영숫자, 마침표(.), 슬래시(/), 하이픈(-) 및 공백만 포함

• 문자로 시작

• 최대 192자

이름 요소는 Amazon Web Services 콘솔 UI 및 설명서에 사용됩니다.

예제 이름

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

제목

제목 요소는 스키마 문서로 표시되는 개체에 대한 설명 문자열입니다. 모든 문자를 포함할 수 있으며 설명서에 사용됩니다.

예 제목 예

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

설명

description 요소는 스키마 문서로 표시되는 개체에 대한 자세한 설명을 제공합니다. 모든 문자를 포함할 수 있으며 설명서에 사용됩니다.

예제 설명

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

extrinsicId 요소는 Amazon Web Services IoT 시스템 외부에서 관리되는 식별자를 나타냅니다. Matter 기능의 경우 컨텍스트에 따라 clusterId, fieldId, attributeIdcommandIdeventId, 또는에 매핑됩니다.

는 문자열화된 10진수 정수(1~10자리) 또는 문자열화된 16진수 정수(0x 또는 0X 접두사 뒤에 1~8자리 16진수)일 extrinsicId 수 있습니다.

참고

AWS의 경우 공급업체 ID(VID)는 0x1577이고 Matter의 경우 0입니다. 시스템은 사용자 지정 스키마가 이러한 예약된 VIDs 기능에 사용하지 않도록 합니다.

예 extrinsicIds 예제

0018
0x001A
0x15771002

extrinsicProperties

extrinsicProperties 요소에는 외부 시스템에 정의되어 있지만 데이터 모델 내에서 유지되는 속성 세트가 포함되어 있습니다. Matter 기능의 경우 ZCL 클러스터, 속성, 명령 또는 이벤트 내에서 모델링되지 않았거나 부분적으로 모델링된 다양한 요소에 매핑됩니다.

외부 속성은 다음 제약 조건을 따라야 합니다.

• 속성 이름은 공백이나 특수 문자 없이 영숫자여야 합니다.

• 속성 값은 모든 JSON 스키마 값일 수 있습니다.

• 최대 20개의 속성

시스템은 extrinsicProperties, , access, 등 다양한 apiMaturityclicliFunctionName를 지원합니다. 이러한 속성은 ACL에서 데이터 모델로의 변환 AWS (및 그 반대)을 용이하게 합니다.

참고

외부 속성은 기능의 action, eventproperty, 및 struct 필드 요소에 대해 지원되지만 기능 또는 클러스터 자체에는 지원되지 않습니다.