Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:zone_control_api [2020/07/29 11:34] yjjung |
en:zone_control_api [2024/06/05 14:42] alex GlobalAPBViolationByDoor description update |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Zone Control API ====== | ====== Zone Control API ====== | ||
| - | API that configures the zone, which can control the entry device and door's operations. In BioStar, it is able to configure up to 4 types of zones. This feature will allow to divide one managing area to several zones for access control\\ | + | API that configures the zone, which can control the entry device and door's operations. This feature will allow to divide one managing area into several zones for access control\\ |
| ---- | ---- | ||
| Line 18: | Line 18: | ||
| * [[BS2_SetCheckGlobalAPBViolationHandler]]: Registers callback function for global determination when an APB violation alarm occurs. | * [[BS2_SetCheckGlobalAPBViolationHandler]]: Registers callback function for global determination when an APB violation alarm occurs. | ||
| * [[BS2_CheckGlobalAPBViolation]]: Transfers Global APB results to the device. | * [[BS2_CheckGlobalAPBViolation]]: Transfers Global APB results to the device. | ||
| + | * [[BS2_SetGlobalAPBViolationByDoorOpenHandler]]: [+ 2.7.0] Registers callback function for global determination when an APB violation by door alarm occurs. | ||
| + | * [[BS2_CheckGlobalAPBViolationByDoorOpen]]: [+ 2.7.0] Transfers Global APB by door open 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 85: | Line 89: | ||
| 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. 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). | + | 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), FS2(FW 1.1.0 or higher), FL(FW 1.0.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 99: | Line 103: | ||
| * [[BS2_RemoveDeviceZoneAGEntranceLimit]]: Removes selected Ethernet access group entrance limit. | * [[BS2_RemoveDeviceZoneAGEntranceLimit]]: Removes selected Ethernet access group entrance limit. | ||
| * [[BS2_RemoveAllDeviceZoneAGEntranceLimit]]: Removes all Ethernet access group entrance limit. | * [[BS2_RemoveAllDeviceZoneAGEntranceLimit]]: Removes all Ethernet access group entrance limit. | ||
| + | * [[BS2_GetDeviceZoneMasterConfig]]: Retrieves the zone master config of the Ethernet zone. | ||
| + | * [[BS2_SetDeviceZoneMasterConfig]]: Configures the zone master config of the Ethernet zone. | ||
| + | * [[BS2_RemoveDeviceZoneMasterConfig]]: Removes the zone master config of the Ethernet zone. | ||
| \\ | \\ | ||
| ---- | ---- | ||
| - | ==== Lift스케줄 잠금/개방 구역 ==== | + | ==== Lift Lock/Unlock Zone ==== |
| - | [+ 2.7.0] Elevator 제어관련, 인증권한과 무관하게 시간대를 기반으로 특정 층에 접근할 수 있도록 하는 새로운 함수들을 제공합니다. | + | [+ 2.7.0] To control the elevator floor regardless of access groups but only based on schedules, Lift lock/unlock zone can be used. |
| - | * [[BS2_GetLiftLockUnlockZone]]: 주어진 Lift스케줄 잠금/개방 구역을 가져옵니다. | + | * [[BS2_GetLiftLockUnlockZone]]: Retrieves selected Lift Lock/Unlock zones. |
| - | * [[BS2_GetAllLiftLockUnlockZone]]: 모든 Lift스케줄 잠금/개방 구역을 가져옵니다. | + | * [[BS2_GetAllLiftLockUnlockZone]]: Retrieves all Lift Lock/Unlock zones. |
| - | * [[BS2_GetLiftLockUnlockZoneStatus]]: 주어진 Lift스케줄 잠금/개방 구역의 상태 정보를 가져옵니다. | + | * [[BS2_GetLiftLockUnlockZoneStatus]]: Retrieves the status of selected Lift Lock/Unlock zones. |
| - | * [[BS2_GetAllLiftLockUnlockZoneStatus]]: 모든 Lift스케줄 잠금/개방 구역의 상태 정보를 가져옵니다. | + | * [[BS2_GetAllLiftLockUnlockZoneStatus]]: Retrieves the status of all Lift Lock/Unlock zones. |
| - | * [[BS2_SetLiftLockUnlockZone]]: Lift스케줄 잠금/개방 구역을 설정합니다. | + | * [[BS2_SetLiftLockUnlockZone]]: Configures a Lift Lock/Unlock zone. |
| - | * [[BS2_SetLiftLockUnlockZoneAlarm]]: Lift스케줄 잠금/개방 구역의 경보 상태를 갱신합니다. | + | * [[BS2_SetLiftLockUnlockZoneAlarm]]: Configures the alarm status of the Lift Lock/Unlock zone. |
| - | * [[BS2_RemoveLiftLockUnlockZone]]: 주어진 Lift스케줄 잠금/개방 구역을 제거합니다. | + | * [[BS2_RemoveLiftLockUnlockZone]]: Removes selected Lift Lock/Unlock zones. |
| - | * [[BS2_RemoveAllLiftLockUnlockZone]]: 모든 Lift스케줄 잠금/개방 구역을 제거합니다. | + | * [[BS2_RemoveAllLiftLockUnlockZone]]: Removes all Lift Lock/Unlock zones. |
| \\ | \\ | ||
| ---- | ---- | ||
| Line 132: | Line 139: | ||
| Indicates whether to Dual authentication. \\ \\ | Indicates whether to Dual authentication. \\ \\ | ||
| + | ==== OnCheckGlobalAPBViolationByDoorOpen ==== | ||
| + | 1st Callback function for requesting global determination based on authentication information when an APB violation by door alarm occurs. | ||
| + | <code cpp> | ||
| + | typedef void (*OnCheckGlobalAPBViolationByDoorOpen)(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. \\ \\ | ||
| + | |||
| + | ==== OnUpdateGlobalAPBViolationByDoorOpen ==== | ||
| + | 2nd Callback function for requesting the update of the final user access status when an APB violation by door alarm occurs. | ||
| + | <code cpp> | ||
| + | typedef void (*OnUpdateGlobalAPBViolationByDoorOpen)(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 ====== | ||
| ==== BS2ZoneStatus ==== | ==== BS2ZoneStatus ==== | ||
| Line 148: | Line 191: | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| - | |0 |Normal | | + | |0 |Normal, Disarm | |
| |1 |Alarm triggered | | |1 |Alarm triggered | | ||
| - | |2 |Scheduled lock | | + | |2 |Scheduled locked, Lift locked | |
| - | |4 |Scheduled unlock | | + | |4 |Scheduled unlocked, Lift unlocked | |
| + | |8 |Arm | | ||
| </WRAP> | </WRAP> | ||
| Line 764: | Line 808: | ||
| 8. //accessGroupID// \\ | 8. //accessGroupID// \\ | ||
| Access group ID list which can be configured up to 16. \\ \\ | Access group ID list which can be configured up to 16. \\ \\ | ||
| + | |||
| + | ==== BS2DeviceZoneMasterConfig ==== | ||
| + | <code cpp> | ||
| + | typedef struct | ||
| + | { | ||
| + | bool enable; | ||
| + | uint8_t reserved1[1]; | ||
| + | uint16_t listenPort; | ||
| + | uint8_t reserved[4]; | ||
| + | } BS2DeviceZoneMasterConfig; | ||
| + | </code> | ||
| + | 1. //enable// \\ | ||
| + | Decides whether the zone master is abled. \\ \\ | ||
| + | 2. //reserved1// \\ | ||
| + | Reserved space. \\ \\ | ||
| + | 3. //listenPort// \\ | ||
| + | TCP/IP port information to be connected from slave devices. \\ \\ | ||
| + | 4. //reserved// \\ | ||
| + | Reserved space. \\ \\ | ||