Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:configuration_api [2020/09/10 09:31] yjjung [BS2FaceConfigExt] |
en:configuration_api [2020/11/03 14:09] kkshin [BS2Action] |
||
---|---|---|---|
Line 35: | Line 35: | ||
* [[BS2_GetWiegandDeviceConfig]]: Retrieves Wiegand device settings from the device. | * [[BS2_GetWiegandDeviceConfig]]: Retrieves Wiegand device settings from the device. | ||
* [[BS2_SetWiegandDeviceConfig]]: Stores Wiegand device settings on the device. | * [[BS2_SetWiegandDeviceConfig]]: Stores Wiegand device settings on the device. | ||
- | * [[BS2_GetInputConfig]]: Retrieves input port settings from the device. | + | * [[BS2_GetInputConfig]]: Retrieves supervised input port settings from the device. |
- | * [[BS2_SetInputConfig]]: Stores input port settings on the device. | + | * [[BS2_SetInputConfig]]: Stores supervised input port settings on the device. |
* [[BS2_GetWlanConfig]]: Retrieves wireless LAN settings from the device. | * [[BS2_GetWlanConfig]]: Retrieves wireless LAN settings from the device. | ||
* [[BS2_SetWlanConfig]]: Stores wireless LAN settings on the device. | * [[BS2_SetWlanConfig]]: Stores wireless LAN settings on the device. | ||
Line 68: | Line 68: | ||
* [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | ||
* [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | ||
- | * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device. | + | * [[BS2_GetDesFireCardConfigEx]]: [+ 2.6.4] Retrieves DesFire advanced configuration from the device. |
- | * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device. | + | * [[BS2_SetDesFireCardConfigEx]]: [+ 2.6.4] Sets DesFire advanced configuration in the device. |
- | * [[BS2_GetAuthConfigExt]]: ''FaceStation F2'' Retrieves authentication settings from the device. [+ V2.7.1] | + | * [[BS2_GetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Retrieves authentication settings from the device. |
- | * [[BS2_SetAuthConfigExt]]: ''FaceStation F2'' Stores authentication settings from the device. [+ V2.7.1] | + | * [[BS2_SetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Stores authentication settings from the device. |
- | * [[BS2_GetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_GetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. |
- | * [[BS2_SetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_SetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. |
- | * [[BS2_GetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. |
- | * [[BS2_SetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. |
\\ | \\ | ||
Line 860: | Line 860: | ||
uint16_t wiegandCardMask; | uint16_t wiegandCardMask; | ||
uint8_t wiegandCSNIndex; | uint8_t wiegandCSNIndex; | ||
- | uint8_t reserved[27]; | + | uint8_t useWiegandUserID; |
+ | uint8_t reserved[26]; | ||
} BS2WiegandConfig; | } BS2WiegandConfig; | ||
</code> | </code> | ||
Line 930: | Line 931: | ||
**16. //wiegandCSNIndex//** \\ | **16. //wiegandCSNIndex//** \\ | ||
Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | ||
- | **17. //reserved//** \\ | + | **17. //useWiegandUserID//** \\ |
- | Reserved space\\ \\ | + | The flag you can select whether card ID or user ID to be sent via Wiegand output. \\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |Not use | | ||
+ | |1 |Card ID | | ||
+ | |2 |User ID | | ||
+ | </WRAP> | ||
+ | **18. //reserved//** \\ | ||
+ | Reserved space.\\ | ||
Line 1335: | Line 1344: | ||
26. //type// \\ | 26. //type// \\ | ||
Action types. \\ | Action types. \\ | ||
+ | <WRAP round important 60%> | ||
+ | <wrap em>[DoorModule-20, CoreStation-40]</wrap> \\ | ||
+ | If the action type is relay or TTL (Output) and the action device is DM20, CS40, | ||
+ | Action type should be set only as relay action (6). (TTL setting not possible) \\ \\ | ||
+ | <wrap em>[DM20]</wrap> \\ | ||
+ | * Action type : Relay | ||
+ | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
+ | * relay.relayIndex : 4 ~ 9 (OUTPUT 0 ~ 5) | ||
+ | <wrap em>[CS40]</wrap> \\ | ||
+ | * Action type : Relay | ||
+ | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
+ | * relay.relayIndex : 4 ~ 11 (OUTPUT 0 ~ 7) | ||
+ | </WRAP> | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 2182: | Line 2204: | ||
When set to HARD, access is denied if exceeding the thermalThreshold. \\ | When set to HARD, access is denied if exceeding the thermalThreshold. \\ | ||
When set to SOFT, access is not affected even if exceeding the thermalThreshold but leaves a related log. \\ | When set to SOFT, access is not affected even if exceeding the thermalThreshold but leaves a related log. \\ | ||
+ | If thermalCheckMode is set to No use(0), \\ | ||
+ | The settings of thermalFormat, thermalThreshold, auditTemperature, and useOverlapThermal are ignored. \\ | ||
+ | And the reject sound due to thermal check by useRejectSound, the temperature check by faceCheckOrder is ignored. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
Line 2192: | Line 2217: | ||
''FaceStation 2'' This setting is ignored. \\ | ''FaceStation 2'' This setting is ignored. \\ | ||
When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | ||
- | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLeve but leaves a related log. \\ | + | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\ |
+ | If maskCheckMode is set to No use(0), \\ | ||
+ | The setting of maskDetectionLevel is ignored. \\ | ||
+ | And the reject sound due to mask detection check by useRejectSound, the mask detection check by faceCheckOrder is ignored. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
Line 2220: | Line 2248: | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
- | |0 |No use |Default | | + | |0 |No detection |Default | |
- | |1 |Normal | | | + | |1 |Detection level (Normal) | | |
- | |2 |High | | | + | |2 |Detection level (High) | | |
- | |3 |Very high | | | + | |3 |Detection level (Very high) | | |
</WRAP> | </WRAP> | ||
8. //auditTemperature// \\ | 8. //auditTemperature// \\ |