서브 디바이스 제어

POST /devices/{device_id}/control

서브 기기를 제어할 수 있습니다. 가능한 기기 제어 명령은 capability에 작성되어 있습니다.

기기가 사용하는 capability 정보는 기기 정보 조회, 혹은 기기의 profile 조회를 하여 확인할 수 있습니다. response에서 component의 id와 버전을 확인한 후, capability 가져오기 API를 사용하여 확인할 수 있습니다. Capability에 대한 정의는 Capability를 확인해주시기 바랍니다.

Request

URL : http://{device_ip}:5003/devices/{device_id}/control

METHOD : POST

Header

• None

Parameter (Path)

• device_id (String) *: 제어할 기기의 id

Parameter (Body)

• component (String) *: 제어에 사용할 명령어가 정의된 capability의 component

• capability (String) *: 제어에 사용할 명령어가 정의된 capability id

• command (String) *: 제어에 사용할 명령어. capability의 commands에 정의 되어있어야 함

• arguments (object) *: command에서 사용할 arguments를 key, value 형태로 정의함. capability의 command 정의에 포함되지 않은 argument를 추가로 보내는 경우, 해당 데이터는 무시됨. 만약 필수로 포함되어야하는 argument가 포함되지 않은 경우는 에러 발생

Request Example

{
    "component": "main",
    "capability": "webOSTV",
    "command": "setVolume",
    "arguments": {
        "volume": 20
     
    }
}

Response

Type: Object

• resultCode (String) * : API 수행 결과 코드 값

• result (Object) * : 기기 제어 요청 결과

  • requestId (String) * : 제어 요청 결과를 확인하기 위한 id

Response Example

{
    "resultCode": "0000",
    "result": {
        "requestId": "6a525465-4def-49ef-9027-10da2c94bfeb"
    }
}