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 [2018/12/19 17:47] yjjung [Ethernet Zone] |
en:zone_control_api [2023/09/01 08:37] (current) |
||
|---|---|---|---|
| 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 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). 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). | + | 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), 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 99: | ||
| * [[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 Lock/Unlock Zone ==== | ||
| + | [+ 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]]: Retrieves selected Lift Lock/Unlock zones. | ||
| + | * [[BS2_GetAllLiftLockUnlockZone]]: Retrieves all Lift Lock/Unlock zones. | ||
| + | * [[BS2_GetLiftLockUnlockZoneStatus]]: Retrieves the status of selected Lift Lock/Unlock zones. | ||
| + | * [[BS2_GetAllLiftLockUnlockZoneStatus]]: Retrieves the status of all Lift Lock/Unlock zones. | ||
| + | * [[BS2_SetLiftLockUnlockZone]]: Configures a Lift Lock/Unlock zone. | ||
| + | * [[BS2_SetLiftLockUnlockZoneAlarm]]: Configures the alarm status of the Lift Lock/Unlock zone. | ||
| + | * [[BS2_RemoveLiftLockUnlockZone]]: Removes selected Lift Lock/Unlock zones. | ||
| + | * [[BS2_RemoveAllLiftLockUnlockZone]]: Removes all Lift Lock/Unlock zones. | ||
| \\ | \\ | ||
| ---- | ---- | ||
| Line 136: | Line 151: | ||
| <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 752: | Line 768: | ||
| 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. \\ \\ | ||