차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
양쪽 이전 판 이전 판 다음 판 | 이전 판 다음 판 양쪽 다음 판 | ||
ko:configuration_api [2023/02/09 16:13] mashin |
ko:configuration_api [2023/08/09 16:18] mashin |
||
---|---|---|---|
줄 86: | 줄 86: | ||
* [[BS2_GetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 가져옵니다. | * [[BS2_GetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 가져옵니다. | ||
* [[BS2_SetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 저장합니다. | * [[BS2_SetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 저장합니다. | ||
- | * [[BS2_GetLicenseConfig]]: [+ 2.8.4] 장치 라이선스 활성화 정보를 가져옵니다. | + | * [[BS2_GetLicenseConfig]]: [+ 2.9.1] 장치 라이선스 활성화 정보를 가져옵니다. |
+ | * [[BS2_GetOsdpStandardConfig]]: [+ 2.9.1] 장치의 OSDP 설정 정보를 가져옵니다. | ||
+ | * [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 가져옵니다. | ||
+ | * [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 지정합니다. | ||
+ | * [[BS2_GetCustomCardConfig]]: [+ 2.9.4] Custom smart card 설정을 가져옵니다. | ||
+ | * [[BS2_SetCustomCardConfig]]: [+ 2.9.4] Custom smart card 설정을 지정합니다. | ||
===== 구조체 ===== | ===== 구조체 ===== | ||
==== BS2FactoryConfig ==== | ==== BS2FactoryConfig ==== | ||
줄 2430: | 줄 2434: | ||
uint8_t treatAsCSN; | uint8_t treatAsCSN; | ||
- | uint8_t reserved[12]; | + | uint8_t useVisualBarcode; |
+ | uint8_t motionSensitivity; | ||
+ | uint8_t visualCameraScanTimeout; | ||
+ | uint8_t reserved[9]; | ||
} BS2BarcodeConfig; | } BS2BarcodeConfig; | ||
</code> | </code> | ||
1. //useBarcode// \\ | 1. //useBarcode// \\ | ||
+ | ''XS2-QR 만 지원'' | ||
Barcode 사용여부 flag입니다. \\ \\ | Barcode 사용여부 flag입니다. \\ \\ | ||
2. //scanTimeout// \\ | 2. //scanTimeout// \\ | ||
Barcode scan 시간을 설정합니다. 단위는 초입니다. \\ | Barcode scan 시간을 설정합니다. 단위는 초입니다. \\ | ||
기본값은 4초이며, 4~10초 범위 내로 입력 가능합니다. \\ \\ | 기본값은 4초이며, 4~10초 범위 내로 입력 가능합니다. \\ \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^매크로 ^설명 ^ | ||
+ | |4 |BS2_BARCODE_TIMEOUT_DEFAULT |기본값 | | ||
+ | |4 |BS2_BARCODE_TIMEOUT_MIN |최소값 | | ||
+ | |10 |BS2_BARCODE_TIMEOUT_MAX |최대값 | | ||
+ | </WRAP> | ||
3. //bypassData// \\ | 3. //bypassData// \\ | ||
[+2.8.2] 읽혀진 barcode 정보를 장치에서 처리하지 않고, 서버로 전송하기 위해 사용합니다. \\ | [+2.8.2] 읽혀진 barcode 정보를 장치에서 처리하지 않고, 서버로 전송하기 위해 사용합니다. \\ | ||
줄 2450: | 줄 2464: | ||
따라서, 특수문자, 영문자가 들어있는 barcode 카드 데이터를 설정하고자 하면 오류를 반환할 수 있습니다. \\ | 따라서, 특수문자, 영문자가 들어있는 barcode 카드 데이터를 설정하고자 하면 오류를 반환할 수 있습니다. \\ | ||
이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\ | 이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\ | ||
- | 5. //reserved// \\ | + | 5. //useVisualBarcode// \\ |
+ | [+ 2.9.1] Visual barcode 사용여부 flag입니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^지원장치 ^펌웨어 ^ | ||
+ | |XS2-Finger |V1.2.0 | | ||
+ | |XS2-Card |V1.2.0 | | ||
+ | |BS3 |V1.1.0 | | ||
+ | </WRAP> | ||
+ | Visual barcode는 QR code sensor가 아닌, 일반 visual camera를 통해 QR code 읽기를 지원하며, \\ | ||
+ | 이 기능을 사용하기 위해서는, 별도의 라이선스 활성화가 필요합니다. \\ | ||
+ | 라이선스 활성화는 [[qr_code_api#BS2_EnableBarcodeLicense]]를 통해 지원합니다. \\ \\ | ||
+ | 6. //motionSensitivity// \\ | ||
+ | [+ 2.9.1] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^매크로 ^설명 ^ | ||
+ | |0 |BS2_MOTION_SENSITIVITY_LOW |낮음 | | ||
+ | |1 |BS2_MOTION_SENSITIVITY_NORMAL |중간 | | ||
+ | |2 |BS2_MOTION_SENSITIVITY_HIGH |높음 | | ||
+ | </WRAP> | ||
+ | 7. //visualCameraScanTimeout// \\ | ||
+ | [+ 2.9.1] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\ | ||
+ | 기본값은 10초이며, 3~20초 범위 내로 입력 가능합니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^매크로 ^설명 ^ | ||
+ | |10 |BS2_VISUAL_BARCODE_TIMEOUT_DEFAULT |기본값 | | ||
+ | |3 |BS2_VISUAL_BARCODE_TIMEOUT_MIN |최소값 | | ||
+ | |20 |BS2_VISUAL_BARCODE_TIMEOUT_MAX |최대값 | | ||
+ | </WRAP> | ||
+ | 8. //reserved// \\ | ||
예약된 공간입니다. \\ | 예약된 공간입니다. \\ | ||
- | |||
==== BS2InputConfigEx ==== | ==== BS2InputConfigEx ==== | ||
<code cpp> | <code cpp> | ||
줄 2814: | 줄 2855: | ||
이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\ | 이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\ | ||
5. //useVisualBarcode// \\ | 5. //useVisualBarcode// \\ | ||
- | [+2.8.4] Visual barcode 사용여부 flag입니다. \\ | + | [+ 2.9.1] Visual barcode 사용여부 flag입니다. \\ |
<WRAP group 50%> | <WRAP group 50%> | ||
^지원장치 ^펌웨어 ^ | ^지원장치 ^펌웨어 ^ | ||
줄 2825: | 줄 2866: | ||
라이선스 활성화는 [[qr_code_api#BS2_EnableBarcodeLicense]]를 통해 지원합니다. \\ \\ | 라이선스 활성화는 [[qr_code_api#BS2_EnableBarcodeLicense]]를 통해 지원합니다. \\ \\ | ||
6. //motionSensitivity// \\ | 6. //motionSensitivity// \\ | ||
- | [+2.8.4] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\ | + | [+ 2.9.1] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\ |
<WRAP group 50%> | <WRAP group 50%> | ||
^값 ^매크로 ^설명 ^ | ^값 ^매크로 ^설명 ^ | ||
줄 2833: | 줄 2874: | ||
</WRAP> | </WRAP> | ||
7. //visualCameraScanTimeout// \\ | 7. //visualCameraScanTimeout// \\ | ||
- | [+2.8.4] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\ | + | [+ 2.9.1] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\ |
기본값은 10초이며, 3~20초 범위 내로 입력 가능합니다. \\ | 기본값은 10초이며, 3~20초 범위 내로 입력 가능합니다. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
줄 3069: | 줄 3110: | ||
29. //actions// \\ | 29. //actions// \\ | ||
OSDP 장치에 대한 LED/buzzer 정보이며, 최대 32개 까지 지정할 수 있습니다. \\ \\ | OSDP 장치에 대한 LED/buzzer 정보이며, 최대 32개 까지 지정할 수 있습니다. \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2CustomMifareCard ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t primaryKey[6]; | ||
+ | uint8_t reserved1[2]; | ||
+ | uint8_t secondaryKey[6]; | ||
+ | uint8_t reserved2[2]; | ||
+ | uint16_t startBlockIndex; | ||
+ | uint8_t dataSize; | ||
+ | uint8_t skipBytes; | ||
+ | uint8_t reserved[4]; | ||
+ | } BS2CustomMifareCard; | ||
+ | </code> | ||
+ | 1. //primaryKey// \\ | ||
+ | Mifare card 정보에 접근하기 위한 첫번째 암호화 키입니다. \\ \\ | ||
+ | 2. //reserved1// \\ | ||
+ | 예약된 공간입니다.\\ \\ | ||
+ | 3. //secondaryKey// \\ | ||
+ | Mifare card 정보에 접근하기 위한 두번째 암호화 키입니다. \\ \\ | ||
+ | 4. //reserved2// \\ | ||
+ | 예약된 공간입니다.\\ \\ | ||
+ | 5. //startBlockIndex// \\ | ||
+ | Mifare data storage에서의 start block index입니다.\\ \\ | ||
+ | 6. //dataSize// \\ | ||
+ | 카드 데이터가 몇 byte의 크기를 갖는지를 나타냅니다. \\ \\ | ||
+ | 7. //skipBytes// \\ | ||
+ | 카드 데이터가 나타나는 위치를 의미합니다. \\ | ||
+ | 카드 데이터가 저장 위치 처음부터 나타난다면 0, 이후에 나온다면 몇 byte가 skip 된 이후에 나타나는지를 의미합니다. \\ \\ | ||
+ | 8. //reserved// \\ | ||
+ | 예약된 공간입니다.\\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2CustomDesFireCard ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t primaryKey[16]; | ||
+ | uint8_t secondaryKey[16]; | ||
+ | uint8_t appID[3]; | ||
+ | uint8_t fileID; | ||
+ | uint8_t encryptionType; // 0: DES/3DES, 1: AES | ||
+ | uint8_t operationMode; // 0: legacy(use picc master key), 1: new mode(use app master, file read, file write key) | ||
+ | uint8_t dataSize; | ||
+ | uint8_t skipBytes; | ||
+ | uint8_t reserved[4]; | ||
+ | BS2DesFireAppLevelKey desfireAppKey; ///<52 bytes | ||
+ | } BS2CustomDesFireCard; ///<96 Bytes | ||
+ | </code> | ||
+ | 1. //primaryKey// \\ | ||
+ | DesFire card 정보에 접근하기 위한 첫번째 암호화 키입니다. (일반설정) \\ \\ | ||
+ | 2. //secondaryKey// \\ | ||
+ | DesFire card 정보에 접근하기 위한 두번째 암호화 키입니다. (일반설정) \\ \\ | ||
+ | 3. //appID// \\ | ||
+ | 사용자 인증을 위해 DESFire 카드내에 내장된 사용할 애플리케이션 식별자입니다.\\ \\ | ||
+ | 4. //fileID// \\ | ||
+ | DESFire 카드내에 내장된 사용할 애플리케이션가 데이터를 읽고 쓰기 위한 파일 식별자입니다.\\ \\ | ||
+ | 5. //encryptionType// \\ | ||
+ | 데이터 암호화 방식을 나타냅니다.\\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |DES/3DES | | ||
+ | |1 |AES | | ||
+ | </WRAP> | ||
+ | 6. //operationMode// \\ | ||
+ | 운영 방식을 지정합니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |일반설정 사용 (PICC master key를 사용) | | ||
+ | |1 |고급설정 사용 (App master key를 사용) | | ||
+ | </WRAP> | ||
+ | 7. //dataSize// \\ | ||
+ | 카드 데이터가 몇 byte의 크기를 갖는지를 나타냅니다. \\ \\ | ||
+ | 8. //skipBytes// \\ | ||
+ | 카드 데이터가 나타나는 위치를 의미합니다. \\ | ||
+ | 카드 데이터가 저장 위치 처음부터 나타난다면 0, 이후에 나온다면 몇 byte가 skip 된 이후에 나타나는지를 의미합니다. \\ \\ | ||
+ | 9. //reserved// \\ | ||
+ | 예약된 공간입니다.\\ \\ | ||
+ | 10. //desfireAppKey// \\ | ||
+ | DesFire card 정보에 접근하기 위한 키 정보를 나타냅니다. (고급설정) \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2CustomCardConfig ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | BS2_CARD_DATA_TYPE dataType; | ||
+ | BS2_BOOL useSecondaryKey; | ||
+ | uint8_t reserved1[2]; | ||
+ | |||
+ | BS2CustomMifareCard mifare; | ||
+ | BS2CustomDesFireCard desfire; | ||
+ | uint8_t reserved2[24]; | ||
+ | uint8_t reserved3[96]; | ||
+ | |||
+ | BS2_CARD_BYTE_ORDER smartCardByteOrder; | ||
+ | uint8_t reserved4[3]; | ||
+ | BS2_UID formatID; | ||
+ | uint8_t reserved5[8]; | ||
+ | } BS2CustomCardConfig; | ||
+ | </code> | ||
+ | 1. //dataType// \\ | ||
+ | Card의 데이터 유형입니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |바이너리 | | ||
+ | |1 |아스키 | | ||
+ | |2 |UTF16 | | ||
+ | |3 |BCD | | ||
+ | </WRAP> | ||
+ | 2. //useSecondaryKey// \\ | ||
+ | 두번째 암호화 키 사용 유무를 결정하는 flag입니다. \\ \\ | ||
+ | 3. //reserved1// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 4. //mifare// \\ | ||
+ | Mifare custom card 정보를 설정합니다. \\ \\ | ||
+ | 5. //desfire// \\ | ||
+ | DESFire custom card 정보를 설정합니다. \\ \\ | ||
+ | 6. //reserved2// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 7. //reserved3// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 8. //smartCardByteOrder// \\ | ||
+ | MSB 또는 LSB로 출력을 지정할 수 있습니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |MSB | | ||
+ | |1 |LSB | | ||
+ | </WRAP> | ||
+ | 9. //reserved4// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 10. //formatID// \\ | ||
+ | BioStar 애플리케이션에서 card configuration을 데이터베이스 관리할 필요가 있을 경우 사용할 수 있는 식별자입니다. \\ \\ | ||
+ | 11. //reserved5// \\ | ||
+ | 예약된 공간입니다. \\ \\ |