Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:slave_control_api [2023/02/28 15:03] mwkim [BS2OsdpStandardDeviceAvailable] |
en:slave_control_api [2024/02/27 13:59] (current) |
||
|---|---|---|---|
| Line 4: | Line 4: | ||
| * [[BS2_GetSlaveDevice]]: Searches a slave device from the RS-485 network. | * [[BS2_GetSlaveDevice]]: Searches a slave device from the RS-485 network. | ||
| * [[BS2_SetSlaveDevice]]: Add/Modify/Delete a slave device from the master device. | * [[BS2_SetSlaveDevice]]: Add/Modify/Delete a slave device from the master device. | ||
| - | |||
| * [[BS2_GetSlaveExDevice]]: In case of CoreStation, searches a slave device from the RS-485 network. | * [[BS2_GetSlaveExDevice]]: In case of CoreStation, searches a slave device from the RS-485 network. | ||
| * [[BS2_SetSlaveExDevice]]: In case of CoreStation, Add/Modify/Delete a slave device from the master device. | * [[BS2_SetSlaveExDevice]]: In case of CoreStation, Add/Modify/Delete a slave device from the master device. | ||
| Line 10: | Line 9: | ||
| * [[BS2_SearchDevicesCoreStationEx]]: [+ 2.6.3] Searches CoreStation devices from the current network with host IP. | * [[BS2_SearchDevicesCoreStationEx]]: [+ 2.6.3] Searches CoreStation devices from the current network with host IP. | ||
| * [[BS2_GetDevicesCoreStation]]: Gets searched CoreStation devices. | * [[BS2_GetDevicesCoreStation]]: Gets searched CoreStation devices. | ||
| + | * [[BS2_AddOsdpStandardDevice]]: [+ 2.9.1] Add the OSDP device. | ||
| + | * [[BS2_GetOsdpStandardDevice]]: [+ 2.9.1] Gets OSDP device information. | ||
| + | * [[BS2_GetAvailableOsdpStandardDevice]]: [+ 2.9.1] Gets all OSDP device information of the specified master device. | ||
| + | * [[BS2_UpdateOsdpStandardDevice]]: [+ 2.9.1] Updates OSDP device information. | ||
| + | * [[BS2_RemoveOsdpStandardDevice]]: [+ 2.9.1] Remove the OSDP device. | ||
| + | * [[BS2_GetOsdpStandardDeviceCapability]]: [+ 2.9.1] Gets OSDP device support information. | ||
| + | * [[BS2_SetOsdpStandardDeviceSecurityKey]]: [+ 2.9.1] Set the security key for the OSDP device. | ||
| <WRAP alert> | <WRAP alert> | ||
| Line 122: | Line 128: | ||
| BS2_OSDP_CHANNEL_TYPE channelType; ///< 1 byte | BS2_OSDP_CHANNEL_TYPE channelType; ///< 1 byte | ||
| uint8_t maxOsdpDevice; ///< 1 byte | uint8_t maxOsdpDevice; ///< 1 byte | ||
| - | uint8_t numOsdpAvailibleDevice; ///< 1 byte | + | uint8_t numOsdpAvailableDevice; ///< 1 byte |
| BS2_DEVICE_ID deviceIDs[8]; ///< 4 x 8 = 32 bytes | BS2_DEVICE_ID deviceIDs[8]; ///< 4 x 8 = 32 bytes | ||
| } BS2OsdpStandardChannelInfo; ///< 36 bytes | } BS2OsdpStandardChannelInfo; ///< 36 bytes | ||
| Line 168: | Line 174: | ||
| - | ==== BS2OsdpStandardNotify ==== | + | ==== BS2OsdpStandardDeviceNotify ==== |
| <code cpp> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 190: | Line 196: | ||
| BS2_BOOL readInfo; ///< 1 byte | BS2_BOOL readInfo; ///< 1 byte | ||
| uint8_t reserved[5]; ///< 5 bytes (packing) | uint8_t reserved[5]; ///< 5 bytes (packing) | ||
| - | } BS2OsdpStandardNotify; ///< 48 bytes | + | } BS2OsdpStandardDeviceNotify; ///< 48 bytes |
| </code> | </code> | ||
| 1. //deviceID// \\ | 1. //deviceID// \\ | ||
| Line 309: | Line 315: | ||
| </code> | </code> | ||
| 1. //compliance// \\ | 1. //compliance// \\ | ||
| - | PD의 기능(function)에 따른 준수수준(compliance level)을 나타냅니다. \\ | + | Indicates the compliance level according to the function of the PD. \\ |
| - | 기능은 input, output, led, audio, textOutput 등이 있으며, 기능 별로 준수수준이 상이하므로 관련 OSDP 문서를 참고바랍니다. \\ \\ | + | Functions include input, output, led, audio, textOutput, etc. The compliance level is different for each function, so refer to the relevant OSDP document.\\ \\ |
| 2. //count// \\ | 2. //count// \\ | ||
| - | PD의 기능(function)에 따른 갯수(number of objects)를 의미하는데, 기능 별로 갯수에 부여되는 의미가 다르므로 관련 OSDP 문서를 참고바랍니다. \\ \\ | + | It refers to the number of objects according to the function of the PD, and the meaning of the number is different for each function, so refer to the relevant OSDP document. \\ \\ |
| 3. //input// \\ | 3. //input// \\ | ||
| - | 입력(모니터링) 기능을 정의합니다. \\ \\ | + | Define the input (monitoring) function. \\ \\ |
| 4. //output// \\ | 4. //output// \\ | ||
| - | 출력 기능을 정의합니다. \\ \\ | + | Define the output (monitoring) function. \\ \\ |
| 5. //led// \\ | 5. //led// \\ | ||
| - | LED 기능을 정의합니다. \\ \\ | + | Define the LED function. \\ \\ |
| 6. //audio// \\ | 6. //audio// \\ | ||
| - | Buzzer 기능을 정의합니다. \\ \\ | + | Define the Buzzer function. \\ \\ |
| 7. //textOutput// \\ | 7. //textOutput// \\ | ||
| - | 문자 출력 기능을 정의합니다. \\ \\ | + | Define the text output function. \\ \\ |
| 8. //reader// \\ | 8. //reader// \\ | ||
| - | 지원되는 장치 수를 나타내며, count 정보만 의미를 갖습니다. \\ \\ | + | Indicates the number of supported devices, only count information has meaning. \\ \\ |
| 9. //recvBufferSize// \\ | 9. //recvBufferSize// \\ | ||
| - | PD가 수신할 수 있는 단문 메시지 크기를 나타냅니다. \\ \\ | + | Indicates the short message size the PD can receive. \\ \\ |
| 10. //largeMsgSize// \\ | 10. //largeMsgSize// \\ | ||
| - | PD가 처리할 수 있는 장문 메시지의 최대 크기입니다. \\ \\ | + | Indicates the maximum size of a long message that the PD can process. \\ \\ |
| 11. //osdpVersion// \\ | 11. //osdpVersion// \\ | ||
| - | OSDP 버전입니다. \\ \\ | + | OSDP version. \\ \\ |
| 12. //cardFormat// \\ | 12. //cardFormat// \\ | ||
| - | 카드 데이터 포멧 기능을 정의하며, 01, 02, 03 중 하나의 값을 갖습니다. | + | Defines the card data format function and gets a value of 01, 02, or 03. |
| - | OSDP 문서의 카드 데이터 포멧관련 compliance level을 참고바랍니다. \\ \\ | + | Please refer to the compliance level related to the card data format of the OSDP document. \\ \\ |
| 13. //timeKeeping// \\ | 13. //timeKeeping// \\ | ||
| - | PD의 날짜 및 시간 정보 유형과 이를 유지하는 것에 대해 나타냅니다. OSDP 2.2에서 이 기능은 사용되지 않습니다. \\ \\ | + | Indicates the date and time type of the PD and what to keep it for. In OSDP 2.2, this feature is not used. \\ \\ |
| 14. //canCommSecure// \\ | 14. //canCommSecure// \\ | ||
| - | 보안통신 지원 여부를 나타냅니다. \\ \\ | + | Indicates whether secure communication is supported. \\ \\ |
| 15. //crcSupport// \\ | 15. //crcSupport// \\ | ||
| - | 체크섬 지원 여부를 나타냅니다. \\ \\ | + | Indicates whether checksums are supported. \\ \\ |
| 16. //smartCardSupport// \\ | 16. //smartCardSupport// \\ | ||
| - | 스마트 카드 지원 여부를 나타냅니다. \\ \\ | + | Indicates whether smart cards are supported. \\ \\ |
| 17. //biometricSupport// \\ | 17. //biometricSupport// \\ | ||
| - | 생체정보 처리가 가능한지를 나타냅니다. \\ \\ | + | Indicates whether biometric processing is supported. \\ \\ |
| 18. //securePinEntrySupport// \\ | 18. //securePinEntrySupport// \\ | ||
| - | SPE(Secure PIN Entry) 지원 여부를 나타냅니다. \\ \\ | + | Indicates whether Secure PIN Entry (SPE) is supported. \\ \\ |
| 19. //reserved// \\ | 19. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved Space. \\ \\ |
| Line 358: | Line 364: | ||
| </code> | </code> | ||
| 1. //deviceID// \\ | 1. //deviceID// \\ | ||
| - | 장치 식별자입니다. \\ \\ | + | Device Identifier. \\ \\ |
| 2. //result// \\ | 2. //result// \\ | ||
| - | OSDP 장치 명령 결과 값을 가집니다. \\ \\ | + | Gets OSDP device command result value. \\ \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |Success | | + | |0 |Fail | |
| - | |1 |Fail | | + | |1 |Success | |
| - | |2 |Not available | | + | |
| </WRAP> | </WRAP> | ||
| Line 377: | Line 382: | ||
| </code> | </code> | ||
| 1. //key// \\ | 1. //key// \\ | ||
| - | OSDP 장치에서 사용할 16byte 크기의 보안키 입니다. \\ \\ | + | 16-byte security key used in OSDP device. \\ \\ |
| 2. //reserved// \\ | 2. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved Space. \\ \\ |