1. 개요 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1.1 개요 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
본 문서는 스마트 조명 조명/센서 디바이스의 L-SLP(Local – Smart Lighting Profile) API(Application Programming Interface)에 대한 규격서이다. 이 규격서는 CoAP의 Plain text 형태로 작성된다. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.2 관련문서 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1. 스마트 조명 시스템 – 제1부 일반 요구사항, KSC7751-1
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.3 적용범위 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
본 CoAP기반 조명/센서 디바이스 L-SLP API 규격서는 다음과 같은 분야를 포함한다.
GW-조명/센서 연동
GW-UD2 연동
GW-TS2 연동
위에서 정의한 분야별 L-SLP API에 대해 각각 다음과 같은 사항에 대하여 기술한다.
CoAP기반 API 명 및 정의
요청/응답 메시지 포맷 및 파라미터
결과 코드 정의
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.4 약어 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2. 디바이스 L-SLP API 규격 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.1 API 기본 정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.1.1 URI-Path
스마트 조명 시스템의 조명/센서 L-SLP는 CoAP기반으로 URL-Path는 다음과 같이 3가지 종류로 구분한다.
Base URL (base_url): coap://host_IP[:port]
기본 URI로 조명/센서 디바이스와 1:1 연결을 요구하는 URL이다.
Multicast URL (multi_url): coap://multicast_IP[:port]
Multicast 통신 환경을 제공하는 조명 네트워크에서 다수의 조명/센서 디바이스와 1:N 연결에 사용되는 URL이다.
Broadcast URL (broad_url): coap://broadcast_IP[:port]
Multicast 통신을 지원하지 않는 조명 네트워크에서 사용하는 다수의 조명/센서 디바이스와 1:N 연결에 사용되는 URL이다.
디바이스 전체/설치 탐색을 제외한 Broadcast IP로 수신되는 메시지는 오류 응답을 포함하여 모두 응답하지 않는다.
URL의 기본 포트번호(port)는 CoAP 기본 포트번호인 5683이며, 기본 포트번호를 사용하는 경우에는 URL에서 생략 가능하다.
2.1.2 Payload
조명/센서 L-SLP의 payload 필드 항목은 다음과 같은 조건(Constraint, C)을 가진다.
M (Mandatory, 필수): 필수로 포함되는 항목
O (Optional, 선택): 선택적으로 포함되는 항목
CM (Conditionaly Mandatory, 조건부 필수): 선행 항목의 값에따라 필수로 포함되는 항목
모든 가능한 항목이 선택 항목으로 구성되어 있어도 최소한 하나이상의 항목을 Payload에 포함되어 있어야 한다. 조명/센서 L-SLP의 응답 메시지에서는 다음과 같이 payload를 구성하여야 한다.
응답 메시지의 Payload에는 Payload의 맨 앞에 did 항목을 제공하여야 함
Request에서 수신한 속성 및 속성값 그대로 복사 또는 did만 포함
2.1.3 Attribute data type
디바이스 L-SLP 항목의 값은 다음과 같은 변수형을 가진다. L-SLP 항목의 모든 값은 문자열로 처리한다.
String: 문자열
Int8, Int16, Int32: 10진수 문자열 (8/16/32 비트)
UInt8, UInt16, UInt32: 부호없는 10진수 문자열 (8/16/32 비트)
Hex: 16진수 문자열
Float: 소수 문자열
Object: Attribute 집합
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.2 API 기능 확장 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL에는 쿼리스트링(query string)을 사용하여 사용자 입력 데이터를 전달할 수 있다. 이러한 쿼리스트링을 통하여 API의 기능을 다양하게 확장할 수 있다.
2.2.1 쿼리스트링 형식API의 엔드 포인드(end point) 주소에 “?”를 붙여 쿼리스트링의 시작을 알리고, 파라미터(parameter)와 값(value)로 구성된 파라미터 값을 추가하여 표시한다. 또한 “&”를 붙여 파라미터 값을 추가할 수 있다.
2.2.2 범위 제한
L-SLP 사용자는 URL-Path에 쿼리 파라미터로 모듈(mid) 또는 그룹(gid) 정보를 포함한 쿼리스트링을 추가함으로써 요청 범위를 제한하여 선택적으로 요청할 수 있다.
모듈로 제한
{base_url}/endpoint?mid={mid}
(ex) PATCH, {base_url}/light?mid=3 : mid=3인 모듈의 조명 상태정보 제어
그룹으로 제한
{base_url}/endpoint?gid={gid}
(ex) PATCH, {broad_url}/light?gid=10 : gid=10인 조명 상태정보 제어
2.2.3 속성 필터L-SLP 사용자는 URL-Path에 특정 속성을 포함한 쿼리스트링을 추가함으로써 요청 범위를 제한하여 선택적으로 요청할 수 있다. 속성 타입이 String, Int8/16/32, Float 등 단일 속성은 “attr” 파라미터를 사용하여 필터링할 수 있다. Object와 같은 다수의 단일 속성으로 구성된 객체 속성은 “attrs” 파라미터를 사용하여 필터링할 수 있다.
단일 속성 필터링
{base_url}/endpoint?attr={attribute}
(ex) GET, {base_url}/dinfo?attr=lib : 디바이스 기본정보중 위치정보만 요청
객체 속성 필터링
{base_url}/endpoint?attrs={attribute set}
(ex) GET, {base_url}/cap?attrs=gcap : 디바이스 Capability 정보중 Group capability 정보만 요청
2.2.4 속성 제한L-SLP 사용자는 URL-Path에 세부 속성의 특정 값을 포함한 쿼리스트링을 추가함으로써 요청 범위를 제한하여 선택적으로 요청할 수 있다.
특정 값 제한
{base_url}/endpoint?{attribute}={value}
(ex) GET, {base_url}/module/minfo?mclass=l : mclass가 l(조명)인 모듈들만의 모듈정보(minfo)
2.1.1 URI-Path
스마트 조명 시스템의 조명/센서 L-SLP는 CoAP기반으로 URL-Path는 다음과 같이 3가지 종류로 구분한다.
Base URL (base_url): coap://host_IP[:port]
기본 URI로 조명/센서 디바이스와 1:1 연결을 요구하는 URL이다.
Multicast URL (multi_url): coap://multicast_IP[:port]
Multicast 통신 환경을 제공하는 조명 네트워크에서 다수의 조명/센서 디바이스와 1:N 연결에 사용되는 URL이다.
Broadcast URL (broad_url): coap://broadcast_IP[:port]
Multicast 통신을 지원하지 않는 조명 네트워크에서 사용하는 다수의 조명/센서 디바이스와 1:N 연결에 사용되는 URL이다.
디바이스 전체/설치 탐색을 제외한 Broadcast IP로 수신되는 메시지는 오류 응답을 포함하여 모두 응답하지 않는다.
URL의 기본 포트번호(port)는 CoAP 기본 포트번호인 5683이며, 기본 포트번호를 사용하는 경우에는 URL에서 생략 가능하다.
2.1.2 Payload
조명/센서 L-SLP의 payload 필드 항목은 다음과 같은 조건(Constraint, C)을 가진다.
M (Mandatory, 필수): 필수로 포함되는 항목
O (Optional, 선택): 선택적으로 포함되는 항목
CM (Conditionaly Mandatory, 조건부 필수): 선행 항목의 값에따라 필수로 포함되는 항목
모든 가능한 항목이 선택 항목으로 구성되어 있어도 최소한 하나이상의 항목을 Payload에 포함되어 있어야 한다. 조명/센서 L-SLP의 응답 메시지에서는 다음과 같이 payload를 구성하여야 한다.
응답 메시지의 Payload에는 Payload의 맨 앞에 did 항목을 제공하여야 함
Request에서 수신한 속성 및 속성값 그대로 복사 또는 did만 포함
2.1.3 Attribute data type
디바이스 L-SLP 항목의 값은 다음과 같은 변수형을 가진다. L-SLP 항목의 모든 값은 문자열로 처리한다.
String: 문자열
Int8, Int16, Int32: 10진수 문자열 (8/16/32 비트)
UInt8, UInt16, UInt32: 부호없는 10진수 문자열 (8/16/32 비트)
Hex: 16진수 문자열
Float: 소수 문자열
Object: Attribute 집합
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.3 API 목록 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.3.1 리소스별 API 목록
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.4 디바이스 공통 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.4.1 디바이스 전체 탐색디바이스 전체 탐색 API는 설치시험기기(TS1) 또는 사용자 입력장치(UD1)이 스마트 조명 네트워크에 연결된 모든 디바이스를 탐색하는 API이다. 디바이스 전체 탐색 메시지를 수신한 디바이스는 모두 응답하여야 한다.
2.4.2 디바이스 설치 탐색디바이스 설치 탐색 API는 설치시험기기(TS1) 또는 사용자 입력장치(UD1)이 스마트 조명 네트워크에 연결된 디바이스중에서 설치가 미완료(LID 미할당)된 디바이스를 탐색하는 API이다. 위치주소(LID)를 하당받지 못한 디바이스는 모두 응답하여야 한다.
2.4.3 디바이스 식별디바이스 식별 API는 게이트웨이, 설치시험기기(TS1) 또는 사용자 입력장치(UD1)에서 디바이스 또는 그룹을 식별하기위하여 설정된 점멸 회수만큼 디바이스의 LED를 깜박거리게 하는 API이다. 디바이스 식별 API에는 디바이스 단위, 모듈 단위, 그룹 단위 식별로 구분된다.
1) 디바이스 식별 디바이스 단위로 식별하기 위한 API이다.
2) 모듈 식별 디바이스의 모듈 단위로 식별하기 위한 API인다.
3) 그룹 식별 그룹 단위로 식별하기 위한 API이다. 그룹 멤버 디바이스는 모두 응답하여야 한다. 방송 URL(broad_url)을 사용하는 그룹 식별 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다.
2.4.4 디바이스 전체정보 조회디바이스의 전체정보를 조회하는 API이다. 조회 가능한 디바이스의 전체정보에는 필수 항목으로 디바이스 기본정보(dinfo)와 수용능력 정보(cap)가 있고, 디바이스 기능에 따라 선택 항목인 조명 상태정보(light) 및 설정정보(lightconfig), 센서정보(sensor)가 있다. Payload 사이즈가 너무 커 디바이스가 보내기에 어려운 환경(통신방식)인 경우 Response code로 4.13 Request Entity Too Large를 응답하여야 한다. Response code 4.13으로 응답하는 디바이스는 수신 디바이스가 개별 조회가 가능하도록 디바이스 기본정보 조회와 디바이스 수용능력 조회를 제공하여야 하며, 지원 기능에 따라 조명 상태정보 조회, 조명 설정정보 조회 및 센서 설정정보 조회 API를 제공하여야 한다.
2.4.5 디바이스 기본정보 조회디바이스의 기본정보를 조회하는 API이다. 조회 가능한 디바이스의 기본정보에는 제조 과정에서 할당되는 디바이스 고유 물리주소(DPID, Physical ID), 제품코드(PC, Produce Code), 일련번호(SN, Serial Number)와 게이트웨이 또는 설치기에 의해 설정되는 디바이스의 논리주소(DID, Device ID), 메시지의 컨텐츠 규격(CT, Content Type), 디바이스의 위치주소(LID, Location ID)가 있다.
2.4.6 디바이스 기본정보 설정디바이스의 기본정보를 설정하는 API이다. 디바이스 기본정보에는 디바이스 물리주소(cpid), 제품코드(pc), 일련번호(sn), 프로파일 버전(bpv, lpv) 정보가 있다. 변경 가능한 기본정보에는 스마트 게이트웨이, 사용자 입력장치, 관제서버 등을 통하여 설정되는 논리주소(cid), 위치주소(lid), 이름(name)이 있다. 요청 메시지에 포함된 사용자 입력장치의 물리주소(cpid)는 요청 메시지를 수신한 사용자 입력장치가 수신자(변경 대상)가 자신인지 확인용으로만 사용되며 변경할 수 없는 속성이다.
2.4.7 디바이스 수용능력 조회디바이스가 가지고 있는 모듈, 그룹, 장면의 수용능력(Capability)를 조회하는 API이다.
2.4.8 디바이스 전체 모듈정보 조회디바이스에 장착된 전체 모듈에 대한 모듈정보를 조회하는 API이다. Payload 사이즈가 너무 커 디바이스가 보내기에 어려운 환경(통신방식)인 경우 Response code로 4.13 Request Entity Too Large를 응답하여야 한다. Response code 4.13으로 응답하는 디바이스는 수신 디바이스가 개별 조회가 가능하도록 디바이스 전체 모듈 기본정보 목록 조회를 제공하여야 하며, 디바이스 전체 모듈 기본정보 목록 조회를 통하여 획득한 지원 모듈 기능에 따라 조명 상태정보 조회, 조명 설정정보 조회 및 센서 설정정보 조회 API의 모듈조회를 제공하여야 한다.
2.4.9 디바이스 전체 모듈 기본정보 목록 조회디바이스에 장착된 모듈에 대한 기본정보 목록을 조회하는 API이다. 속성 제한을 통하여 특정 목록 조회가 가능하다. 예를들어, “mclass=l”로 속성 제한을 하면 조명 모듈만을 조회가 가능하다.
2.4.10 디바이스 개별 모듈 전체정보 조회디바이스의 개별 모듈에 대한 모듈 전체정보를 조회하는 API이다.
2.4.11 디바이스 개별 모듈 기본정보 조회디바이스의 개별 모듈에 대한 모듈 기본정보를 조회하는 API이다.
2.4.12 디바이스 재시작디바이스를 재시작하는 API이다. 디바이스는 응답 메시지를 전송 후 지연 시간만큼 대기 후 재시작한다. 디바이스 재시작시에는 NVM 데이터를 유지하여야 한다.
2.4.13 디바이스 공장초기화디바이스를 공장초기화하는 API이다. 디바이스는 응답 메시지를 전송 후 지연 시간만큼 대기 후 공장초기화를 시작한다. 디바이스 공장초기화시에는 NVM 데이터를 공장 초기상태로 복구하여야 한다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.5 조명 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.5.1 조명 상태정보 조회게이트웨이, UD1, TS1 등에서 디바이스의 조명 상태정보를 조회하는 API이다. 조명 기능을 제공하는 스마트 조명 디바이스는 조명의 현재 상태정보를 제공하여야 한다. 속성 필터를 사용하여 필요한 속성에 대해서만 조회를 할 수 있다. 조명 기능을 제공하는 스마트 조명 디바이스는 본 API를 지원하여야 한다.
2.5.1.1 전체 조명 모듈 조회모든 조명 모듈의 상태정보를 조회하는 API이다.
2.5.1.2 개별 조명 모듈 조회개별 조명 모듈의 상태정보를 조회하기 위해 사용하는 API이다.
2.5.2 조명 상태정보 변경 (조명 제어)조명 상태정보 변경 API는 게이트웨이, UD1, TS1 등이 스마트 조명 디바이스의 조명 모듈을 제어하기 위하여 사용하는 API이다. 조명 기능을 제공하는 스마트 조명 디바이스는 본 API를 지원하여야 한다.
2.5.2.1 전체 조명 모듈 동일 변경스마트 조명 디바이스가 단독 또는 여러 조명 모듈로 구성되어 있는 경우 디바이스의 모든 조명 모듈을 동일한 상태로 제어하기 위해 사용하는 API이다.
2.5.2.2 전체 조명 모듈 개별 변경다중 조명 모듈로 구성된 스마트 조명 디바이스의 전체 조명 모듈을 개별 설정하기 위해 사용하는 API이다.
2.5.2.3 개별 조명 모듈 변경스마트 조명 디바이스의 특정 조명 모듈만을 제어하기 위해 사용하는 API이다.
2.5.3 조명 설정정보 조회게이트웨이, UD1, TS1 등에서 디바이스의 조명 설정정보를 조회하는 API이다. 조명 설정정보중에서 점등정보(onconfig)는 포함하지 않는다. 점등정보는 별도 API를 통하여 제공한다. 조명 기능을 제공하는 스마트 조명 디바이스는 본 API를 지원하여야 한다.
2.5.3.1 전체 조명 모듈 조회디바이스의 모든 조명 모듈의 설정정보를 조회하기 위해 사용하는 API이다. 단독 조명 모듈인 조명 디바이스도 동일하게 응답한다.
2.5.3.2 개별 조명 모듈 조회디바이스의 개별 조명 모듈의 설정정보를 조회하는 API이다.
2.5.4 조명 설정정보 변경게이트웨이, UD1, TS1 등이 디바이스의 조명 설정정보를 설정하기 위한 API이다. 조명 설정정보 변경 API는 0.03(PUT) 코드와 0.06(PATCH) 코드를 모두 사용할 수있다. 0.03(PUT) 코드를 사용하는 경우 메시지에는 모든 속성을 포함하여야 한다. 포함되지 않은 속성이 있는 경우 해당 속성은 기본값으로 설정하여야 한다. 0.06(PATCH) 코드를 사용하는 경우 메시지에 포함된 속성만 변경하여야 한다. 조명 기능을 제공하는 스마트 조명 디바이스는 본 API를 지원하여야 한다. 2.5.4.1 전체 조명 모듈 동일 변경디바이스의 모든 조명 모듈의 설정정보를 동일한 설정으로 변경을 요청하는 API이다.
2.5.4.2 전체 조명 모듈 개별 변경디바이스의 모든 조명 모듈의 설정정보를 개별로 설정하도록 변경을 요청하는 API이다.
2.5.4.3 개별 조명 모듈 변경디바이스의 개별 조명 모듈에 대한 설정정보 변경을 요청하는 API이다.
2.5.5 조명 점등 상태정보 조회현재 디바이스의 조명상태를 조명이 점등될 때의 조명 점등 상태정보(lightconfit/onconfig) 조회를 요청하는 API이다.
1.1.5.1 전체 조명 모듈 조회디바이스의 모든 조명 모듈의 점등 상태정보를 조회하기 위해 사용하는 API이다. 단독 조명 모듈인 조명 디바이스도 동일하게 응답한다.
2.5.5.2 개별 조명 모듈 조회디바이스의 개별 조명 모듈의 점등 상태정보를 조회하는 API이다.
2.5.6 조명 점등 상태정보 변경조명이 점등될 때의 조명 상태정보 변경을 요청하는 API이다. 점등 상태정보는 디바이스의 flash memory에 저장되어 전원 차단 상태에서도 해당 정보를 유지하고 있어야 하고, 디바이스에 전원이 재공급되는 경우 또는 조명 설정정보(lightconfig)의 조명 상태복구(last_light) 속성이 비활성화(disable)인 경우에 flash memory에 설정된 조명 점등 상태정보(onconfig)로 점등되어야 한다. 조명 기능을 제공하는 모든 스마트 조명 디바이스는 본 API를 지원하여야 한다.
2.5.6.1 전체 조명 모듈 동일 변경디바이스의 모든 조명 모듈의 점등 상태정보를 변경하기 위해 사용하는 API이다. 설정 가능한 모든 속성을 포함하지 않는 경우에는 설정에 포함되지 않은 속성은 기존에 설정된 속성 값으로 동작하므로 실제 동작 결과는 다를 수 있다.
2.5.6.2 전체 조명 모듈 개별 변경디바이스의 전체 조명 모듈의 점등 상태정보를 개별로 변경하는 API이다.
2.5.6.3 개별 조명 모듈 변경디바이스의 개별 조명 모듈의 점등 상태정보를 변경하는 API이다.
2.5.7 현재 조명상태의 점등 상태정보 저장현재 디바이스의 조명상태를 조명이 점등될 때의 조명 점등 상태정보로 저장을 요청하는 API이다. 제공하는 조명 상태정보의 모든 속성에 대해 저장하여야 한다. 점등 상태정보는 디바이스의 flash memory에 저장되어 전원 차단 상태에서도 해당 정보를 유지하고 있어야 하고, 디바이스에 전원이 재공급되는 경우 또는 조명 설정정보(lightconfig)의 조명 상태복구(last_light) 속성이 비활성화(disable)인 경우에 flash memory에 설정된 조명 점등 상태정보(onconfig)로 점등되어야 한다.
2.5.7.1 전체 조명 모듈 저장디바이스의 모든 조명 모듈의 점등 상태정보를 현재 상태로 변경하기 위해 사용하는 API이다. 단독 조명 모듈인 조명 디바이스도 동일하게 응답한다.
2.5.7.2 개별 조명 모듈 저장디바이스의 개별 조명 모듈의 점등 상태정보를 현재 상태로 변경하기 위하여 사용하는 API이다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.6 센서 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.6.1 센서 공통 설정정보 조회본 절에서는 게이트웨이, UD1, TS1 등에서 디바이스의 센서 설정정보를 조회하는 API의 기본 구조를 제시한다. 센서 설정정보의 세부 항목들은 센서의 종류(minfo/mtype)와 센서의 출력 형식(sensor/vtype)에 따라 달라질 수 있다. 센서는 문의 개폐 상태, 인지 상태 등을 문자열(string) 형태의 상태(status) 정보를 제공하는 Status형 센서와 온도, 습도, 조도 등을 정수(uint) 또는 실수(float) 형태의 값(value)을 제공하는 Value형 센서로 구분한다.
2.6.1.1 전체 센서 모듈 조회디바이스의 전체 센서 모듈에 대한 공통 설정정보를 조회하는 API이다. 센서 공통 설정정보는 센서 모듈의 종류와 출력 형식과 무관하게 공통으로 제공되는 설정정보이다.
2.6.1.2 특정 센서종류 조회디바이스의 전체 센서 모듈 중에서 특정 센서종류의 공통 설정정보를 조회하는 API이다.
2.6.2 센서 개별 설정정보 조회센서 개별 설정정보 조회 API는 디바이스의 개별 센서 모듈에 대한 모든 설정정보를 조회하는 API이다.
2.6.2.1 Status형 응답Status형 센서의 응답에서는 문의 개폐 상태, 인지 상태 등을 문자열(string) 형태의 상태(status) 정보를 제공한다.
2.6.2.2 Value형 응답Value형 센서의 응답에서는 온도, 습도, 조도 등을 정수(uint) 또는 실수(float) 형태의 값(value)을 제공한다.
2.6.3 센서 공통 설정정보 변경본 절에서는 게이트웨이, UD1, TS1 등에서 디바이스의 센서 설정정보를 설정하는 API의 기본 구조를 제시한다. 개별 센서의 형식(vtype)과 센서 종류에 따라 세부 항목은 달라질 수 있다.
2.6.3.1 전체 센서 모듈 동일 변경디바이스의 모든 센서 모듈을 동일하게 설정하기 위해 사용하는 API이다.
2.6.3.2 특정 센서종류 동일 변경디바이스의 전체 센서 모듈중에서 동일한 센서종류에 대하여 모든 센서의 설정정보를 동일하게 변경하기 위해 사용하는 API이다. 특정 센서종류의 설정정보 속성들은 동일하므로 모든 변경가능한 설정정보를 포함한다.
2.6.4 센서 개별 설정정보 변경센서 개별 설정정보 변경 API는 디바이스의 개별 센서 모듈에 대한 모든 설정정보를 변경하는 API이다.
2.6.4.1 Status형 센서 모듈 변경Status형 센서 모듈에 대한 모든 설정정보를 변경하는 API이다.
2.6.4.2 Value형 센서 모듈 변경Value형 센서 모듈에 대한 모든 설정정보를 변경하는 API이다.
2.6.5 센서 출력정보 조회본 절에서는 센서 모듈의 출력정보를 조회하는 API를 제시한다.
2.6.5.1 전체 센서 모듈 조회디바이스의 전체 센서 모듈에 대한 센서 출력을 조회하는 API이다. 요청 메시지에 관찰(Observe) 옵션이 포함된 경우 디바이스는 센서 설정정보의 센서 출력정보 보고 주기(rperiod) 마다 센서 출력정보를 포함하는 응답 메시지를 전송하여야 한다. 센서 모듈별 보고 주기가 다른 경우 가장 큰 값을 사용한다.
2.6.5.2 특정 센서타입 조회디바이스의 전체 센서 모듈 중에서 특정 센서종류의 센서 출력을 조회하는 API이다. 요청 메시지에 관찰(Observe) 옵션이 포함된 경우 디바이스는 센서 설정정보의 센서 출력정보 보고 주기(rperiod) 마다 센서 출력정보를 포함하는 응답 메시지를 전송하여야 한다. 센서 모듈별 보고 주기가 다른 경우 가장 큰 값을 사용한다.
2.6.5.3 개별 센서 모듈 조회디바이스의 개별 센서 모듈 단위로 센서 출력을 조회하는 API이다. 개별 센서 모듈의 센서 출력 조회에서는 센서의 종류와 센서 데이터의 형식을 포함하지 않는다. 요청자는 개별 센서 모듈의 센서의 종류와 센서 데이터의 형식을 알고 있어야 한다. 요청 메시지에 관찰(Observe) 옵션이 포함된 경우 디바이스는 센서 설정정보의 센서 출력정보 보고 주기(rperiod) 마다 센서 출력정보를 포함하는 응답 메시지를 전송하여야 한다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.7 그룹 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.7.1 그룹 등록스마트 조명 디바이스에 그룹 등록을 요청하는 API이다.
2.7.2 그룹 목록 조회
2.7.2.1 그룹 전체 목록 조회스마트 조명 디바이스에 등록된 전체 그룹 정보를 조회하는 API이다.
2.7.2.2 그룹 논리주소 목록 조회스마트 조명 디바이스에 등록된 전체 그룹의 논리주소를 조회하는 API이다.
2.7.3 그룹 수용능력 조회스마트 조명 디바이스의 그룹 수용능력을 조회하는 API이다.
2.7.4 그룹 구성정보 조회스마트 조명 디바이스에 등록된 그룹의 구성정보를 조회하는 API이다.
2.7.5 그룹 구성정보 수정스마트 조명 디바이스에서의 그룹 구성정보 수정을 요청하는 API이다. 그룹 구성정보 수정요청 API에서는 그룹의 이름, 멤버 종류 및 모듈 목록 정보 변경을 제공한다. 디바이스의 그룹 포함 여부가 변경된 경우에는 개별 디바이스에 그룹 등록 API 또는 그룹 삭제 API를 통하여 그룹 포함 여부를 변경하여야 한다.
2.7.6 그룹 조명 상태정보 변경 (그룹 조명 제어)게이트웨이, UD1, TS1 등이 그룹으로 디바이스의 조명을 제어하기 위하여 사용하는 API이다. 방송 URL(broad_url)을 사용하는 그룹 조명 제어 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 상태 변경 유무는 조회를 통하여 확인할 수 있다.
2.7.7 그룹 조명 설정정보 변경게이트웨이, UD1, TS1 등이 그룹에 포함된 모든 조명 디바이스의 조명 설정정보를 동일하게 설정하기 위한 API이다. 방송 URL(broad_url)을 사용하는 그룹 조명 설정변경 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 설정변경 유무는 조회를 통하여 확인할 수 있다.
2.7.8 그룹 센서 설정정보 변경1.1.8.1 그룹 센서 공통 설정정보 변경게이트웨이, UD1, TS1 등이 그룹에 포함된 모든 센서 디바이스의 센서 설정정보중 Status형과 Value형의 공통 속성에 대하여 동일하게 설정정보를 변경하기 위한 API이다. 방송 URL(broad_url)을 사용하는 그룹 센서 설정정보 변경 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 설정변경 유무는 조회를 통하여 확인할 수 있다.
2.7.8.2 특정 센서종류의 그룹 센서 설정정보 변경게이트웨이, UD1, TS1 등이 그룹에 포함된 모든 그룹의 전체 멤버중에서 동일한 센서종류의 센서 디바이스에 대하여 설정정보를 동일하게 변경하기 위해 사용하는 API이다. 특정 센서종류의 설정정보 속성들은 동일하므로 모든 변경가능한 설정정보를 포함한다. 방송 URL(broad_url)을 사용하는 그룹 센서 설정정보 변경 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 설정변경 유무는 조회를 통하여 확인할 수 있다.
2.7.9 그룹 삭제조명/센서 디바이스에 등록된 그룹 정보 삭제를 요청하는 API이다. 조명/센서 디바이스의 그룹 정보 삭제 요청은 그룹 멤버중 특정 조명/센서 디바이스가 그룹의 멤에서 삭제되는 개별 멤버 삭제와 해당 그룹의 정보 전체가 삭제되어 그룹의 모든 멤버 디바이스에 그룹 정보 삭제 요청을 전송하는 전체 멤버 삭제에 사용할 수 있다. 개별 멤버 삭제의 경우에는 해당 디바이스에만 그룹 삭제 요청을 할 수 있도록 Base URL(base_url)을 사용하여야 하며, 전체 멤버 삭제의 경우에는 Broadcast URL(broad_url)을 사용할 수 있다. 2.7.9.1 개별 그룹 삭제특정 그룹 논리주소를 지정하여 요청함으로써 조명/센서 디바이스에 저장된 특정 그룹 정보를 삭제하는 경우에 사용한다. 방송 URL(broad_url)을 사용한 그룹 삭제 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 삭제 유무는 조회를 통하여 확인할 수 있다.
2.7.9.2 전체 그룹 삭제그룹 논리주소에 모든 그룹을 나타내는 그룹 논리주소인 65535를 사용하여 디바이스에 등록된 모든 그룹 정보를 삭제하는 경우에 사용한다. 전체 디바이스의 그룹 전체 삭제의 경우 본 메시지를 수신한 모든 디바이스는 모든 그룹 정보를 삭제하여야 한다. 방송 URL(broad_url)을 사용한 전체 그룹 삭제 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 삭제 유무는 조회를 통하여 확인할 수 있다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.8 장면 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.8.1 장면 등록스마트 조명 디바이스에 장면(scene) 등록을 요청하는 API이다.
2.8.2 현재 상태 장면 등록조명 디바이스의 현재 조명 제어 상태를 장면(scene)으로 등록 요청하는 API이다.
2.8.3 장면 목록 조회
2.8.3.1 장면 전체 목록 조회조명 디바이스에 등록된 모든 장면(Scene) 정보를 조회하는 API이다.
1.1.3.2 장면 논리주소 목록 조회조명 디바이스에 등록된 모든 장면의 논리주소 목록을 조회하는 API이다.
2.8.4 장면 수용능력 조회조명 디바이스의 장면 수용능력을 조회하는 API이다. 장면 수용능력에는 수용 가능한 장면의 개수와 현재 사용중인 장면의 개수 정보가 포함된다.
2.8.5 장면 설정정보 조회조명 디바이스에 등록된 장면 설정정보를 조회하는 API이다.
2.8.6 장면 설정정보 변경조명 디바이스에 장면(scene) 설정정보 변경을 요청하는 API이다. s
2.8.7 장면 호출조명 디바이스에 장면(scene)이 수행되도록 호출하는 API이다. 방송 URL(broad_url)을 사용하는 장면 호출 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 호출 유무는 조회를 통하여 확인할 수 있다.
2.8.8 장면 삭제조명 디바이스에 등록된 장면(Scene)의 삭제를 요청하는 API이다. 조명/센서 디바이스의 장면 정보 삭제 요청은 장면 멤버중 특정 조명/센서 디바이스가 장면의 멤에서 삭제되는 개별 멤버 삭제와 해당 장면의 정보 전체가 삭제되어 장면의 모든 멤버 디바이스에 장면 정보 삭제 요청을 전송하는 전체 멤버 삭제에 사용할 수 있다. 개별 멤버 삭제의 경우에는 해당 디바이스에만 장면 삭제 요청을 할 수 있도록 Base URL(base_url)을 사용하여야 하며, 전체 멤버 삭제의 경우에는 Broadcast URL(broad_url)을 사용할 수 있다.
2.8.8.1 개별 장면 삭제특정 논리주소를 지정하여 요청함으로써 조명/센서 디바이스에 저장된 특정 장면 정보를 삭제하는 경우에 사용한다. 방송 URL(broad_url)을 사용한 개별 장면 삭제 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 삭제 유무는 조회를 통하여 확인할 수 있다.
2.8.8.2 전체 장면 삭제장면 논리주소에 모든 장면을 나타내는 장면 논리주소인 65535를 사용하여 디바이스에 등록된 모든 장면 정보를 삭제하는 경우에 사용한다. 전체 디바이스의 장면 전체 삭제의 경우 본 메시지를 수신한 모든 디바이스는 모든 장면 정보를 삭제하여야 한다. 방송 URL(broad_url)을 사용한 전체 장면 삭제 요청은 방송(broadcast) 메시지로 전송되어 다수의 메시지 수신자로부터 다수의 응답 메시지를 발생시킬 수 있다. 이런 경우 요청자는 CoAP 메시지 종류(type)를 비신뢰성 메시지 전송(Non-confirmable)로 선택할 수 있다. 비신뢰성 메시지 전송(Non-confirmable)로 요청하는 경우 삭제 유무는 조회를 통하여 확인할 수 있다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.9 고장 API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2.9.1 고장정보 조회게이트웨이, UD1, TS1 등에서 디바이스의 조명 또는 센서의 고장 정보를 조회하는 API이다. 스마트 조명 디바이스는 고장정보 조회 API를 통하여 고장정보를 조회하지 않더라도 고장이 발생하거나 해제되었을 경우 디바이스는 게이트웨이 L-SLP의 고장정보 보고 API를 사용하여 디바이스의 고장정보 변경 사항을 게이트웨이에 보고하여야 한다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3. 코드 정의 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3.1 CoAP 코드 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3.1 CoAP 코드RFC 7252 “The Constrained Application Protocol (CoAP)” 표준 및 RFC 8132 “PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)”에 정의된 코드이다. 3.1.1 CoAP method codes
3.1.2 CoAP response codes
스마트 조명 조명/센서 L-SLP 규격에서는 RFP 7252 및 RFP 8132에서 정의한 메소드별 응답 코드중 지원하는 응답 코드는 아래와 같다.
GET 응답
처리에 성공한 경우 2.05 (Content)
POST 응답
새로운 리소스 생성 요청 처리에 성공한 경우 2.01(Created) 응답
처리는 성공하였으나 새로운 리소스가 생성되지는 않은 경우 2.04(Changed) 응답
PUT/PATCH 응답
리소스 수정에 성공한 경우 2.04(Changed) 응답
DELETE 응답
삭제 요청 처리는 성공한 경우 2.02(Deleted) 응답
스마트 조명 조명/센서 L-SLP 규격에서 지원하지 않는 RFP 7252 및 RFP 8132에서 정의한 메소드별 응답 코드는 아래와 같다.
GET 응답
처리에 성공한 경우의 2.03 (Valid) 응답
- 모든 응답에는 Content를 포함하여야 한다.
POST 응답
처리는 성공하였으나 리소스가 삭제되는 경우 2.02(Deleted) 응답
- POST에 의해서 리소스가 삭제되는 경우가 발생할 수 있는 스마트 조명 API는 없다.
PUT/PATCH 응답
요청 처리의 결과로 새로운 리소스가 생성되는 경우 2.01(Created) 응답
- PUT/PATCH에 의해서 리소스가 생성되는 경우가 발생할 수 있는 스마트 조명 API는 없다.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3.2 API 에러 코드 정의 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3.2 API 에러 코드 정의3.2.1 L-SLP 에러 코드 형식L-SLP 에러 코드는 응답메시지의 Payload에 아래 속성으로 제공한다.
L-SLP 에러 코드의 형식은 다음과 같다.
3.2.2 L-SLP API 에러 코드
3.2.3 에러 예제3.2.3.1 Attribute 속성 값 에러
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4. 메시지 예제 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4.1 필터 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4.1 필터4.1.1 모듈 기본정보 조회 속성 필터링2.4.9 디바이스 전체 모듈 기본정보 목록 조회 API에서 모듈 기본정보에 포함된 속성들을 이용하여 필터를 사용하면 특정 모듈만 목록 조회가 가능하다. 필터의 {attr}에는 모듈 기본정보(minfo)의 항목중 하나가 들어갈 수 있다.
1) 예제 : 조명 모듈 조회
2) 예제 : 온도 센서 모듈 목록 조회
|