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
  • create-component
  • Command
  • Usage
  • delete-component-version
  • Command
  • Usage
  • delete-component
  • Command
  • Usage
  • list-component-versions
  • Command
  • Usage
  • list-components
  • Command
  • Usage
  1. FUNDAMENTALS
  2. DAMDA Tools
  3. DAMDA CLI

Component

Commands to create/delete/list components

create-component

Command to create compnent version.

--source must be a zip file path of the source

Createing public components is not yet supported

--type PUBLIC is not supported

The configuration file follows the following structre

Json file

Key
Required
Explaination

id

Required

component id ex) com.example.first

version

Required

component version ex) 1.0.0

description

Required

component description ex) first application

thumbnail

Optional

component thumbnail The thumbnail should be in the same location as the config file(--configuration-file) ex) icon.png

script

Required

script to run the component ex) pip3 install -r requirements.txt;python3 main.py

link

Optional

in the case of a web application, a link to access the application ex) http://127.0.0.1:3000

title

Requried

component title ex) My First App

Command

$ damda create-component [OPTIONS]
# Options:
#  --source PATH: [required]
#  --configuration-file PATH: [required]
#  --type TEXT: [defulat: CUSTOM] [CUSTOM | PUBLIC]
#  --profile TEXT: [default: default]

Usage

Recommanded Component structure (example)

# com.example.first_0.0.1.json
{
   "id":"com.example.first",
   "version": "1.0.2",
   "description": "Sample Component",
   "thumbnail": "icon.png",
   "script": "python3 {root}/first/first.py",
   "link": "",
   "title": "Frist app"
}
$ cd <COMPONENT_PROJECT_DIR>
$ damda create-component --source ./first.zip --configuration-file ./com.example.first.json

delete-component-version

Delete a specific version of a component.

Command

$ damda delete-component-version [OPTIONS]
# Options:
#  --component-id TEXT: [required]
#  --component-version TEXT: [required]
#  --profile TEXT: [default: default]

Usage

$ damda delete-component-version --component-id com.example.first --component-version 1.0.0

delete-component

Delete all versions of a component

Command

$ damda delete-component [OPTIONS]
# Options:
#  --component-id TEXT: [required]
#  --profile TEXT: [default: default]

Usage

$ damda delete-component --component-id com.example.first

list-component-versions

Retrieves a list of versions of a component.

Command

$ damda list-component-versions [OPTIONS]
# Options
#   --component-id TEXT: [required]
#   --profile TEXT: [default: default]

Usage

$ damda list-component-versions --component-id com.example.first
['1.0.2', '1.0.1', '1.0.0']

list-components

Retrieves a list of CUSTOM or PUBLIC components.

Command

$ damda list-component-versions [OPTIONS]
# Options:
#  --component-id TEXT: [required]
#  --profile TEXT: [default: default]

Usage

cast 1) list CUSTOM components

$ damda list-components
[{"componentName":"com.example.first","latestVersion":"1.0.2"}]

cast 2) list PUBLIC components

$ damda list-components --tpye PUBLIC
[{"componentName":"com.damda.webostv","latestVersion":"1.0.4"},
{"componentName":"com.damda.voice","latestVersion":"1.0.4"},
{"componentName":"com.damda.thinq-web","latestVersion":"1.0.15"},
{"componentName":"com.damda.thinq-backend-api","latestVersion":"1.1.1"},
{"componentName":"com.damda.instaview.resource","latestVersion":"1.0.0"},
{"componentName":"com.damda.instaview.home","latestVersion":"1.0.0"},
{"componentName":"com.damda.home","latestVersion":"1.0.6"}]

PreviousConfigurationNextDevice

Last updated 2 years ago