차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
양쪽 이전 판 이전 판 다음 판 | 이전 판 다음 판 양쪽 다음 판 | ||
ko:sdk_api [2018/12/03 16:22] jbkim [connectFtpServer] |
ko:sdk_api [2018/12/26 10:05] jbkim |
||
---|---|---|---|
줄 6: | 줄 6: | ||
</code> | </code> | ||
=== 파라미터 === | === 파라미터 === | ||
- | * context : android application context. | + | * ''context'' : 어플리케이션 콘텍스트 |
- | * listener : 장치로부터 콜백 데이터가 수신되는 콜백 리스너입니다. | + | * ''listener'' : 장치로부터 콜백 데이터가 수신되는 콜백 리스너 |
<callout type="info"> | <callout type="info"> | ||
- | [[return_code#DeviceListener|DeviceListener 클래스 보기]] | + | [[references#DeviceListener|DeviceListener 클래스 보기]] |
</callout> | </callout> | ||
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
줄 22: | 줄 22: | ||
</code> | </code> | ||
===응답 코드 === | ===응답 코드 === | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
SDK는 단일 애플리케이션에서만 사용 가능하도록 개발되었습니다.\\ 다른 애플리케이션에서 동시 사용할 수 없으니 주의하십시오. | SDK는 단일 애플리케이션에서만 사용 가능하도록 개발되었습니다.\\ 다른 애플리케이션에서 동시 사용할 수 없으니 주의하십시오. | ||
줄 28: | 줄 28: | ||
\\ | \\ | ||
- | =====getVersion===== | + | =====getVersions===== |
SDK / Firmware 버전을 가져옵니다. | SDK / Firmware 버전을 가져옵니다. | ||
<code java> | <code java> | ||
- | int getVersion(Version version) | + | int getVersions(Versions versions) |
</code> | </code> | ||
===파라미터=== | ===파라미터=== | ||
- | * version : SDK / Firmware 버전 | + | * ''versions'' : 버전 정보 (SDK / Firmware / 지문 라이브러리 / 카드 라이브러리) |
<callout type="info"> | <callout type="info"> | ||
- | [[return_code#Version|Version 클래스 보기]] | + | [[references#Versions|Versions 클래스 보기]] |
</callout> | </callout> | ||
===응답 코드=== | ===응답 코드=== | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
+ | |||
+ | =====getDeviceInformation===== | ||
+ | 장치 정보를 가져옵니다. | ||
+ | <code java> | ||
+ | int getDeviceInformation(Device device) | ||
+ | </code> | ||
+ | ===파라미터=== | ||
+ | * ''device'' : 장치 정보 | ||
+ | <callout type="info"> | ||
+ | [[references#Device |Device 클래스 보기]] | ||
+ | </callout> | ||
+ | ===응답 코드=== | ||
+ | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. | ||
\\ | \\ | ||
줄 48: | 줄 61: | ||
</code> | </code> | ||
===파라미터=== | ===파라미터=== | ||
- | * cardType : RF 카드 타입 | + | * ''cardType'' : RF 카드 타입 |
<WRAP group 50%> | <WRAP group 50%> | ||
^ 값 ^설명 ^ | ^ 값 ^설명 ^ | ||
줄 57: | 줄 70: | ||
</WRAP> | </WRAP> | ||
===응답 코드=== | ===응답 코드=== | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
\\ | \\ | ||
줄 66: | 줄 79: | ||
</code> | </code> | ||
===파라미터=== | ===파라미터=== | ||
- | * option: 펌웨어 파일 옵션 | + | * ''option'': 펌웨어 파일 옵션 |
<callout type="info"> | <callout type="info"> | ||
- | [[return_code#FirmwareOption|FirmwareOption 클래스 보기]] | + | [[references#FirmwareOption|FirmwareOption 클래스 보기]] |
</callout> | </callout> | ||
===응답 코드=== | ===응답 코드=== | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
- | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다. | + | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\ |
+ | 해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다. | ||
+ | <code xml> | ||
+ | <uses-permission android:name="android.permission.INTERNET"/> | ||
+ | </code> | ||
</callout> | </callout> | ||
줄 83: | 줄 100: | ||
</code> | </code> | ||
===응답 코드=== | ===응답 코드=== | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
- | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다. | + | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\ |
+ | 해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다. | ||
+ | <code xml> | ||
+ | <uses-permission android:name="android.permission.INTERNET"/> | ||
+ | </code> | ||
</callout> | </callout> | ||
\\ | \\ | ||
- | =====getFirmwareFileList===== | + | =====getFtpFileList===== |
- | FTP 서버의 파일 이름 목록을 얻어옵니다. | + | FTP 서버의 펌웨어 파일 이름 목록을 얻어옵니다. |
<code java> | <code java> | ||
- | int getFirmwareFileList(ArrayList<String> fileList) | + | int getFtpFileList(ArrayList<String> fileList) |
</code> | </code> | ||
===파라미터=== | ===파라미터=== | ||
- | * fileList: 파일 이름 목록 | + | * ''fileList'': 파일 이름 목록 |
===응답 코드=== | ===응답 코드=== | ||
- | 성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
- | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다. | + | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다.\\ \\ |
+ | 해당 API를 사용하려면 안드로이드 어플리케이션은 다음의 권한이 필수로 요구 됩니다. | ||
+ | <code xml> | ||
+ | <uses-permission android:name="android.permission.INTERNET"/> | ||
+ | </code> | ||
</callout> | </callout> | ||
+ | |||
+ | \\ | ||
+ | =====getUsbFileList===== | ||
+ | USB의 펌웨어 파일 이름 목록을 얻어옵니다. | ||
+ | <code java> | ||
+ | int getUsbFileList(ArrayList<String> fileList) | ||
+ | </code> | ||
+ | ===파라미터=== | ||
+ | * ''fileList'': 파일 이름 목록 | ||
+ | ===응답 코드=== | ||
+ | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. | ||
\\ | \\ | ||
=====upgradeFirmware===== | =====upgradeFirmware===== | ||
- | 지정된 펌웨어 파일로 업그레이드를 진행합니다. | + | 지정된 펌웨어 파일로 업그레이드 파일을 복사합니다. |
<code java> | <code java> | ||
int upgradeFirmware(FirmwareOption option) | int upgradeFirmware(FirmwareOption option) | ||
</code> | </code> | ||
===파라미터=== | ===파라미터=== | ||
- | * option: 펌웨어 파일 옵션 | + | * ''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를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다. | + | 성공적으로 수행될 경우 ''SUCCESS''를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다. |
<callout type="info" icon="true"> | <callout type="info" icon="true"> | ||
- | 펌웨어 업그레이드 기능을 사용하기 위해서는 FTP 서버 구축이 필요합니다.\\ 해당 API는 FTP 클라이언트 역할을 합니다. | + | 펌웨어 업그레이드는 장치 재시작 시 진행됩니다. |
</callout> | </callout> |