Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
en:slave_control_api [2023/02/28 15:02]
mwkim [BS2OsdpStandardDeviceUpdate] 		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 134: Line 140:
 </​code>​ </​code>​
 1. //​channelIndex//​ \\  1. //​channelIndex//​ \\ 
-OSDP 장치가 연결되어 있는 통신 채널 번호입니다. \\ \\  ​+The communication channel number to which the OSDP device is connected. \\ \\  ​
 2. //​channelType//​ \\  2. //​channelType//​ \\ 
-RS485 통신을 하는 장치가 어떠한 방식으로 연결되어 있는지를 나타냅니다. \\  +Indicates the type to which the device communicating ​RS485 is connected. \\  
-CoreStation40 ​기준으로, 할당 가능한 채널은 ​0~4까지 5개인데, 각 채널내에서는 슈프리마 장치와 ​OSDP 장치가 혼용되어 운용될어질 수 없습니다. \\ +Based on CoreStation40, ​there are 5 assignable channels from 0 to 4, and Suprema devices and OSDP devices cannot be mixed and operated within each channel. \\ 
-특정 채널에 연결된 장치가 없는 경우, Suprema ​장치든, ​OSDP 장치이든 연결될 수 있음을 나타내는 0을 갖습니다. \\ +If no device is connected to a particular channel, it has a 0 indicating that it can be connected even if it is a Suprema ​device or an OSDP device. \\ 
-만일 특정 채널로 ​Suprema ​장치가 연결되면, 이후 해당 채널은 ​Suprema ​장치들의 연결만 허용되며, channelType은 1을 갖습니다. OSDP 장치가 연결되어 있더라도 무시되어집니다. \\ +If a Suprema ​device is connected to a specific channel, only Suprema ​devices are allowed to connect to that channel, and channelType ​has a value of 1. The OSDP device is ignored even if it is connected. \\ 
-만일 특정 채널로 ​OSDP 장치가 연결되면, 이후 해당 채널은 ​OSDP 장치 연결만 허용되며, channelType은 2를 갖습니다. Suprema ​장치가 연결되어 있더라도 무시되어집니다. \\ +If an OSDP device is connected to a specific channel, only OSDP devices are allowed to connect to that channel, and channelType ​has a value of 2. The Suprema ​device is ignored even if it is connected. \\ 
-CoreStation40 ​각각의 채널들은 ​Suprema ​장치 채널, ​OSDP 장치 채널들로 혼용되어 운용될 수 있습니다. \\ +Each channel of CoreStation40 ​can be mixed and operated as Suprema ​device channel and OSDP device channel. \\ 
-채널에 ​OSDP로 장치가 연결이되면 허용이 가능한 최대 장치수는 ​2대로 제한되며, 이미 해당 채널이 최대치에 도달했으면 ​channelType은 3을 갖으며 더이상 연결이 불가함을 나타냅니다. \\+The maximum number of OSDP devices allowed to connect to a channel is limited to 2, and if the channel is already maxed out, the channelType ​will be 3, indicating that no more connections are allowed. \\
 <WRAP group 50%> <WRAP group 50%>
-^값  ^설명 ​ ^+^Value  ^Description ​ ^
 |0  |Normal ​ | |0  |Normal ​ |
-|1  |Suprema ​장치 ​ | +|1  |Suprema ​Device ​ | 
-|2  |OSDP 장치 ​ | +|2  |OSDP Device ​ | 
-|3  |OSDP 장치 ​FULL  |+|3  |OSDP Device ​FULL  |
 </​WRAP>​ </​WRAP>​
 3. //​maxOsdpDevice//​ \\ 3. //​maxOsdpDevice//​ \\
-해당 채널에서 연결 가능한 장치의 최대치를 나타냅니다. \\ +Indicates the maximum number of devices that can be connected in that channel. \\ 
-channelType이 1이면 ​32를, 2나 3이면 ​2를 갖습니다. \\ \\+If the channelType ​is 1, it will get 32, if 2 or 3, it will get 2. \\ \\
 4. //​numOsdpAvailibleDevice//​ \\ 4. //​numOsdpAvailibleDevice//​ \\
-해당 채널에서 현재 연결 가능한 장치수를 나타냅니다. \\ \\+Indicates the number of devices currently available for connection in that channel. \\ \\
 5. //​deviceIDs//​ \\ 5. //​deviceIDs//​ \\
-해당 채널에 연결된(또는 연결될 수 있는) 장치 식별자 리스트입니다. \\ \\+The list of Device Identifier that is connected or can be connected in that channel. \\ \\
 6. //​numOfChannel//​ \\ 6. //​numOfChannel//​ \\
-채널 수 입니다. CoreStation40 ​기준 ​5를 갖습니다. \\ \\+Number of channel. CoreStation40 ​has a total of 5 channels. \\ \\
 7. //​reserved//​ \\  7. //​reserved//​ \\ 
-예약된 공간입니다. \\ \\+Reserved Space. \\ \\
 8. //​channels//​ \\ 8. //​channels//​ \\
-채널별 ​OSDP 장치정보입니다. \\ +OSDP device information of each channel. \\ 
-최대 ​8개까지 채널정보를 가질 수 있으나, CoreStation40이 5개의 채널을 가지므로 ​0~4번까지만 유의미합니다. \\ \\+You can have up to 8 channel information, but since CoreStation40 ​has 5 channels, only numbers ​0 to 4 are valid. \\ \\
 9. //​reserved1//​ \\  9. //​reserved1//​ \\ 
-예약된 공간입니다. \\ \\+Reserved Space. \\ \\
  
  
-==== 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. \\ \\