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:zone_control_api [2018/03/15 14:51] yjjung |
en:zone_control_api [2018/12/19 17:48] yjjung [Ethernet Zone] |
||
|---|---|---|---|
| Line 16: | Line 16: | ||
| * [[BS2_ClearAntiPassbackZoneStatus]]: Updates selected users to be not violating against the Anti Passback zone rule. | * [[BS2_ClearAntiPassbackZoneStatus]]: Updates selected users to be not violating against the Anti Passback zone rule. | ||
| * [[BS2_ClearAllAntiPassbackZoneStatus]]: Updates all users to be not violating against the Anti Passback zone rule. | * [[BS2_ClearAllAntiPassbackZoneStatus]]: Updates all users to be not violating against the Anti Passback zone rule. | ||
| - | + | * [[BS2_SetCheckGlobalAPBViolationHandler]]: Registers callback function for global determination when an APB violation alarm occurs. | |
| - | ---- | + | * [[BS2_CheckGlobalAPBViolation]]: Transfers Global APB results to the device. |
| ==== Timed Anti Passback Zone ==== | ==== Timed Anti Passback Zone ==== | ||
| To prevent a user from re-entering in a certain time, a Timed Anti Passback zone can be used. This zone offers two options(soft, hard) as same as the Anti Passback zone. | To prevent a user from re-entering in a certain time, a Timed Anti Passback zone can be used. This zone offers two options(soft, hard) as same as the Anti Passback zone. | ||
| Line 83: | Line 83: | ||
| ---- | ---- | ||
| ==== Ethernet Zone ==== | ==== Ethernet Zone ==== | ||
| - | Not BioStar V2.x server, but specific device acts as Zone Master. Ethernet zone uses Ethernet TCP protocol between devices(Master <-> Members). | + | Not BioStar V2.x server, but specific device acts as Zone Master. Ethernet zone uses Ethernet TCP protocol between devices(Master <-> Members). |
| - | Currently, it only supports corresponding features to existing 1.x Entrance Limit, Fire Alarm Zone. | + | Currently, it only supports corresponding features to existing 1.x Entrance Limit, Fire Alarm Zone. It is supported on A2(FW 1.4.0 or higher), BS2(FW 1.5.0 or higher) and P2(FW 1.0.0 or higher). |
| * [[BS2_GetDeviceZone]]: Retrieves selected Ethernet zones.. | * [[BS2_GetDeviceZone]]: Retrieves selected Ethernet zones.. | ||
| * [[BS2_GetAllDeviceZone]]: Retrieves all Ethernet zones. | * [[BS2_GetAllDeviceZone]]: Retrieves all Ethernet zones. | ||
| Line 94: | Line 94: | ||
| * [[BS2_ClearDeviceZoneAccessRecord]]: Updates selected users to be not violating against the Ethernet zone rule. | * [[BS2_ClearDeviceZoneAccessRecord]]: Updates selected users to be not violating against the Ethernet zone rule. | ||
| * [[BS2_ClearAllDeviceZoneAccessRecord]]: Updates all users to be not violating against the Ethernet rule. | * [[BS2_ClearAllDeviceZoneAccessRecord]]: Updates all users to be not violating against the Ethernet rule. | ||
| - | * [[BS2_GetAccessGroupEntranceLimit]]: Retrieves selected Ethernet Access Group Entrance limit. | ||
| - | * [[BS2_GetAllAccessGroupEntranceLimit]]: Retrieves all access group entrance limit. | ||
| - | * [[BS2_SetAccessGroupEntranceLimit]]: Configures access group entrance limit.. | ||
| - | * [[BS2_RemoveAccessGroupEntranceLimit]]: Removes selected access group entrance limit. | ||
| - | * [[BS2_RemoveAllAccessGroupEntranceLimit]]: Removes all access group entrance limit | ||
| * [[BS2_GetDeviceZoneAGEntranceLimit]]: Retrieves selected Ethernet Access Group Entrance limit. | * [[BS2_GetDeviceZoneAGEntranceLimit]]: Retrieves selected Ethernet Access Group Entrance limit. | ||
| * [[BS2_GetAllDeviceZoneAGEntranceLimit]]: Retrieves all Ethernet Access Group Entrance limit. | * [[BS2_GetAllDeviceZoneAGEntranceLimit]]: Retrieves all Ethernet Access Group Entrance limit. | ||
| Line 106: | Line 101: | ||
| \\ | \\ | ||
| ---- | ---- | ||
| + | ==== Callback Function ==== | ||
| + | ==== OnCheckGlobalAPBViolation ==== | ||
| + | Callback function for global determination when an APB violation alarm occurs. | ||
| + | <code cpp> | ||
| + | typedef void (*OnCheckGlobalAPBViolation)(uint32_t deviceId, uint16_t seq, const char* userID_1, const char* userID_2, bool isDualAuth); | ||
| + | </code> | ||
| + | \\ | ||
| + | 1. //deviceId// \\ | ||
| + | Device ID \\ \\ | ||
| + | 2. //seq// \\ | ||
| + | Packet sequence number \\ \\ | ||
| + | 3. //userID_1// \\ | ||
| + | User ID 1 \\ \\ | ||
| + | 4. //userID_2// \\ | ||
| + | User ID 2 \\ \\ | ||
| + | 5. //isDualAuth// \\ | ||
| + | Indicates whether to Dual authentication. \\ \\ | ||
| ===== Structure ====== | ===== Structure ====== | ||
| Line 234: | Line 246: | ||
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| 9. //resetDuration// \\ | 9. //resetDuration// \\ | ||
| - | The time interval for initializing the users status when a user violates the APB rule. When the value is set to 0, this means that it will not initialize the status, and will be initialized only through the BioStar application. \\ \\ | + | It means the time until the APB violation status is initialized(released), unit is second. At this time, the initialization time is calculated based on the time when the last authentication succeeded. If this value is set to 0, it means not to initialize but can be initialized with BS2_ClearAntiPassbackZoneStatus. \\ \\ |
| 10. //alarm// \\ | 10. //alarm// \\ | ||
| An alarm that will be triggered when a user violates the user APB rule, which can be configured up to 5 alarms. \\ \\ | An alarm that will be triggered when a user violates the user APB rule, which can be configured up to 5 alarms. \\ \\ | ||