Module access_control 

Access Control objects (ASHRAE 135-2020 Clause 12).

This module implements the seven BACnet access control object types:

• AccessDoor (type 30)
• AccessCredential (type 32)
• AccessPoint (type 33)
• AccessRights (type 34)
• AccessUser (type 35)
• AccessZone (type 36)
• CredentialDataInput (type 37)

evaluate_access_rights checks a credential against the Access Rights it is assigned, for the application to act on (#1331).

Structs

AccessCredentialObject

BACnet Access Credential object (type 32).

AccessDoorObject

BACnet Access Door object (type 30).

AccessEventReport

One access event at an Access Point: the values of Access_Event, Access_Event_Tag, Access_Event_Time, Access_Event_Credential and Access_Event_Authentication_Factor, which change together for each event (Clause 12.31.27.1).

AccessPointObject

BACnet Access Point object (type 33).

AccessRightsEvaluation

What evaluate_access_rights found for one credential at one Access Point.

AccessRightsObject

BACnet Access Rights object (type 34).

AccessRightsSnapshot

What an Access Rights object keeps across a restart. Each member is None until a write sets it: what the application configures applies at each start until then.

AccessRulePosition

Where an access rule sits: its Access Rights object, its array and its place in that array.

AccessUserObject

BACnet Access User object (type 35).

AccessZoneObject

BACnet Access Zone object (type 36).

CredentialDataInputObject

BACnet Credential Data Input object (type 37).

CredentialReadReport

A factor a Credential Data Input’s reader has read: its Present_Value and Update_Time, which move together (Clause 12.36.11).

DoorStateReport

What an Access Door’s hardware and door logic report: any of Door_Status, Lock_Status and Door_Alarm_State. A field left None keeps the value the door holds.

FileAccessRightsPersistence

A file holding one Access Rights object’s written rule arrays, Enable and Accompaniment, replaced whole on each save, the same way as FileNotificationClassPersistence: a failed save leaves the previous state in place, and a completed one survives a power loss.

UnresolvedAccessRights

An enabled Assigned_Access_Rights element that gave no rules.

Enums

AccessControlInput

An input for one access-control object, as the application reports it.

AccessRightsDecision

The outcome of the Access Rights check (Clause 12.34.9.2).

AccessRuleKind

Which rule array of an Access Rights object a rule comes from.

UnresolvedReason

Why an Assigned_Access_Rights element gave no rules.

Constants

DEFAULT_DOOR_EXTENDED_PULSE_TIME

Door_Extended_Pulse_Time a new door starts with, in tenths of a second (15 s).

DEFAULT_DOOR_OPEN_TOO_LONG_TIME

Door_Open_Too_Long_Time a new door starts with, in tenths of a second (30 s).

DEFAULT_DOOR_PULSE_TIME

Door_Pulse_Time a new door starts with, in tenths of a second (5 s).

MAX_ACCESS_RULES

The most rules either rule array holds, a resource cap. A longer list, from a setter or a network write, is RESOURCES / NO_SPACE_TO_WRITE_PROPERTY.

MAX_AUTHENTICATION_POLICIES

The most authentication policies an Access Point holds while it serves Authentication_Policy_List and Authentication_Policy_Names, a resource cap: a count or list past it is VALUE_OUT_OF_RANGE.

Traits

AccessRightsPersistence

Application-owned storage for one Access Rights object’s rule arrays, Enable and Accompaniment.

Functions

evaluate_access_rights

Check the Access Rights rules of credential, presented at point, as Clause 12.34.9.2 describes.