DAMDA Docs
  • DAMDA Overview
  • Quick Start
    • 개발환경 구성하기
    • Hello DAMDA 따라하기
    • ThinQ 연결하기
    • 내 컴포넌트 로그 확인하기
    • 내 컴포넌트 원격 제어하기
  • FUNDAMENTALS
    • DAMDA 기기
      • DAMDA Installer
        • DAMDA Installer 설치하기
        • DAMDA 설치하기
        • DAMDA 삭제하기
        • DAMDA Installer 삭제하기
      • DAMDA Debugging Console
      • DAMDA Home
        • 기기 등록 하기
        • 기기 등록 해제하기
      • Custom Sub Device
        • Capability
        • Profile
        • Functions
    • DAMDA Cloud
      • 계정 관리
        • 계정 생성하기
        • 기타
      • 컴포넌트 관리
        • DAMDA Components
        • 컴포넌트 초기화하기
        • 컴포넌트 개발하기
        • 컴포넌트 생성하기
        • 컴포넌트 배포하기
    • DAMDA Tools
      • DAMDA CLI
        • Configuration
        • Component
        • Device
        • Deployment
      • DAMDA Simulator
  • REFERENCE
    • API Reference
      • ThinQ API
        • APIs
          • ThinQ 계정 등록
          • 사용자 홈 목록 가져오기
          • 사용자 기기 목록 가져오기
          • 기기 등록하기
          • 기기 정보 가져오기
          • 기기 제어하기
          • 기기 삭제하기
          • 기기 정보 전달하기
        • Error / Exceptions
      • Hub API
        • APIs
          • 지원 기기타입 가져오기
          • 기기 profile 가져오기
          • Capability 가져오기
          • 서브 디바이스 등록하기
          • 서브 디바이스 삭제하기
          • 등록 / 삭제 결과 확인하기
          • 서브 디바이스 리스트 조회
          • 서브 디바이스 정보 조회
          • 서브 디바이스 상태 조회
          • 서브 디바이스 제어
          • 제어 결과 확인
          • 서브 디바이스 상태 모니터링
          • 전체 서브 디바이스 상태 모니터링
        • Types
          • Device
          • DeviceState
      • 가전 API
        • 가전 상태 조회
        • 가전 제어
        • APIs
          • 공통 | Headers
          • 공통 | Response
          • 공통 | Error
          • 가전 목록 조회
          • 가전 상태 조회
          • 가전 Profile 조회
          • 가전 제어
          • EMP Access Token 발급
          • Event/Push Callback (Websocket)
        • Types
          • Device Type
          • Device Profile
      • webOS TV API
        • TV 리스트 조회
        • TV 등록
        • Custom SSAP Command
        • Control
          • ON/OFF
          • Channel
          • Audio
          • App
          • UI 및 기타
        • Remote
        • Subscribe
    • Samples
      • Hello DAMDA
      • ThinQ 연결하기
      • Debugging App
      • 가전 App
      • Proto Sub Device
      • TV화면 캡쳐 + AWS Rekognition
      • DAMDA Hub
Powered by GitBook
On this page
  1. REFERENCE
  2. API Reference
  3. Hub API
  4. APIs

서브 디바이스 등록하기

PreviousCapability 가져오기Next서브 디바이스 삭제하기

Last updated 2 years ago

POST /devices

서브 기기를 등록하는 API입니다. 기기 등록 시 필요한 정보는 각 기기의 profile에 되어 있습니다. 기기 등록을 호출 한 후, 등록 절차 완료 여부는 등록 / 삭제 결과 확인하기를 사용하여 확인할 수 있습니다.

Request

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

METHOD : POST

Header

  • None

Parameter

  • alias (String) * : 기기를 구분하기 위한 이름

  • deviceType (String) * : 등록할 기기의 타입

  • preferences (Object) * : 기기를 등록하기 위해 필요한 정보. 에서 확인 가능

Request Example

{
    "alias": "거실 TV",
    "deviceType": "webOSTV",
    "preferences":{
        "ip": "127.0.0.1"
    }
}

Response

Type: Object

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

  • result (Object) * : 등록 진행하는 기기의 정보

  • registerId (String) * : 기기 등록이 성공했는지 확인하기 위한 ID

Response Example

{
    "resultCode": "0000",
    "result": {
        "device": {
            "deviceId": "05f246ad-f6fa-49b4-b90c-d9a908eabe5d",
            "deviceType": "webOSTV",
            "deviceState": {},
            "alias": "거실 TV",
            "registeredAt": 1660262581,
            "preferences": {
                "ip": "127.0.0.1"
            },
            "profile": {
                "deviceType": "webOSTV",
                "name": "webOS",
                "components": [
                    {
                        "label": "main",
                        "id": "main",
                        "capabilities": [
                            {
                                "id": "webOSTV",
                                "version": 1
                            }
                        ]
                    }
                ],
                "status": "DEVELOPMENT",
                "preferences": [
                    {
                        "title": "IP Address",
                        "name": "ip",
                        "description": "IP address of the webOS TV",
                        "required": true,
                        "type": "string"
                    }
                ]
            }
        },
        "registerId": "9ff4eae9-41b6-4d8e-b828-723458a5e6db"
    }
}

등록을 위해 만들어진 기기 정보가 리턴됨. 실제로 등록이 완료되었는지는 를 호출하여 확인필요. 결과 확인을 위해 response에 포함된 registerId를 사용

device (Object) * : 타입으로 정의되어 있음

preference라는 key값으로 정의
Profile
등록/삭제 확인 API
Device