차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
양쪽 이전 판 이전 판 다음 판 | 이전 판 다음 판 양쪽 다음 판 | ||
ko:configuration_api [2021/05/25 10:57] kkshin [BS2FaceConfig] |
ko:configuration_api [2021/08/05 10:26] kkshin |
||
---|---|---|---|
줄 76: | 줄 76: | ||
* [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' 열화상 카메라 설정을 가져옵니다. | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' 열화상 카메라 설정을 가져옵니다. | ||
* [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' 열화상 카메라 설정을 저장합니다. | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' 열화상 카메라 설정을 저장합니다. | ||
+ | * [[BS2_GetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Barcode 관련 설정을 가져옵니다. | ||
+ | * [[BS2_SetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Barcode 관련 설정을 저장합니다. | ||
+ | * [[BS2_GetInputConfigEx]]: [+ 2.8.1] ''IM-120'' Input 관련 확장형 설정을 가져옵니다. | ||
+ | * [[BS2_SetInputConfigEx]]: [+ 2.8.1] ''IM-120'' Input 관련 확장형 설정을 저장합니다. | ||
+ | * [[BS2_GetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' RelayAction 관련 설정을 가져옵니다. | ||
+ | * [[BS2_SetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' RelayAction 관련 설정을 저장합니다. | ||
===== 구조체 ===== | ===== 구조체 ===== | ||
줄 409: | 줄 415: | ||
</WRAP> | </WRAP> | ||
6. //menuTimeout// \\ | 6. //menuTimeout// \\ | ||
- | 사용자의 장치 조작이 없을 때 잠금 화면으로 전환되는 시간이며 단위는 초(sec)를 사용합니다. 0-255 sec로 설정할 수 있습으며. 0으로 설정되면 잠금 화면으로 전환되지 않습니다.\\ \\ | + | 사용자의 장치 조작이 없을 때 잠금 화면으로 전환되는 시간이며 단위는 초(sec)를 사용합니다. 0-255 sec로 설정할 수 있습으며. 0으로 설정되면 잠금 화면으로 전환되지 않습니다.\\ |
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |메뉴화면 유지 지속 | | ||
+ | |10 |메뉴화면 유지 10초 | | ||
+ | |20 |메뉴화면 유지 20초 (기본값) | | ||
+ | |30 |메뉴화면 유지 30초 | | ||
+ | |40 |메뉴화면 유지 40초 | | ||
+ | |50 |메뉴화면 유지 50초 | | ||
+ | |60 |메뉴화면 유지 60초 | | ||
+ | </WRAP> | ||
7. //msgTimeout// \\ | 7. //msgTimeout// \\ | ||
- | 메시지 화면이 자동으로 사라지는 시간이며 단위는 밀리초(ms)를 사용합니다. 500-5000 ms로 설정할 수 있습니다.\\ \\ | + | 메시지 화면이 자동으로 사라지는 시간이며 단위는 밀리초(ms)를 사용합니다. 500-5000 ms로 설정할 수 있습니다.\\ |
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |500 |메시지 화면 유지 500밀리초 | | ||
+ | |1000 |메시지 화면 유지 1초 | | ||
+ | |2000 |메시지 화면 유지 2초 (기본값) | | ||
+ | |3000 |메시지 화면 유지 3초 | | ||
+ | |4000 |메시지 화면 유지 4초 | | ||
+ | |5000 |메시지 화면 유지 5초 | | ||
+ | </WRAP> | ||
8. //backlightTimeout// \\ | 8. //backlightTimeout// \\ | ||
- | 백라이트 유지 시간이며 단위는 초(sec)를 사용합니다. \\ \\ | + | 백라이트 유지 시간이며 단위는 초(sec)를 사용합니다. \\ |
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |백라이트 유지 0초 | | ||
+ | |10 |백라이트 유지 10초 | | ||
+ | |20 |백라이트 유지 20초 (기본값) | | ||
+ | |30 |백라이트 유지 30초 | | ||
+ | |40 |백라이트 유지 40초 | | ||
+ | |50 |백라이트 유지 50초 | | ||
+ | |60 |백라이트 유지 60초 | | ||
+ | </WRAP> | ||
9. //displayDateTime// \\ | 9. //displayDateTime// \\ | ||
화면에 시간을 표시할지 결정하는 flag입니다.\\ \\ | 화면에 시간을 표시할지 결정하는 flag입니다.\\ \\ | ||
줄 776: | 줄 811: | ||
==== BS2Rs485Config ==== | ==== BS2Rs485Config ==== | ||
<code cpp> | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t supportConfig; | ||
+ | uint8_t useExceptionCode; | ||
+ | uint8_t exceptionCode[BS2_RS485_MAX_FAIL_CODE_LEN]; | ||
+ | uint8_t outputFormat; | ||
+ | uint8_t osdpID; | ||
+ | uint8_t reserved[4]; | ||
+ | } BS2IntelligentPDInfo; | ||
+ | |||
typedef struct { | typedef struct { | ||
uint32_t baudRate; | uint32_t baudRate; | ||
줄 789: | 줄 833: | ||
uint8_t numOfChannels; | uint8_t numOfChannels; | ||
uint8_t reserved[2]; | uint8_t reserved[2]; | ||
- | uint8_t reserved1[32]; | + | BS2IntelligentPDInfo intelligentInfo; |
+ | uint8_t reserved1[16]; | ||
BS2Rs485Channel channels[BS2_RS485_MAX_CHANNELS]; | BS2Rs485Channel channels[BS2_RS485_MAX_CHANNELS]; | ||
} BS2Rs485Config; | } BS2Rs485Config; | ||
</code> | </code> | ||
- | 1. //baudRate// \\ | + | 1. //supportConfig// \\ |
+ | ''[+V2.8]'' 이 값이 0으로 전달되면 장치는 아래의 Intelligent PD(Peripheral Device) 관련 설정들을 모두 무시하게 됩니다. \\ \\ | ||
+ | 2. //useExceptionCode// \\ | ||
+ | ''[+V2.8]'' 예외코드를 전송을 사용할지의 여부를 설정합니다. \\ \\ | ||
+ | 3. //exceptionCode// \\ | ||
+ | ''[+V2.8]'' 인증에 실패하거나, 인증 성공이지만 카드가 등록되어있지 않은 사용자의 경우 예외코드를 내보낼 수 있습니다. \\ | ||
+ | 이때 사용할 예외코드를 설정합니다. \\ | ||
+ | 만일 예외코드가 0(0x0000000000000000)이라면 예외코드가 발생되지 않습니다. \\ \\ | ||
+ | 4. //outputFormat// \\ | ||
+ | ''[+V2.8]'' 인증 성공 시 내보내어지는 정보를 지정할 수 있습니다. \\ | ||
+ | 0 이면 카드ID가, 1 이면 사용자ID가 출력됩니다. \\ \\ | ||
+ | 5. //osdpID// \\ | ||
+ | ''[+V2.8]'' 동일한 ACU에 연결된 장치들을 서로 구분시켜주기위해 사용되어지는 값으로, \\ | ||
+ | 0~127 사이의 unique한 값을 설정해 지정하여주면 됩니다. \\ \\ | ||
+ | 6. //reserved// \\ | ||
+ | ''[+V2.8]'' 예약된 공간입니다.\\ \\ | ||
+ | \\ | ||
+ | 7. //baudRate// \\ | ||
RS485 통신 속도이며 설정할 수 있는 범위는 다음과 같습니다. \\ | RS485 통신 속도이며 설정할 수 있는 범위는 다음과 같습니다. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
줄 803: | 줄 865: | ||
|115200 | | |115200 | | ||
</WRAP> | </WRAP> | ||
- | 2. //channelIndex// \\ | + | 8. //channelIndex// \\ |
(사용자 설정 불가) RS485 network의 통신 채널 번호입니다. \\ \\ | (사용자 설정 불가) RS485 network의 통신 채널 번호입니다. \\ \\ | ||
- | 3. //useRegistance// \\ | + | 9. //useRegistance// \\ |
종단 저항을 설정할지 결정하는 flag입니다. - 동작에 영향 없음 \\ \\ | 종단 저항을 설정할지 결정하는 flag입니다. - 동작에 영향 없음 \\ \\ | ||
- | 4. //numOfDevices// \\ | + | 10. //numOfDevices// \\ |
슬레이브 장치의 개수입니다.\\ \\ | 슬레이브 장치의 개수입니다.\\ \\ | ||
- | 5. //slaveDevices// \\ | + | 11. //reserved// \\ |
+ | 예약된 공간입니다.\\ \\ | ||
+ | 12. //slaveDevices// \\ | ||
슬레이브 장치를 나열한 리스트로 최대 32개까지 정의할 수 있습니다.\\ \\ | 슬레이브 장치를 나열한 리스트로 최대 32개까지 정의할 수 있습니다.\\ \\ | ||
- | 6. //mode// \\ | + | \\ |
+ | 13. //mode// \\ | ||
RS485 네트워크에서 어떤 모드로 동작할지 결정하는 flag입니다 .\\ | RS485 네트워크에서 어떤 모드로 동작할지 결정하는 flag입니다 .\\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
줄 820: | 줄 885: | ||
|3 |Standalone | | |3 |Standalone | | ||
</WRAP> | </WRAP> | ||
- | 7. //numOfChannels// \\ | + | 14. //numOfChannels// \\ |
RS485 채널의 개수입니다.\\ \\ | RS485 채널의 개수입니다.\\ \\ | ||
- | 8. //reserved// \\ | + | 15. //reserved// \\ |
예약된 공간입니다.\\ \\ | 예약된 공간입니다.\\ \\ | ||
- | 9. //reserved1// \\ | + | 16. //intelligentInfo// \\ |
+ | ''[+V2.8]'' Intelligent Slave 기능을 설정하며, mode가 default(Standalone)인 경우에만 동작됩니다. \\ | ||
+ | 이 설정을 이용하면 슈프리마 기기가 타사 컨트롤러와 연결된 환경에서 OSDP로 인증 결과를 출력시켜 줍니다. \\ \\ | ||
+ | 17. //reserved1// \\ | ||
예약된 공간입니다.\\ \\ | 예약된 공간입니다.\\ \\ | ||
- | 10. //channels// \\ | + | 18. //channels// \\ |
RS485 채널을 나열한 리스트로 최대 4개까지 설정할 수 있습니다.\\ \\ | RS485 채널을 나열한 리스트로 최대 4개까지 설정할 수 있습니다.\\ \\ | ||
줄 1625: | 줄 1693: | ||
|1 |옥외 | | |1 |옥외 | | ||
|2 |자동 | | |2 |자동 | | ||
- | |3 |사용 안함 (''FaceStation F2 Only'') | | + | |3 |[+V2.8] 사용 안함 ''(FaceStation F2)'' | |
</WRAP> | </WRAP> | ||
3. //enrollThreshold// \\ | 3. //enrollThreshold// \\ | ||
줄 2297: | 줄 2365: | ||
실제 체온측정값과, 카메라를 통한 체온측정은 약간의 차이가 존재할 수 있으며, 이곳에 값을 설정하여, 그 차이를 보정할 수 있습니다. \\ | 실제 체온측정값과, 카메라를 통한 체온측정은 약간의 차이가 존재할 수 있으며, 이곳에 값을 설정하여, 그 차이를 보정할 수 있습니다. \\ | ||
설정할 온도의 10을 곱한 값으로 입력하여야하며, 최소 -50에서 최대 50 사이의 값을 지정할 수 있습니다. \\ \\ | 설정할 온도의 10을 곱한 값으로 입력하여야하며, 최소 -50에서 최대 50 사이의 값을 지정할 수 있습니다. \\ \\ | ||
+ | |||
+ | ==== BS2BarcodeConfig ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t useBarcode; | ||
+ | uint8_t scanTimeout; | ||
+ | uint8_t reserved[14]; | ||
+ | } BS2BarcodeConfig; | ||
+ | </code> | ||
+ | 1. //useBarcode// \\ | ||
+ | Barcode 사용여부 flag입니다. \\ \\ | ||
+ | 2. //scanTimeout// \\ | ||
+ | Barcode scan 시간을 설정합니다. 단위는 초입니다. \\ | ||
+ | 기본값은 4초이며, 4~10초 범위 내로 입력 가능합니다. \\ \\ | ||
+ | 3. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ | ||
+ | |||
+ | |||
+ | ==== BS2InputConfigEx ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t numInputs; | ||
+ | uint8_t numSupervised; | ||
+ | uint8_t reserved[18]; | ||
+ | |||
+ | struct { | ||
+ | uint8_t portIndex; | ||
+ | uint8_t switchType; | ||
+ | uint16_t duration; | ||
+ | | ||
+ | uint8_t reserved; | ||
+ | uint8_t supervisedResister; | ||
+ | uint8_t reserved1[16]; | ||
+ | | ||
+ | uint8_t reserved2[26]; | ||
+ | } inputs[BS2_MAX_INPUT_NUM_EX]; | ||
+ | |||
+ | uint8_t reserved2[200]; | ||
+ | } BS2InputConfigEx; | ||
+ | </code> | ||
+ | 1. //numInputs// \\ | ||
+ | Input 포트의 개수입니다. \\ \\ | ||
+ | 2. //numSupervised// \\ | ||
+ | supervised input 포트의 개수입니다. \\ \\ | ||
+ | 3. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 4. //portIndex// \\ | ||
+ | Input 포트 번호입니다. \\ \\ | ||
+ | 5. //switchType// \\ | ||
+ | Input 신호 유형입니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |Normally Open | | ||
+ | |1 |Normally Closed | | ||
+ | </WRAP> | ||
+ | 6. //duration// \\ | ||
+ | Input 신호의 지속시간으로 단위는 밀리초(ms)입니다. \\ \\ | ||
+ | 7. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 8. //supervisedResister// \\ | ||
+ | Supervised input 저항 값의 유형을 설정하거나, 해제할 수(unsupervised) 있습니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |1K 저항 | | ||
+ | |1 |2.2K 저항 | | ||
+ | |2 |4.7K 저항 | | ||
+ | |3 |10K 저항 | | ||
+ | |254 |Unsupervised(기본값) | | ||
+ | </WRAP> | ||
+ | 9. //reserved1// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 10. //reserved2// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 11. //reserved2// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2RelayActionConfig ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint32_t deviceID; ///< 4 bytes | ||
+ | uint8_t reserved[16]; ///< 16 bytes | ||
+ | |||
+ | struct { | ||
+ | uint8_t port; ///< 1 byte (relay port) | ||
+ | uint8_t reserved0; ///< 1 byte | ||
+ | uint8_t disconnEnabled; ///< 1 byte (RS485 disconnection) | ||
+ | uint8_t reserved[9]; ///< 9 bytes | ||
+ | | ||
+ | struct { | ||
+ | uint8_t port; ///< 1 byte (input port) | ||
+ | uint8_t type; ///< 1 byte (linkage/latching/release) | ||
+ | uint8_t mask; ///< 1 byte (alarm/fault) | ||
+ | uint8_t reserved[9]; ///< 9 bytes | ||
+ | } input[BS2_MAX_RELAY_ACTION_INPUT]; ///< 192 bytes | ||
+ | } items[BS2_MAX_RELAY_ACTION]; ///< 816 bytes | ||
+ | |||
+ | uint8_t reserved2[152]; ///< 152 bytes | ||
+ | } BS2RelayActionConfig; | ||
+ | </code> | ||
+ | 1. //deviceID// \\ | ||
+ | 장치 식별번호 입니다. \\ \\ | ||
+ | 2. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 3. //items// \\ | ||
+ | Relay에 대한 설정 정보입니다. \\ \\ | ||
+ | 4. //port// \\ | ||
+ | Relay port 번호입니다. \\ \\ | ||
+ | 5. //reserved0// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 6. //disconnEnabled// \\ | ||
+ | true로 설정하면, RS485 연결이 끊겼을때 신호를 발생시키게 됩니다. \\ \\ | ||
+ | 7. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 8. //input// \\ | ||
+ | 해당 relay port가 어떤 input port들에 대해서 동작할지 정의합니다. \\ \\ | ||
+ | 9. //port// \\ | ||
+ | Input port 식별번호 입니다. \\ \\ | ||
+ | 10. //type// \\ | ||
+ | 해당 input을 어떤 형태의 input으로 동작시킬 것인지 정의합니다. \\ | ||
+ | Linkage로 설정 시 mask로 alarm이 설정되어야 신호가 전달됩니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^type ^값 ^설명 ^ | ||
+ | |NONE |0 |사용안함 | | ||
+ | |LINKAGE |1 |해당 input에 대한 relay로의 연결 | | ||
+ | |LATCHING |2 |''미지원'' | | ||
+ | |RELEASE |3 |''미지원'' | | ||
+ | </WRAP> | ||
+ | 11. //mask// \\ | ||
+ | Input 신호정보들에 대해 mask를 설정합니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^type ^값 ^설명 ^ | ||
+ | |NONE |0 |사용안함 | | ||
+ | |ALARM |1 |신호 발생 | | ||
+ | |FAULT |2 |단선/단락의 경우 신호 발생 | | ||
+ | </WRAP> | ||
+ | 12. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 13. //reserved2// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||