Differences

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

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
en:device_api [2017/09/06 17:12]
127.0.0.1 external edit
en:device_api [2019/05/27 16:19]
yjjung [Device API]
Line 4: Line 4:
  
   * [[BS2_GetDeviceInfo]]:​ Gets the device information.   * [[BS2_GetDeviceInfo]]:​ Gets the device information.
 +  * [[BS2_GetDeviceInfoEx]]:​ [+ 2.6.0] Gets additional device information. ​
   * [[BS2_GetDeviceTime]]:​ Gets the device time.   * [[BS2_GetDeviceTime]]:​ Gets the device time.
   * [[BS2_SetDeviceTime]]:​ Sets the device time.   * [[BS2_SetDeviceTime]]:​ Sets the device time.
Line 14: Line 15:
   * [[BS2_UpgradeFirmware]]:​ Upgrades the firmware.   * [[BS2_UpgradeFirmware]]:​ Upgrades the firmware.
   * [[BS2_UpdateResource]]:​ Updates the resource.   * [[BS2_UpdateResource]]:​ Updates the resource.
 +  * [[BS2_GetSpecifiedDeviceInfo]]:​ [+ 2.6.3] Gets specified device information. ​
 +  * [[BS2_GetAuthOperatorLevelEx]]:​ [+ 2.6.3] Gets specified device operator. (Support operator up to 1000)
 +  * [[BS2_GetAllAuthOperatorLevelEx]]:​ [+ 2.6.3] Gets all device operators. (Support operator up to 1000)
 +  * [[BS2_SetAuthOperatorLevelEx]]:​ [+ 2.6.3] Sets device operator. (Support operator up to 1000)
 +  * [[BS2_RemoveAuthOperatorLevelEx]]:​ [+ 2.6.3] Remove specified device operator. (Support operator up to 1000)
 +  * [[BS2_RemoveAllAuthOperatorLevelEx]]:​ [+ 2.6.3] Remove all device operators. (Support operator up to 1000)
 ===== Structure ===== ===== Structure =====
 ==== BS2SimpleDeviceInfo ==== ==== BS2SimpleDeviceInfo ====
Line 133: Line 140:
 Flag that notifies whether the device supports Multi-Wiegand. \\ Flag that notifies whether the device supports Multi-Wiegand. \\
  
-**21. //​rs485Mode//​ \\ +**21. //​rs485Mode//​** \\ 
 RS-485 mode of the device. \\ RS-485 mode of the device. \\
  
-**22. //​sslSupported//​ \\ +**22. //​sslSupported//​** \\ 
 Flag that notifies whether the device supports SSL communication. \\ Flag that notifies whether the device supports SSL communication. \\
  
-**23. //​rootCertExist//​ \\ +**23. //​rootCertExist//​** \\ 
 Flag that notifies whether the device has a root certificate. \\ Flag that notifies whether the device has a root certificate. \\
  
-**24. //​dualIDSupported//​ \\ +**24. //​dualIDSupported//​** \\ 
 Flag that notifies whether the device supports alphanumeric ID. \\ Flag that notifies whether the device supports alphanumeric ID. \\
  
-**25. //​useAlphanumericID//​ \\ +**25. //​useAlphanumericID//​** \\ 
 Flag that notifies whether the device is currently using Alphanumeric ID. \\ Flag that notifies whether the device is currently using Alphanumeric ID. \\
  
-**26. //​connectedIP//​ \\ +**26. //​connectedIP//​** \\ 
 IP address where the device is connected to. (0xFFFFFFFF if disconnected)\\ IP address where the device is connected to. (0xFFFFFFFF if disconnected)\\
  
Line 163: Line 170:
 Flag that notifies whether the device supports VoIP. \\ Flag that notifies whether the device supports VoIP. \\
  
 +==== BS2SimpleDeviceInfoEx ====
 +Retrieves BS2SimpleDeviceInfo and supported information.\\
 +<code cpp>
 +typedef struct
 +{
 +    enum
 +    {
 +        BS2_SUPPORT_RS485EX = 0x00000001,
 +        BS2_SUPPORT_CARDEX ​ = 0x00000002,
 +        BS2_SUPPORT_DST ​    = 0x00000004,
 +        BS2_SUPPORT_ALL ​    = BS2_SUPPORT_RS485EX | BS2_SUPPORT_CARDEX | BS2_SUPPORT_DST,​
 +    };
 +
 +    uint32_t supported;
 +    uint8_t ​ reserved[4];​
 +}BS2SimpleDeviceInfoEx;​
 +</​code>​
 +
 +**1. //​supported//​** \\ 
 +The current device additionally obtains information beyond the functionality provided by BS2SimpleDeviceInfo.\\
 +By bit masking with the values defined below, you can check if it is supported.
 +<WRAP group 50%>
 +^Definition ​ ^Value ​ ^Description ​ ^
 +|BS2_SUPPORT_RS485EX ​ |0x00000001 ​ |Whether RS485 extensions are supported (In case of CoreStation 40)  |
 +|BS2_SUPPORT_CARDEX ​ |0x00000002 ​ |Whether iClass SEOS card is used  |
 +|BS2_SUPPORT_DST ​ |0x00000004 ​ |Whether daylight savings time is used |
 +|BS2_SUPPORT_ALL ​ |0x00000007 ​ |Whether to provide additional full information
 +  |
 +</​WRAP>​
 +
 +**2. //​reserved//​** \\ 
 +Reserved space. \\ 
  
 ==== BS2ResourceElement ==== ==== BS2ResourceElement ====
Line 179: Line 218:
 **1. //type//** \\ **1. //type//** \\
 Resource data type. \\ Resource data type. \\
-<WRAP group 50%>+<WRAP group 100%>
 ^Value ​ ^Description ​ ^Supported data format ​ ^ ^Value ​ ^Description ​ ^Supported data format ​ ^
 |0  |UI(Langauge pack)  |Suprema language pack | |0  |UI(Langauge pack)  |Suprema language pack |