Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
en:door_control_api [2016/08/08 15:02] 127.0.0.1 external edit |
en:door_control_api [2026/03/11 16:00] (current) |
||
|---|---|---|---|
| Line 14: | Line 14: | ||
| * [[BS2_LockDoor]]: Configures the priority of when the door gets locked. The lock priority must be higher than the unlock to lock the door. | * [[BS2_LockDoor]]: Configures the priority of when the door gets locked. The lock priority must be higher than the unlock to lock the door. | ||
| * [[BS2_UnlockDoor]]: Configures the priority of when the door gets unlocked. The unlock priority must be higher than the lock to unlock the door. | * [[BS2_UnlockDoor]]: Configures the priority of when the door gets unlocked. The unlock priority must be higher than the lock to unlock the door. | ||
| + | * [[BS2_TimedLockDoor]]: [+ 2.9.12] Performs timed door lock. | ||
| + | * [[BS2_TimedUnlockDoor]]: [+ 2.9.12] Performs timed door unlock. | ||
| ===== Structure ====== | ===== Structure ====== | ||
| ==== BS2DoorRelay ==== | ==== BS2DoorRelay ==== | ||
| Line 35: | Line 37: | ||
| uint8_t port; | uint8_t port; | ||
| uint8_t switchType; | uint8_t switchType; | ||
| - | uint8_t reserved[2]; | + | uint8_t apbUseDoorSensor; |
| + | uint8_t reserved[1]; | ||
| } BS2DoorSensor ; | } BS2DoorSensor ; | ||
| </code> | </code> | ||
| Line 49: | Line 52: | ||
| |1 |Normally closed | | |1 |Normally closed | | ||
| </WRAP> | </WRAP> | ||
| - | 4. //reserved// \\ | + | 4. //apbUseDoorSensor// \\ |
| + | Decides whether to use a door sensor for APB. \\ | ||
| + | |||
| + | 5. //reserved// \\ | ||
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| ==== BS2ExitButton ==== | ==== BS2ExitButton ==== | ||
| Line 147: | Line 153: | ||
| uint8_t dualAuthDevice; | uint8_t dualAuthDevice; | ||
| uint8_t dualAuthApprovalType; | uint8_t dualAuthApprovalType; | ||
| + | uint16_t extendedAutoLockTimeout; | ||
| uint32_t dualAuthTimeout; | uint32_t dualAuthTimeout; | ||
| uint8_t numDualAuthApprovalGroups; | uint8_t numDualAuthApprovalGroups; | ||
| + | uint8_t unused[2]; | ||
| uint8_t reserved2[1]; | uint8_t reserved2[1]; | ||
| uint32_t dualAuthApprovalGroupID[BS2_MAX_DUAL_AUTH_APPROVAL_GROUP]; | uint32_t dualAuthApprovalGroupID[BS2_MAX_DUAL_AUTH_APPROVAL_GROUP]; | ||
| Line 155: | Line 163: | ||
| </code> | </code> | ||
| 1. //doorID// \\ | 1. //doorID// \\ | ||
| - | Door ID.\\ \\ | + | Door ID. For V1 devices, ID should be defined less than 65535. \\ \\ |
| 2. //name// \\ | 2. //name// \\ | ||
| - | Name of the door that will be displayed on the BioStar application.\\ \\ | + | Name of the door that will be displayed on the BioStar application. For V1 devices, name can't be defined. \\ \\ |
| 3. //entryDeviceID// \\ | 3. //entryDeviceID// \\ | ||
| Entry device ID.\\ \\ | Entry device ID.\\ \\ | ||
| Line 221: | Line 229: | ||
| |1 |Check the last user's authority | | |1 |Check the last user's authority | | ||
| </WRAP> | </WRAP> | ||
| - | 19. //dualAuthTimeout// \\ | + | 19. //extendedAutoLockTimeout// \\ |
| - | Interval between the first user's authentication and the second user's authentication. The unit is seconds.\\ \\ | + | [+ 2.9.12] Sets the extended access granted time in seconds. The default value is 10 seconds. \\ \\ |
| - | 20. //numDualAuthApprovalGroups// \\ | + | 20. //dualAuthTimeout// \\ |
| - | Number of access groups having authority of dual authentication.\\ \\ | + | After the first user completes authentication, this is the time to wait until the second user attempts authentication. (Unit: seconds) \\ \\ |
| - | 21. //reserved2// \\ | + | 21. //numDualAuthApprovalGroups// \\ |
| - | Reserved space.\\ \\ | + | Total number of groups with dual access authorization. \\ \\ |
| - | 22. //dualAuthApprovalGroupID// \\ | + | 22. //unused// \\ |
| + | Reserved space. \\ \\ | ||
| + | 23. //reserved2// \\ | ||
| + | Reserved space. \\ \\ | ||
| + | 24. //dualAuthApprovalGroupID// \\ | ||
| List of access groups having dual authentication authority, which can be configured up to 16 access groups.\\ \\ | List of access groups having dual authentication authority, which can be configured up to 16 access groups.\\ \\ | ||
| - | 23. //apbZone// \\ | + | 25. //apbZone// \\ |
| Configures Anti Passback on the door. The Anti Passback zone ID and door ID is equivalent. Refer [[zone_control_api]]for further information.\\ \\ | Configures Anti Passback on the door. The Anti Passback zone ID and door ID is equivalent. Refer [[zone_control_api]]for further information.\\ \\ | ||