차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

차이 보기로 링크

양쪽 이전 판 이전 판
다음 판 		이전 판
다음 판 양쪽 다음 판
ko:sdk_api [2018/11/27 21:48]
kyle 		ko:sdk_api [2018/12/07 13:26]
jbkim [upgradeFirmware]
줄 2: 줄 2:
 =====initialize===== =====initialize=====
 SDK를 초기화합니다. ​ SDK를 초기화합니다. ​
-<​code>​+<​code ​java>
 void initialize(Context context, DeviceListener listener) ​ void initialize(Context context, DeviceListener listener) ​
 </​code>​ </​code>​
-\\ 
 === 파라미터 ===  === 파라미터 === 
-  * context : android application context +  * ''​context'' ​: 어플리케이션 콘텍스트 
-  * listener : DeviceListener는 ​장치로부터 콜백 데이터가 수신되는 콜백 리스너입니다. ​ +  * ''​listener'' ​: 장치로부터 콜백 데이터가 수신되는 콜백 리스너 
 +<callout type="​info">​ 
 +[[references#​DeviceListener|DeviceListener 클래스 보기]] 
 +</​callout>​
 <callout type="​info"​ icon="​true">​ <callout type="​info"​ icon="​true">​
-이 함수가 호출되지 않으면 SDK가 정상적으로 동작하지 않습니다. 애플리케이션을 실행한 뒤 가능한 빨리 호출되어야 합니다.+이 함수가 호출되지 않으면 SDK가 정상적으로 동작하지 않습니다.\\ 애플리케이션을 실행한 뒤 가능한 빨리 호출되어야 합니다.
 </​callout>​ </​callout>​
 \\ \\
줄 17: 줄 18:
 =====run===== =====run=====
 SDK 서비스를 실행합니다. ​ SDK 서비스를 실행합니다. ​
-<​code>​+<​code ​java>
 int run() int run()
 </​code>​ </​code>​
-\\ 
 ===응답 코드 === ===응답 코드 ===
-성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. ​+성공적으로 수행될 경우 ​''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. ​
 <callout type="​info"​ icon="​true">​ <callout type="​info"​ icon="​true">​
-SDK는 단일 애플리케이션에서만 사용 가능하도록 개발되었습니다. 다른 애플리케이션에서 동시 사용할 수 없으니 주의하십시오. ​+SDK는 단일 애플리케이션에서만 사용 가능하도록 개발되었습니다.\\ 다른 애플리케이션에서 동시 사용할 수 없으니 주의하십시오. ​
 </​callout>​ </​callout>​
 \\ \\
줄 30: 줄 30:
 =====getVersion===== =====getVersion=====
 SDK / Firmware 버전을 가져옵니다. ​ SDK / Firmware 버전을 가져옵니다. ​
-<​code>​+<​code ​java>
 int getVersion(Version version) int getVersion(Version version)
 </​code>​ </​code>​
-\\ 
 ===파라미터=== ===파라미터===
-  * version : SDK / Firmware 버전 +  * ''​version'' ​: SDK / Firmware 버전 
-\\+<callout type="​info">​ 
 +[[references#​Version|Version 클래스 보기]] 
 +</​callout>​
 ===응답 코드=== ===응답 코드===
-성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다.+성공적으로 수행될 경우 ​''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.
  
-\\ \\+\\
 =====setCardType===== =====setCardType=====
 RF 카드 타입을 설정합니다. RF 카드 타입을 설정합니다.
-<​code>​+<​code ​java>
 int setCardType(int cardType) int setCardType(int cardType)
 </​code>​ </​code>​
 +===파라미터===
 +  * ''​cardType''​ : RF 카드 타입
 +<WRAP group 50%>
 +^  값  ^설명 ​ ^
 +|  1  |HIGH_FREQUENCY ​ |
 +|  2  |HIGH_FREQUENCY_ICLASS ​ |
 +|  3  |LOW_FREQUENCY ​ |
 +|  4  |LOW_FREQUENCY_PROX ​ |
 +</​WRAP>​
 +===응답 코드===
 +성공적으로 수행될 경우 ''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.
 +
 \\ \\
 +=====connectFtpServer=====
 +FTP 서버에 연결합니다.
 +<code java>
 +int connectFtpServer(FirmwareOption option)
 +</​code>​
 ===파라미터=== ===파라미터===
-  * cardType ​: RF 카드 타입 (1 - HIGH_FREQUENCY,​ 2 - HIGH_FREQUENCY_ICLASS,​ 3 - LOW_FREQUENCY,​ 4 - LOW_FREQUENCY_PROX)+  * ''​option''​: 펌웨어 파일 옵션 
 +<callout type="​info">​ 
 +[[references#​FirmwareOption|FirmwareOption 클래스 보기]] 
 +</​callout>​ 
 +===응답 코드=== 
 +성공적으로 수행될 경우 ''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. 
 +<callout type="​info"​ icon="​true">​ 
 +펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\ 
 +해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다.  
 +<code xml> 
 +<uses-permission android:​name="​android.permission.INTERNET"/>​ 
 +<uses-permission android:​name="​android.permission.WRITE_EXTERNAL_STORAGE"​ /> 
 +</​code>​ 
 +</​callout>​ 
 \\ \\
 +=====disconnectFtpServer=====
 +FTP 서버에 연결을 해제합니다.
 +<code java>
 +int disconnectFtpServer()
 +</​code>​
 ===응답 코드=== ===응답 코드===
-성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다.+성공적으로 수행될 경우 ​''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. 
 +<callout type="​info"​ icon="​true">​ 
 +펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\ 
 +해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다.  
 +<code xml> 
 +<​uses-permission android:​name="​android.permission.INTERNET"/>​ 
 +<​uses-permission android:​name="​android.permission.WRITE_EXTERNAL_STORAGE"​ /> 
 +</​code>​ 
 +</​callout>​
  
 +\\
 +=====getFirmwareFileList=====
 +FTP 서버의 파일 이름 목록을 얻어옵니다.
 +<code java>
 +int getFirmwareFileList(ArrayList<​String>​ fileList)
 +</​code>​
 +===파라미터===
 +  * ''​fileList'':​ 파일 이름 목록
 +===응답 코드===
 +성공적으로 수행될 경우 ''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.
 +<callout type="​info"​ icon="​true">​
 +펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\
 +해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다. ​
 +<code xml>
 +<​uses-permission android:​name="​android.permission.INTERNET"/>​
 +<​uses-permission android:​name="​android.permission.WRITE_EXTERNAL_STORAGE"​ />
 +</​code>​
 +</​callout>​
 +
 +\\
 +=====upgradeFirmware=====
 +지정된 펌웨어 파일로 업그레이드 파일을 복사합니다.
 +<code java>
 +int upgradeFirmware(FirmwareOption option)
 +</​code>​
 +===파라미터===
 +  * ''​option'':​ 펌웨어 파일 옵션
 +<callout type="​info">​
 +[[references#​FirmwareOption|FirmwareOption 클래스 보기]]
 +</​callout>​
 +===응답 코드===
 +성공적으로 수행될 경우 ''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.
 +<callout type="​info"​ icon="​true">​
 +펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\
 +해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다. ​
 +<code xml>
 +<​uses-permission android:​name="​android.permission.INTERNET"/>​
 +<​uses-permission android:​name="​android.permission.WRITE_EXTERNAL_STORAGE"​ />
 +</​code>​
 +</​callout>​
 +
 +\\
 +=====rebootDevice=====
 +장치를 다시 시작합니다.
 +<code java>
 +int rebootDevice()
 +</​code>​
 +===응답 코드===
 +성공적으로 수행될 경우 ''​SUCCESS''​를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.
 +<callout type="​info"​ icon="​true">​
 +펌웨어 업그레이드는 장치 재시작 시 진행됩니다.
 +</​callout>​