Types¶

BACnet type system: enumerations, primitive types, constructed (compound) types, and string parsing utilities. These types are used throughout the library for service parameters, object properties, and protocol encoding.

BACnet data types and enumerations.

Enumerations¶

BACnet enumeration types per ASHRAE 135-2020.

class bac_py.types.enums.ObjectType(*values)[source]¶

Bases: IntEnum

BACnet object types (Clause 12).

Vendor-proprietary types (128-1023) are accepted as pseudo-members via _missing_ so that devices with non-standard object types do not cause a ValueError during decoding.

ANALOG_INPUT = 0¶

ANALOG_OUTPUT = 1¶

ANALOG_VALUE = 2¶

BINARY_INPUT = 3¶

BINARY_OUTPUT = 4¶

BINARY_VALUE = 5¶

CALENDAR = 6¶

COMMAND = 7¶

DEVICE = 8¶

EVENT_ENROLLMENT = 9¶

FILE = 10¶

GROUP = 11¶

LOOP = 12¶

MULTI_STATE_INPUT = 13¶

MULTI_STATE_OUTPUT = 14¶

NOTIFICATION_CLASS = 15¶

PROGRAM = 16¶

SCHEDULE = 17¶

AVERAGING = 18¶

MULTI_STATE_VALUE = 19¶

TREND_LOG = 20¶

LIFE_SAFETY_POINT = 21¶

LIFE_SAFETY_ZONE = 22¶

ACCUMULATOR = 23¶

PULSE_CONVERTER = 24¶

EVENT_LOG = 25¶

GLOBAL_GROUP = 26¶

TREND_LOG_MULTIPLE = 27¶

LOAD_CONTROL = 28¶

STRUCTURED_VIEW = 29¶

ACCESS_DOOR = 30¶

TIMER = 31¶

ACCESS_CREDENTIAL = 32¶

ACCESS_POINT = 33¶

ACCESS_RIGHTS = 34¶

ACCESS_USER = 35¶

ACCESS_ZONE = 36¶

CREDENTIAL_DATA_INPUT = 37¶

NETWORK_SECURITY = 38¶

BITSTRING_VALUE = 39¶

CHARACTERSTRING_VALUE = 40¶

DATEPATTERN_VALUE = 41¶

DATE_VALUE = 42¶

DATETIMEPATTERN_VALUE = 43¶

DATETIME_VALUE = 44¶

INTEGER_VALUE = 45¶

LARGE_ANALOG_VALUE = 46¶

OCTETSTRING_VALUE = 47¶

POSITIVE_INTEGER_VALUE = 48¶

TIMEPATTERN_VALUE = 49¶

TIME_VALUE = 50¶

NOTIFICATION_FORWARDER = 51¶

ALERT_ENROLLMENT = 52¶

CHANNEL = 53¶

LIGHTING_OUTPUT = 54¶

BINARY_LIGHTING_OUTPUT = 55¶

NETWORK_PORT = 56¶

ELEVATOR_GROUP = 57¶

ESCALATOR = 58¶

LIFT = 59¶

STAGING = 60¶

AUDIT_REPORTER = 61¶

AUDIT_LOG = 62¶

class bac_py.types.enums.PropertyIdentifier(*values)[source]¶

Bases: IntEnum

BACnet property identifiers per ASHRAE 135-2020 Clause 21.

Gaps (18, 51, 55, 95, 101, etc.) are properties deleted from the standard.

Vendor-proprietary property IDs (512+) and any other values in the 22-bit property namespace (0–4194303) are accepted as pseudo-members via _missing_ so that devices with non-standard property IDs do not cause a ValueError during decoding.

ACKED_TRANSITIONS = 0¶

ACK_REQUIRED = 1¶

ACTION = 2¶

ACTION_TEXT = 3¶

ACTIVE_TEXT = 4¶

ACTIVE_VT_SESSIONS = 5¶

ALARM_VALUE = 6¶

ALARM_VALUES = 7¶

ALL = 8¶

ALL_WRITES_SUCCESSFUL = 9¶

APDU_SEGMENT_TIMEOUT = 10¶

APDU_TIMEOUT = 11¶

APPLICATION_SOFTWARE_VERSION = 12¶

ARCHIVE = 13¶

BIAS = 14¶

CHANGE_OF_STATE_COUNT = 15¶

CHANGE_OF_STATE_TIME = 16¶

NOTIFICATION_CLASS = 17¶

CONTROLLED_VARIABLE_REFERENCE = 19¶

CONTROLLED_VARIABLE_UNITS = 20¶

CONTROLLED_VARIABLE_VALUE = 21¶

COV_INCREMENT = 22¶

DATE_LIST = 23¶

DAYLIGHT_SAVINGS_STATUS = 24¶

DEADBAND = 25¶

DERIVATIVE_CONSTANT = 26¶

DERIVATIVE_CONSTANT_UNITS = 27¶

DESCRIPTION = 28¶

DESCRIPTION_OF_HALT = 29¶

DEVICE_ADDRESS_BINDING = 30¶

DEVICE_TYPE = 31¶

EFFECTIVE_PERIOD = 32¶

ELAPSED_ACTIVE_TIME = 33¶

ERROR_LIMIT = 34¶

EVENT_ENABLE = 35¶

EVENT_STATE = 36¶

EVENT_TYPE = 37¶

EXCEPTION_SCHEDULE = 38¶

FAULT_VALUES = 39¶

FEEDBACK_VALUE = 40¶

FILE_ACCESS_METHOD = 41¶

FILE_SIZE = 42¶

FILE_TYPE = 43¶

FIRMWARE_REVISION = 44¶

HIGH_LIMIT = 45¶

INACTIVE_TEXT = 46¶

IN_PROCESS = 47¶

INSTANCE_OF = 48¶

INTEGRAL_CONSTANT = 49¶

INTEGRAL_CONSTANT_UNITS = 50¶

ISSUE_CONFIRMED_NOTIFICATIONS = 51¶

LIMIT_ENABLE = 52¶

LIST_OF_GROUP_MEMBERS = 53¶

LIST_OF_OBJECT_PROPERTY_REFERENCES = 54¶

LOCAL_DATE = 56¶

LOCAL_TIME = 57¶

LOCATION = 58¶

LOW_LIMIT = 59¶

MANIPULATED_VARIABLE_REFERENCE = 60¶

MAXIMUM_OUTPUT = 61¶

MAX_APDU_LENGTH_ACCEPTED = 62¶

MAX_INFO_FRAMES = 63¶

MAX_MASTER = 64¶

MAX_PRES_VALUE = 65¶

MINIMUM_OFF_TIME = 66¶

MINIMUM_ON_TIME = 67¶

MINIMUM_OUTPUT = 68¶

MIN_PRES_VALUE = 69¶

MODEL_NAME = 70¶

MODIFICATION_DATE = 71¶

NOTIFY_TYPE = 72¶

NUMBER_OF_APDU_RETRIES = 73¶

NUMBER_OF_STATES = 74¶

OBJECT_IDENTIFIER = 75¶

OBJECT_LIST = 76¶

OBJECT_NAME = 77¶

OBJECT_PROPERTY_REFERENCE = 78¶

OBJECT_TYPE = 79¶

OPTIONAL = 80¶

OUT_OF_SERVICE = 81¶

OUTPUT_UNITS = 82¶

EVENT_PARAMETERS = 83¶

POLARITY = 84¶

PRESENT_VALUE = 85¶

PRIORITY = 86¶

PRIORITY_ARRAY = 87¶

PRIORITY_FOR_WRITING = 88¶

PROCESS_IDENTIFIER = 89¶

PROGRAM_CHANGE = 90¶

PROGRAM_LOCATION = 91¶

PROGRAM_STATE = 92¶

PROPORTIONAL_CONSTANT = 93¶

PROPORTIONAL_CONSTANT_UNITS = 94¶

PROTOCOL_OBJECT_TYPES_SUPPORTED = 96¶

PROTOCOL_SERVICES_SUPPORTED = 97¶

PROTOCOL_VERSION = 98¶

READ_ONLY = 99¶

REASON_FOR_HALT = 100¶

RECIPIENT_LIST = 102¶

RELIABILITY = 103¶

RELINQUISH_DEFAULT = 104¶

REQUIRED = 105¶

RESOLUTION = 106¶

SEGMENTATION_SUPPORTED = 107¶

SETPOINT = 108¶

SETPOINT_REFERENCE = 109¶

STATE_TEXT = 110¶

STATUS_FLAGS = 111¶

SYSTEM_STATUS = 112¶

TIME_DELAY = 113¶

TIME_OF_ACTIVE_TIME_RESET = 114¶

TIME_OF_STATE_COUNT_RESET = 115¶

TIME_SYNCHRONIZATION_RECIPIENTS = 116¶

UNITS = 117¶

UPDATE_INTERVAL = 118¶

UTC_OFFSET = 119¶

VENDOR_IDENTIFIER = 120¶

VENDOR_NAME = 121¶

VT_CLASSES_SUPPORTED = 122¶

WEEKLY_SCHEDULE = 123¶

ATTEMPTED_SAMPLES = 124¶

AVERAGE_VALUE = 125¶

BUFFER_SIZE = 126¶

CLIENT_COV_INCREMENT = 127¶

COV_RESUBSCRIPTION_INTERVAL = 128¶

EVENT_TIME_STAMPS = 130¶

LOG_BUFFER = 131¶

LOG_DEVICE_OBJECT_PROPERTY = 132¶

LOG_ENABLE = 133¶

LOG_INTERVAL = 134¶

MAXIMUM_VALUE = 135¶

MINIMUM_VALUE = 136¶

NOTIFICATION_THRESHOLD = 137¶

PROTOCOL_REVISION = 139¶

RECORDS_SINCE_NOTIFICATION = 140¶

RECORD_COUNT = 141¶

START_TIME = 142¶

STOP_TIME = 143¶

STOP_WHEN_FULL = 144¶

TOTAL_RECORD_COUNT = 145¶

VALID_SAMPLES = 146¶

WINDOW_INTERVAL = 147¶

WINDOW_SAMPLES = 148¶

MAXIMUM_VALUE_TIMESTAMP = 149¶

MINIMUM_VALUE_TIMESTAMP = 150¶

VARIANCE_VALUE = 151¶

ACTIVE_COV_SUBSCRIPTIONS = 152¶

BACKUP_FAILURE_TIMEOUT = 153¶

CONFIGURATION_FILES = 154¶

DATABASE_REVISION = 155¶

DIRECT_READING = 156¶

LAST_RESTORE_TIME = 157¶

MAINTENANCE_REQUIRED = 158¶

MEMBER_OF = 159¶

MODE = 160¶

OPERATION_EXPECTED = 161¶

SETTING = 162¶

SILENCED = 163¶

TRACKING_VALUE = 164¶

ZONE_MEMBERS = 165¶

LIFE_SAFETY_ALARM_VALUES = 166¶

MAX_SEGMENTS_ACCEPTED = 167¶

PROFILE_NAME = 168¶

AUTO_SLAVE_DISCOVERY = 169¶

MANUAL_SLAVE_ADDRESS_BINDING = 170¶

SLAVE_ADDRESS_BINDING = 171¶

SLAVE_PROXY_ENABLE = 172¶

LAST_NOTIFY_RECORD = 173¶

SCHEDULE_DEFAULT = 174¶

ACCEPTED_MODES = 175¶

ADJUST_VALUE = 176¶

COUNT = 177¶

COUNT_BEFORE_CHANGE = 178¶

COUNT_CHANGE_TIME = 179¶

COV_PERIOD = 180¶

INPUT_REFERENCE = 181¶

LIMIT_MONITORING_INTERVAL = 182¶

LOGGING_OBJECT = 183¶

LOGGING_RECORD = 184¶

PRESCALE = 185¶

PULSE_RATE = 186¶

SCALE = 187¶

SCALE_FACTOR = 188¶

UPDATE_TIME = 189¶

VALUE_BEFORE_CHANGE = 190¶

VALUE_SET = 191¶

VALUE_CHANGE_TIME = 192¶

ALIGN_INTERVALS = 193¶

INTERVAL_OFFSET = 195¶

LAST_RESTART_REASON = 196¶

LOGGING_TYPE = 197¶

RESTART_NOTIFICATION_RECIPIENTS = 202¶

TIME_OF_DEVICE_RESTART = 203¶

TIME_SYNCHRONIZATION_INTERVAL = 204¶

TRIGGER = 205¶

UTC_TIME_SYNCHRONIZATION_RECIPIENTS = 206¶

NODE_SUBTYPE = 207¶

NODE_TYPE = 208¶

STRUCTURED_OBJECT_LIST = 209¶

SUBORDINATE_ANNOTATIONS = 210¶

SUBORDINATE_LIST = 211¶

ACTUAL_SHED_LEVEL = 212¶

DUTY_WINDOW = 213¶

EXPECTED_SHED_LEVEL = 214¶

FULL_DUTY_BASELINE = 215¶

REQUESTED_SHED_LEVEL = 218¶

SHED_DURATION = 219¶

SHED_LEVEL_DESCRIPTIONS = 220¶

SHED_LEVELS = 221¶

STATE_DESCRIPTION = 222¶

DOOR_ALARM_STATE = 226¶

DOOR_EXTENDED_PULSE_TIME = 227¶

DOOR_MEMBERS = 228¶

DOOR_OPEN_TOO_LONG_TIME = 229¶

DOOR_PULSE_TIME = 230¶

DOOR_STATUS = 231¶

DOOR_UNLOCK_DELAY_TIME = 232¶

LOCK_STATUS = 233¶

MASKED_ALARM_VALUES = 234¶

SECURED_STATUS = 235¶

ABSENTEE_LIMIT = 244¶

ACCESS_ALARM_EVENTS = 245¶

ACCESS_DOORS = 246¶

ACCESS_EVENT = 247¶

ACCESS_EVENT_AUTHENTICATION_FACTOR = 248¶

ACCESS_EVENT_CREDENTIAL = 249¶

ACCESS_EVENT_TIME = 250¶

ACCESS_TRANSACTION_EVENTS = 251¶

ACCOMPANIMENT = 252¶

ACCOMPANIMENT_TIME = 253¶

ACTIVATION_TIME = 254¶

ACTIVE_AUTHENTICATION_POLICY = 255¶

ASSIGNED_ACCESS_RIGHTS = 256¶

AUTHENTICATION_FACTORS = 257¶

AUTHENTICATION_POLICY_LIST = 258¶

AUTHENTICATION_POLICY_NAMES = 259¶

AUTHENTICATION_STATUS = 260¶

AUTHORIZATION_MODE = 261¶

BELONGS_TO = 262¶

CREDENTIAL_DISABLE = 263¶

CREDENTIAL_STATUS = 264¶

CREDENTIALS = 265¶

CREDENTIALS_IN_ZONE = 266¶

DAYS_REMAINING = 267¶

ENTRY_POINTS = 268¶

EXIT_POINTS = 269¶

EXPIRATION_TIME = 270¶

EXTENDED_TIME_ENABLE = 271¶

FAILED_ATTEMPT_EVENTS = 272¶

FAILED_ATTEMPTS = 273¶

FAILED_ATTEMPTS_TIME = 274¶

LAST_ACCESS_EVENT = 275¶

LAST_ACCESS_POINT = 276¶

LAST_CREDENTIAL_ADDED = 277¶

LAST_CREDENTIAL_ADDED_TIME = 278¶

LAST_CREDENTIAL_REMOVED = 279¶

LAST_CREDENTIAL_REMOVED_TIME = 280¶

LAST_USE_TIME = 281¶

LOCKOUT = 282¶

LOCKOUT_RELINQUISH_TIME = 283¶

MAX_FAILED_ATTEMPTS = 285¶

MEMBERS = 286¶

MUSTER_POINT = 287¶

NEGATIVE_ACCESS_RULES = 288¶

NUMBER_OF_AUTHENTICATION_POLICIES = 289¶

OCCUPANCY_COUNT = 290¶

OCCUPANCY_COUNT_ADJUST = 291¶

OCCUPANCY_COUNT_ENABLE = 292¶

OCCUPANCY_LOWER_LIMIT = 294¶

OCCUPANCY_LOWER_LIMIT_ENFORCED = 295¶

OCCUPANCY_STATE = 296¶

OCCUPANCY_UPPER_LIMIT = 297¶

OCCUPANCY_UPPER_LIMIT_ENFORCED = 298¶

PASSBACK_MODE = 300¶

PASSBACK_TIMEOUT = 301¶

POSITIVE_ACCESS_RULES = 302¶

REASON_FOR_DISABLE = 303¶

SUPPORTED_FORMATS = 304¶

SUPPORTED_FORMAT_CLASSES = 305¶

THREAT_AUTHORITY = 306¶

THREAT_LEVEL = 307¶

TRACE_FLAG = 308¶

TRANSACTION_NOTIFICATION_CLASS = 309¶

USER_EXTERNAL_IDENTIFIER = 310¶

USER_INFORMATION_REFERENCE = 311¶

USER_NAME = 317¶

USER_TYPE = 318¶

USES_REMAINING = 319¶

ZONE_FROM = 320¶

ZONE_TO = 321¶

ACCESS_EVENT_TAG = 322¶

GLOBAL_IDENTIFIER = 323¶

VERIFICATION_TIME = 326¶

BASE_DEVICE_SECURITY_POLICY = 327¶

DISTRIBUTION_KEY_REVISION = 328¶

DO_NOT_HIDE = 329¶

KEY_SETS = 330¶

LAST_KEY_SERVER = 331¶

NETWORK_ACCESS_SECURITY_POLICIES = 332¶

PACKET_REORDER_TIME = 333¶

SECURITY_PDU_TIMEOUT = 334¶

SECURITY_TIME_WINDOW = 335¶

SUPPORTED_SECURITY_ALGORITHMS = 336¶

UPDATE_KEY_SET_TIMEOUT = 337¶

BACKUP_AND_RESTORE_STATE = 338¶

BACKUP_PREPARATION_TIME = 339¶

RESTORE_COMPLETION_TIME = 340¶

RESTORE_PREPARATION_TIME = 341¶

BIT_MASK = 342¶

BIT_TEXT = 343¶

IS_UTC = 344¶

GROUP_MEMBERS = 345¶

GROUP_MEMBER_NAMES = 346¶

MEMBER_STATUS_FLAGS = 347¶

REQUESTED_UPDATE_INTERVAL = 348¶

COVU_PERIOD = 349¶

COVU_RECIPIENTS = 350¶

EVENT_MESSAGE_TEXTS = 351¶

EVENT_MESSAGE_TEXTS_CONFIG = 352¶

EVENT_DETECTION_ENABLE = 353¶

EVENT_ALGORITHM_INHIBIT = 354¶

EVENT_ALGORITHM_INHIBIT_REF = 355¶

TIME_DELAY_NORMAL = 356¶

RELIABILITY_EVALUATION_INHIBIT = 357¶

FAULT_PARAMETERS = 358¶

FAULT_TYPE = 359¶

LOCAL_FORWARDING_ONLY = 360¶

PROCESS_IDENTIFIER_FILTER = 361¶

SUBSCRIBED_RECIPIENTS = 362¶

PORT_FILTER = 363¶

AUTHORIZATION_EXEMPTIONS = 364¶

ALLOW_GROUP_DELAY_INHIBIT = 365¶

CHANNEL_NUMBER = 366¶

CONTROL_GROUPS = 367¶

EXECUTION_DELAY = 368¶

LAST_PRIORITY = 369¶

WRITE_STATUS = 370¶

PROPERTY_LIST = 371¶

SERIAL_NUMBER = 372¶

BLINK_WARN_ENABLE = 373¶

DEFAULT_FADE_TIME = 374¶

DEFAULT_RAMP_RATE = 375¶

DEFAULT_STEP_INCREMENT = 376¶

EGRESS_TIME = 377¶

IN_PROGRESS = 378¶

INSTANTANEOUS_POWER = 379¶

LIGHTING_COMMAND = 380¶

LIGHTING_COMMAND_DEFAULT_PRIORITY = 381¶

MAX_ACTUAL_VALUE = 382¶

MIN_ACTUAL_VALUE = 383¶

POWER = 384¶

TRANSITION = 385¶

EGRESS_ACTIVE = 386¶

INTERFACE_VALUE = 387¶

FAULT_HIGH_LIMIT = 388¶

FAULT_LOW_LIMIT = 389¶

LOW_DIFF_LIMIT = 390¶

STRIKE_COUNT = 391¶

TIME_OF_STRIKE_COUNT_RESET = 392¶

DEFAULT_TIMEOUT = 393¶

INITIAL_TIMEOUT = 394¶

LAST_STATE_CHANGE = 395¶

STATE_CHANGE_VALUES = 396¶

TIMER_RUNNING = 397¶

TIMER_STATE = 398¶

APDU_LENGTH = 399¶

IP_ADDRESS = 400¶

IP_DEFAULT_GATEWAY = 401¶

IP_DHCP_ENABLE = 402¶

IP_DHCP_LEASE_TIME = 403¶

IP_DHCP_LEASE_TIME_REMAINING = 404¶

IP_DHCP_SERVER = 405¶

IP_DNS_SERVER = 406¶

BACNET_IP_GLOBAL_ADDRESS = 407¶

BACNET_IP_MODE = 408¶

BACNET_IP_MULTICAST_ADDRESS = 409¶

BACNET_IP_NAT_TRAVERSAL = 410¶

IP_SUBNET_MASK = 411¶

BACNET_IP_UDP_PORT = 412¶

BBMD_ACCEPT_FD_REGISTRATIONS = 413¶

BBMD_BROADCAST_DISTRIBUTION_TABLE = 414¶

BBMD_FOREIGN_DEVICE_TABLE = 415¶

CHANGES_PENDING = 416¶

COMMAND = 417¶

FD_BBMD_ADDRESS = 418¶

FD_SUBSCRIPTION_LIFETIME = 419¶

LINK_SPEED = 420¶

LINK_SPEEDS = 421¶

LINK_SPEED_AUTONEGOTIATE = 422¶

MAC_ADDRESS = 423¶

NETWORK_INTERFACE_NAME = 424¶

NETWORK_NUMBER = 425¶

NETWORK_NUMBER_QUALITY = 426¶

NETWORK_TYPE = 427¶

ROUTING_TABLE = 428¶

VIRTUAL_MAC_ADDRESS_TABLE = 429¶

COMMAND_TIME_ARRAY = 430¶

CURRENT_COMMAND_PRIORITY = 431¶

LAST_COMMAND_TIME = 432¶

VALUE_SOURCE = 433¶

VALUE_SOURCE_ARRAY = 434¶

BACNET_IPV6_MODE = 435¶

IPV6_ADDRESS = 436¶

IPV6_PREFIX_LENGTH = 437¶

BACNET_IPV6_UDP_PORT = 438¶

IPV6_DEFAULT_GATEWAY = 439¶

BACNET_IPV6_MULTICAST_ADDRESS = 440¶

IPV6_DNS_SERVER = 441¶

IPV6_AUTO_ADDRESSING_ENABLE = 442¶

IPV6_DHCP_LEASE_TIME = 443¶

IPV6_DHCP_LEASE_TIME_REMAINING = 444¶

IPV6_DHCP_SERVER = 445¶

IPV6_ZONE_INDEX = 446¶

ASSIGNED_LANDING_CALLS = 447¶

CAR_ASSIGNED_DIRECTION = 448¶

CAR_DOOR_COMMAND = 449¶

CAR_DOOR_STATUS = 450¶

CAR_DOOR_TEXT = 451¶

CAR_DOOR_ZONE = 452¶

CAR_DRIVE_STATUS = 453¶

CAR_LOAD = 454¶

CAR_LOAD_UNITS = 455¶

CAR_MODE = 456¶

CAR_MOVING_DIRECTION = 457¶

CAR_POSITION = 458¶

ELEVATOR_GROUP = 459¶

ENERGY_METER = 460¶

ENERGY_METER_REF = 461¶

ESCALATOR_MODE = 462¶

FAULT_SIGNALS = 463¶

FLOOR_TEXT = 464¶

GROUP_ID = 465¶

GROUP_MODE = 467¶

HIGHER_DECK = 468¶

INSTALLATION_ID = 469¶

LANDING_CALLS = 470¶

LANDING_CALL_CONTROL = 471¶

LANDING_DOOR_STATUS = 472¶

LOWER_DECK = 473¶

MACHINE_ROOM_ID = 474¶

MAKING_CAR_CALL = 475¶

NEXT_STOPPING_FLOOR = 476¶

OPERATION_DIRECTION = 477¶

PASSENGER_ALARM = 478¶

POWER_MODE = 479¶

REGISTERED_CAR_CALL = 480¶

ACTIVE_COV_MULTIPLE_SUBSCRIPTIONS = 481¶

PROTOCOL_LEVEL = 482¶

REFERENCE_PORT = 483¶

DEPLOYED_PROFILE_LOCATION = 484¶

PROFILE_LOCATION = 485¶

TAGS = 486¶

SUBORDINATE_NODE_TYPES = 487¶

SUBORDINATE_TAGS = 488¶

SUBORDINATE_RELATIONSHIPS = 489¶

DEFAULT_SUBORDINATE_RELATIONSHIP = 490¶

REPRESENTS = 491¶

DEFAULT_PRESENT_VALUE = 492¶

PRESENT_STAGE = 493¶

STAGES = 494¶

STAGE_NAMES = 495¶

TARGET_REFERENCES = 496¶

AUDIT_SOURCE_REPORTER = 497¶

AUDIT_LEVEL = 498¶

AUDIT_NOTIFICATION_RECIPIENT = 499¶

AUDIT_PRIORITY_FILTER = 500¶

AUDITABLE_OPERATIONS = 501¶

DELETE_ON_FORWARD = 502¶

MAXIMUM_SEND_DELAY = 503¶

MONITORED_OBJECTS = 504¶

SEND_NOW = 505¶

FLOOR_NUMBER = 506¶

DEVICE_UUID = 507¶

class bac_py.types.enums.ErrorClass(*values)[source]¶

Bases: IntEnum

BACnet error classes (Clause 18.1.1).

DEVICE = 0¶

OBJECT = 1¶

PROPERTY = 2¶

RESOURCES = 3¶

SECURITY = 4¶

SERVICES = 5¶

VT = 6¶

COMMUNICATION = 7¶

class bac_py.types.enums.ErrorCode(*values)[source]¶

Bases: IntEnum

BACnet error codes (Clause 18, Clause 21 numerical order).

OTHER = 0¶

AUTHENTICATION_FAILED = 1¶

CONFIGURATION_IN_PROGRESS = 2¶

DEVICE_BUSY = 3¶

DYNAMIC_CREATION_NOT_SUPPORTED = 4¶

FILE_ACCESS_DENIED = 5¶

INCOMPATIBLE_SECURITY_LEVELS = 6¶

INCONSISTENT_PARAMETERS = 7¶

INCONSISTENT_SELECTION_CRITERION = 8¶

INVALID_DATA_TYPE = 9¶

INVALID_FILE_ACCESS_METHOD = 10¶

INVALID_FILE_START_POSITION = 11¶

INVALID_OPERATOR_NAME = 12¶

INVALID_PARAMETER_DATA_TYPE = 13¶

INVALID_TIME_STAMP = 14¶

KEY_GENERATION_ERROR = 15¶

MISSING_REQUIRED_PARAMETER = 16¶

NO_OBJECTS_OF_SPECIFIED_TYPE = 17¶

NO_SPACE_FOR_OBJECT = 18¶

NO_SPACE_TO_ADD_LIST_ELEMENT = 19¶

NO_SPACE_TO_WRITE_PROPERTY = 20¶

NO_VT_SESSIONS_AVAILABLE = 21¶

PROPERTY_IS_NOT_A_LIST = 22¶

OBJECT_DELETION_NOT_PERMITTED = 23¶

OBJECT_IDENTIFIER_ALREADY_EXISTS = 24¶

OPERATIONAL_PROBLEM = 25¶

PASSWORD_FAILURE = 26¶

READ_ACCESS_DENIED = 27¶

SECURITY_NOT_SUPPORTED = 28¶

SERVICE_REQUEST_DENIED = 29¶

TIMEOUT = 30¶

UNKNOWN_OBJECT = 31¶

UNKNOWN_PROPERTY = 32¶

UNKNOWN_VT_CLASS = 34¶

UNKNOWN_VT_SESSION = 35¶

UNSUPPORTED_OBJECT_TYPE = 36¶

VALUE_OUT_OF_RANGE = 37¶

VT_SESSION_ALREADY_CLOSED = 38¶

VT_SESSION_TERMINATION_FAILURE = 39¶

WRITE_ACCESS_DENIED = 40¶

CHARACTER_SET_NOT_SUPPORTED = 41¶

INVALID_ARRAY_INDEX = 42¶

COV_SUBSCRIPTION_FAILED = 43¶

NOT_COV_PROPERTY = 44¶

OPTIONAL_FUNCTIONALITY_NOT_SUPPORTED = 45¶

INVALID_CONFIGURATION_DATA = 46¶

DATATYPE_NOT_SUPPORTED = 47¶

DUPLICATE_NAME = 48¶

DUPLICATE_OBJECT_ID = 49¶

PROPERTY_IS_NOT_AN_ARRAY = 50¶

ABORT_BUFFER_OVERFLOW = 51¶

ABORT_INVALID_APDU_IN_THIS_STATE = 52¶

ABORT_PREEMPTED_BY_HIGHER_PRIORITY_TASK = 53¶

ABORT_SEGMENTATION_NOT_SUPPORTED = 54¶

ABORT_PROPRIETARY = 55¶

ABORT_OTHER = 56¶

INVALID_TAG = 57¶

NETWORK_DOWN = 58¶

REJECT_BUFFER_OVERFLOW = 59¶

REJECT_INCONSISTENT_PARAMETERS = 60¶

REJECT_INVALID_PARAMETER_DATA_TYPE = 61¶

REJECT_INVALID_TAG = 62¶

REJECT_MISSING_REQUIRED_PARAMETER = 63¶

REJECT_PARAMETER_OUT_OF_RANGE = 64¶

REJECT_TOO_MANY_ARGUMENTS = 65¶

REJECT_UNDEFINED_ENUMERATION = 66¶

REJECT_UNRECOGNIZED_SERVICE = 67¶

REJECT_PROPRIETARY = 68¶

REJECT_OTHER = 69¶

UNKNOWN_DEVICE = 70¶

UNKNOWN_ROUTE = 71¶

VALUE_NOT_INITIALIZED = 72¶

INVALID_EVENT_STATE = 73¶

NO_ALARM_CONFIGURED = 74¶

LOG_BUFFER_FULL = 75¶

LOGGED_VALUE_PURGED = 76¶

NO_PROPERTY_SPECIFIED = 77¶

NOT_CONFIGURED_FOR_TRIGGERED_LOGGING = 78¶

UNKNOWN_SUBSCRIPTION = 79¶

PARAMETER_OUT_OF_RANGE = 80¶

LIST_ELEMENT_NOT_FOUND = 81¶

BUSY = 82¶

COMMUNICATION_DISABLED = 83¶

SUCCESS = 84¶

ACCESS_DENIED = 85¶

BAD_DESTINATION_ADDRESS = 86¶

BAD_DESTINATION_DEVICE_ID = 87¶

BAD_SIGNATURE = 88¶

BAD_SOURCE_ADDRESS = 89¶

BAD_TIMESTAMP = 90¶

CANNOT_USE_KEY = 91¶

CANNOT_VERIFY_MESSAGE_ID = 92¶

CORRECT_KEY_REVISION = 93¶

DESTINATION_DEVICE_ID_REQUIRED = 94¶

DUPLICATE_MESSAGE = 95¶

ENCRYPTION_NOT_CONFIGURED = 96¶

ENCRYPTION_REQUIRED = 97¶

INCORRECT_KEY = 98¶

INVALID_KEY_DATA = 99¶

KEY_UPDATE_IN_PROGRESS = 100¶

MALFORMED_MESSAGE = 101¶

NOT_KEY_SERVER = 102¶

SECURITY_NOT_CONFIGURED = 103¶

SOURCE_SECURITY_REQUIRED = 104¶

TOO_MANY_KEYS = 105¶

UNKNOWN_AUTHENTICATION_TYPE = 106¶

UNKNOWN_KEY = 107¶

UNKNOWN_KEY_REVISION = 108¶

UNKNOWN_SOURCE_MESSAGE = 109¶

NOT_ROUTER_TO_DNET = 110¶

ROUTER_BUSY = 111¶

UNKNOWN_NETWORK_MESSAGE = 112¶

MESSAGE_TOO_LONG = 113¶

SECURITY_ERROR = 114¶

ADDRESSING_ERROR = 115¶

WRITE_BDT_FAILED = 116¶

READ_BDT_FAILED = 117¶

REGISTER_FOREIGN_DEVICE_FAILED = 118¶

READ_FDT_FAILED = 119¶

DELETE_FDT_ENTRY_FAILED = 120¶

DISTRIBUTE_BROADCAST_FAILED = 121¶

UNKNOWN_FILE_SIZE = 122¶

ABORT_APDU_TOO_LONG = 123¶

ABORT_APPLICATION_EXCEEDED_REPLY_TIME = 124¶

ABORT_OUT_OF_RESOURCES = 125¶

ABORT_TSM_TIMEOUT = 126¶

ABORT_WINDOW_SIZE_OUT_OF_RANGE = 127¶

FILE_FULL = 128¶

INCONSISTENT_CONFIGURATION = 129¶

INCONSISTENT_OBJECT_TYPE = 130¶

INTERNAL_ERROR = 131¶

NOT_CONFIGURED = 132¶

OUT_OF_MEMORY = 133¶

VALUE_TOO_LONG = 134¶

ABORT_INSUFFICIENT_SECURITY = 135¶

ABORT_SECURITY_ERROR = 136¶

DUPLICATE_ENTRY = 137¶

INVALID_VALUE_IN_THIS_STATE = 138¶

class bac_py.types.enums.Segmentation(*values)[source]¶

Bases: IntEnum

BACnet segmentation support options (Clause 20.1.2.4).

BOTH = 0¶

TRANSMIT = 1¶

RECEIVE = 2¶

NONE = 3¶

class bac_py.types.enums.AbortReason(*values)[source]¶

Bases: IntEnum

BACnet abort reasons (Clause 20.1.9).

OTHER = 0¶

BUFFER_OVERFLOW = 1¶

INVALID_APDU_IN_THIS_STATE = 2¶

PREEMPTED_BY_HIGHER_PRIORITY_TASK = 3¶

SEGMENTATION_NOT_SUPPORTED = 4¶

SECURITY_ERROR = 5¶

INSUFFICIENT_SECURITY = 6¶

WINDOW_SIZE_OUT_OF_RANGE = 7¶

APPLICATION_EXCEEDED_REPLY_TIME = 8¶

OUT_OF_RESOURCES = 9¶

TSM_TIMEOUT = 10¶

APDU_TOO_LONG = 11¶

class bac_py.types.enums.RejectReason(*values)[source]¶

Bases: IntEnum

BACnet reject reasons (Clause 20.1.8).

OTHER = 0¶

BUFFER_OVERFLOW = 1¶

INCONSISTENT_PARAMETERS = 2¶

INVALID_PARAMETER_DATA_TYPE = 3¶

INVALID_TAG = 4¶

MISSING_REQUIRED_PARAMETER = 5¶

PARAMETER_OUT_OF_RANGE = 6¶

TOO_MANY_ARGUMENTS = 7¶

UNDEFINED_ENUMERATION = 8¶

UNRECOGNIZED_SERVICE = 9¶

class bac_py.types.enums.PduType(*values)[source]¶

Bases: IntEnum

APDU PDU type identifiers (Clause 20.1).

CONFIRMED_REQUEST = 0¶

UNCONFIRMED_REQUEST = 1¶

SIMPLE_ACK = 2¶

COMPLEX_ACK = 3¶

SEGMENT_ACK = 4¶

ERROR = 5¶

REJECT = 6¶

ABORT = 7¶

class bac_py.types.enums.ConfirmedServiceChoice(*values)[source]¶

Bases: IntEnum

Confirmed service request types (Clause 21).

ACKNOWLEDGE_ALARM = 0¶

CONFIRMED_COV_NOTIFICATION = 1¶

CONFIRMED_EVENT_NOTIFICATION = 2¶

GET_ALARM_SUMMARY = 3¶

GET_ENROLLMENT_SUMMARY = 4¶

SUBSCRIBE_COV = 5¶

ATOMIC_READ_FILE = 6¶

ATOMIC_WRITE_FILE = 7¶

ADD_LIST_ELEMENT = 8¶

REMOVE_LIST_ELEMENT = 9¶

CREATE_OBJECT = 10¶

DELETE_OBJECT = 11¶

READ_PROPERTY = 12¶

READ_PROPERTY_MULTIPLE = 14¶

WRITE_PROPERTY = 15¶

WRITE_PROPERTY_MULTIPLE = 16¶

DEVICE_COMMUNICATION_CONTROL = 17¶

CONFIRMED_PRIVATE_TRANSFER = 18¶

CONFIRMED_TEXT_MESSAGE = 19¶

REINITIALIZE_DEVICE = 20¶

VT_OPEN = 21¶

VT_CLOSE = 22¶

VT_DATA = 23¶

READ_RANGE = 26¶

LIFE_SAFETY_OPERATION = 27¶

SUBSCRIBE_COV_PROPERTY = 28¶

GET_EVENT_INFORMATION = 29¶

SUBSCRIBE_COV_PROPERTY_MULTIPLE = 30¶

CONFIRMED_COV_NOTIFICATION_MULTIPLE = 31¶

CONFIRMED_AUDIT_NOTIFICATION = 32¶

AUDIT_LOG_QUERY = 33¶

class bac_py.types.enums.UnconfirmedServiceChoice(*values)[source]¶

Bases: IntEnum

Unconfirmed service request types (Clause 21).

I_AM = 0¶

I_HAVE = 1¶

UNCONFIRMED_COV_NOTIFICATION = 2¶

UNCONFIRMED_EVENT_NOTIFICATION = 3¶

UNCONFIRMED_PRIVATE_TRANSFER = 4¶

UNCONFIRMED_TEXT_MESSAGE = 5¶

TIME_SYNCHRONIZATION = 6¶

WHO_HAS = 7¶

WHO_IS = 8¶

UTC_TIME_SYNCHRONIZATION = 9¶

WRITE_GROUP = 10¶

UNCONFIRMED_COV_NOTIFICATION_MULTIPLE = 11¶

UNCONFIRMED_AUDIT_NOTIFICATION = 12¶

WHO_AM_I = 13¶

YOU_ARE = 14¶

class bac_py.types.enums.NetworkPriority(*values)[source]¶

Bases: IntEnum

NPDU network priority levels (Clause 6.2.2).

NORMAL = 0¶

URGENT = 1¶

CRITICAL_EQUIPMENT = 2¶

LIFE_SAFETY = 3¶

class bac_py.types.enums.NetworkMessageType(*values)[source]¶

Bases: IntEnum

Network layer message types (Clause 6.2.4).

WHO_IS_ROUTER_TO_NETWORK = 0¶

I_AM_ROUTER_TO_NETWORK = 1¶

I_COULD_BE_ROUTER_TO_NETWORK = 2¶

REJECT_MESSAGE_TO_NETWORK = 3¶

ROUTER_BUSY_TO_NETWORK = 4¶

ROUTER_AVAILABLE_TO_NETWORK = 5¶

INITIALIZE_ROUTING_TABLE = 6¶

INITIALIZE_ROUTING_TABLE_ACK = 7¶

ESTABLISH_CONNECTION_TO_NETWORK = 8¶

DISCONNECT_CONNECTION_TO_NETWORK = 9¶

CHALLENGE_REQUEST = 10¶

SECURITY_PAYLOAD = 11¶

SECURITY_RESPONSE = 12¶

REQUEST_KEY_UPDATE = 13¶

UPDATE_KEY_SET = 14¶

UPDATE_DISTRIBUTION_KEY = 15¶

REQUEST_MASTER_KEY = 16¶

SET_MASTER_KEY = 17¶

WHAT_IS_NETWORK_NUMBER = 18¶

NETWORK_NUMBER_IS = 19¶

class bac_py.types.enums.BvlcFunction(*values)[source]¶

Bases: IntEnum

BVLC function codes (Annex J).

BVLC_RESULT = 0¶

WRITE_BROADCAST_DISTRIBUTION_TABLE = 1¶

READ_BROADCAST_DISTRIBUTION_TABLE = 2¶

READ_BROADCAST_DISTRIBUTION_TABLE_ACK = 3¶

FORWARDED_NPDU = 4¶

REGISTER_FOREIGN_DEVICE = 5¶

READ_FOREIGN_DEVICE_TABLE = 6¶

READ_FOREIGN_DEVICE_TABLE_ACK = 7¶

DELETE_FOREIGN_DEVICE_TABLE_ENTRY = 8¶

DISTRIBUTE_BROADCAST_TO_NETWORK = 9¶

ORIGINAL_UNICAST_NPDU = 10¶

ORIGINAL_BROADCAST_NPDU = 11¶

SECURE_BVLL = 12¶

class bac_py.types.enums.BvlcResultCode(*values)[source]¶

Bases: IntEnum

BVLC-Result codes (Annex J.2).

SUCCESSFUL_COMPLETION = 0¶

WRITE_BROADCAST_DISTRIBUTION_TABLE_NAK = 16¶

READ_BROADCAST_DISTRIBUTION_TABLE_NAK = 32¶

REGISTER_FOREIGN_DEVICE_NAK = 48¶

READ_FOREIGN_DEVICE_TABLE_NAK = 64¶

DELETE_FOREIGN_DEVICE_TABLE_ENTRY_NAK = 80¶

DISTRIBUTE_BROADCAST_TO_NETWORK_NAK = 96¶

class bac_py.types.enums.Bvlc6Function(*values)[source]¶

Bases: IntEnum

BACnet/IPv6 BVLC function codes (Annex U).

BVLC_RESULT = 0¶

ORIGINAL_UNICAST_NPDU = 1¶

ORIGINAL_BROADCAST_NPDU = 2¶

ADDRESS_RESOLUTION = 3¶

FORWARDED_ADDRESS_RESOLUTION = 4¶

ADDRESS_RESOLUTION_ACK = 5¶

VIRTUAL_ADDRESS_RESOLUTION = 6¶

VIRTUAL_ADDRESS_RESOLUTION_ACK = 7¶

FORWARDED_NPDU = 8¶

REGISTER_FOREIGN_DEVICE = 9¶

DELETE_FOREIGN_DEVICE_TABLE_ENTRY = 10¶

SECURE_BVLL = 11¶

DISTRIBUTE_BROADCAST_NPDU = 12¶

class bac_py.types.enums.Bvlc6ResultCode(*values)[source]¶

Bases: IntEnum

BACnet/IPv6 BVLC-Result codes (Annex U).

SUCCESSFUL_COMPLETION = 0¶

ADDRESS_RESOLUTION_NAK = 48¶

VIRTUAL_ADDRESS_RESOLUTION_NAK = 64¶

REGISTER_FOREIGN_DEVICE_NAK = 80¶

DELETE_FOREIGN_DEVICE_TABLE_ENTRY_NAK = 96¶

DISTRIBUTE_BROADCAST_TO_NETWORK_NAK = 112¶

class bac_py.types.enums.EventState(*values)[source]¶

Bases: IntEnum

BACnet event state enumeration (Clause 12).

NORMAL = 0¶

FAULT = 1¶

OFFNORMAL = 2¶

HIGH_LIMIT = 3¶

LOW_LIMIT = 4¶

LIFE_SAFETY_ALARM = 5¶

class bac_py.types.enums.BinaryPV(*values)[source]¶

Bases: IntEnum

BACnet binary present value enumeration (Clause 21).

INACTIVE = 0¶

ACTIVE = 1¶

class bac_py.types.enums.Polarity(*values)[source]¶

Bases: IntEnum

BACnet polarity enumeration (Clause 12).

NORMAL = 0¶

REVERSE = 1¶

class bac_py.types.enums.Reliability(*values)[source]¶

Bases: IntEnum

BACnet reliability enumeration (Clause 12).

Value 11 is intentionally omitted — it was removed from the standard and is not assigned to any reliability condition.

NO_FAULT_DETECTED = 0¶

NO_SENSOR = 1¶

OVER_RANGE = 2¶

UNDER_RANGE = 3¶

OPEN_LOOP = 4¶

SHORTED_LOOP = 5¶

NO_OUTPUT = 6¶

UNRELIABLE_OTHER = 7¶

PROCESS_ERROR = 8¶

MULTI_STATE_FAULT = 9¶

CONFIGURATION_ERROR = 10¶

COMMUNICATION_FAILURE = 12¶

MEMBER_FAULT = 13¶

MONITORED_OBJECT_FAULT = 14¶

TRIPPED = 15¶

LAMP_FAILURE = 16¶

ACTIVATION_FAILURE = 17¶

RENEW_DHCP_FAILURE = 18¶

RENEW_FD_REGISTRATION_FAILURE = 19¶

RESTART_AUTO_NEGOTIATION_FAILURE = 20¶

RESTART_FAILURE = 21¶

PROPRIETARY_COMMAND_FAILURE = 22¶

FAULTS_LISTED = 23¶

REFERENCED_OBJECT_FAULT = 24¶

class bac_py.types.enums.EngineeringUnits(*values)[source]¶

Bases: IntEnum

BACnet engineering units enumeration (Clause 21).

Complete per ASHRAE 135-2020. Values 0-255 and 47808-49999 are reserved for ASHRAE; 256-47807 and 50000-65535 may be used by vendors (Clause 23).

METERS_PER_SECOND_PER_SECOND = 166¶

SQUARE_METERS = 0¶

SQUARE_CENTIMETERS = 116¶

SQUARE_FEET = 1¶

SQUARE_INCHES = 115¶

CURRENCY1 = 105¶

CURRENCY2 = 106¶

CURRENCY3 = 107¶

CURRENCY4 = 108¶

CURRENCY5 = 109¶

CURRENCY6 = 110¶

CURRENCY7 = 111¶

CURRENCY8 = 112¶

CURRENCY9 = 113¶

CURRENCY10 = 114¶

MILLIAMPERES = 2¶

AMPERES = 3¶

AMPERES_PER_METER = 167¶

AMPERES_PER_SQUARE_METER = 168¶

AMPERE_SQUARE_METERS = 169¶

DECIBELS = 199¶

DECIBELS_MILLIVOLT = 200¶

DECIBELS_VOLT = 201¶

FARADS = 170¶

HENRYS = 171¶

OHMS = 4¶

OHM_METER_SQUARED_PER_METER = 237¶

OHM_METERS = 172¶

MILLIOHMS = 145¶

KILOHMS = 122¶

MEGOHMS = 123¶

MICROSIEMENS = 190¶

MILLISIEMENS = 202¶

SIEMENS = 173¶

SIEMENS_PER_METER = 174¶

TESLAS = 175¶

VOLTS = 5¶

MILLIVOLTS = 124¶

KILOVOLTS = 6¶

MEGAVOLTS = 7¶

VOLT_AMPERES = 8¶

KILOVOLT_AMPERES = 9¶

MEGAVOLT_AMPERES = 10¶

VOLT_AMPERES_REACTIVE = 11¶

KILOVOLT_AMPERES_REACTIVE = 12¶

MEGAVOLT_AMPERES_REACTIVE = 13¶

VOLTS_PER_DEGREE_KELVIN = 176¶

VOLTS_PER_METER = 177¶

DEGREES_PHASE = 14¶

POWER_FACTOR = 15¶

WEBERS = 178¶

AMPERE_SECONDS = 238¶

VOLT_AMPERE_HOURS = 239¶

KILOVOLT_AMPERE_HOURS = 240¶

MEGAVOLT_AMPERE_HOURS = 241¶

VOLT_AMPERE_HOURS_REACTIVE = 242¶

KILOVOLT_AMPERE_HOURS_REACTIVE = 243¶

MEGAVOLT_AMPERE_HOURS_REACTIVE = 244¶

VOLT_SQUARE_HOURS = 245¶

AMPERE_SQUARE_HOURS = 246¶

JOULES = 16¶

KILOJOULES = 17¶

KILOJOULES_PER_KILOGRAM = 125¶

MEGAJOULES = 126¶

WATT_HOURS = 18¶

KILOWATT_HOURS = 19¶

MEGAWATT_HOURS = 146¶

WATT_HOURS_REACTIVE = 203¶

KILOWATT_HOURS_REACTIVE = 204¶

MEGAWATT_HOURS_REACTIVE = 205¶

BTUS = 20¶

KILO_BTUS = 147¶

MEGA_BTUS = 148¶

THERMS = 21¶

TON_HOURS = 22¶

JOULES_PER_KILOGRAM_DRY_AIR = 23¶

KILOJOULES_PER_KILOGRAM_DRY_AIR = 149¶

MEGAJOULES_PER_KILOGRAM_DRY_AIR = 150¶

BTUS_PER_POUND_DRY_AIR = 24¶

BTUS_PER_POUND = 117¶

JOULES_PER_DEGREE_KELVIN = 127¶

KILOJOULES_PER_DEGREE_KELVIN = 151¶

MEGAJOULES_PER_DEGREE_KELVIN = 152¶

JOULES_PER_KILOGRAM_DEGREE_KELVIN = 128¶

NEWTON = 153¶

CYCLES_PER_HOUR = 25¶

CYCLES_PER_MINUTE = 26¶

HERTZ = 27¶

KILOHERTZ = 129¶

MEGAHERTZ = 130¶

PER_HOUR = 131¶

GRAMS_OF_WATER_PER_KILOGRAM_DRY_AIR = 28¶

PERCENT_RELATIVE_HUMIDITY = 29¶

MICROMETERS = 194¶

MILLIMETERS = 30¶

CENTIMETERS = 118¶

KILOMETERS = 193¶

METERS = 31¶

INCHES = 32¶

FEET = 33¶

CANDELAS = 179¶

CANDELAS_PER_SQUARE_METER = 180¶

WATTS_PER_SQUARE_FOOT = 34¶

WATTS_PER_SQUARE_METER = 35¶

LUMENS = 36¶

LUXES = 37¶

FOOT_CANDLES = 38¶

MILLIGRAMS = 196¶

GRAMS = 195¶

KILOGRAMS = 39¶

POUNDS_MASS = 40¶

TONS = 41¶

GRAMS_PER_SECOND = 154¶

GRAMS_PER_MINUTE = 155¶

KILOGRAMS_PER_SECOND = 42¶

KILOGRAMS_PER_MINUTE = 43¶

KILOGRAMS_PER_HOUR = 44¶

POUNDS_MASS_PER_SECOND = 119¶

POUNDS_MASS_PER_MINUTE = 45¶

POUNDS_MASS_PER_HOUR = 46¶

TONS_PER_HOUR = 156¶

MILLIWATTS = 132¶

WATTS = 47¶

KILOWATTS = 48¶

MEGAWATTS = 49¶

BTUS_PER_HOUR = 50¶

KILO_BTUS_PER_HOUR = 157¶

JOULE_PER_HOURS = 247¶

HORSEPOWER = 51¶

TONS_REFRIGERATION = 52¶

PASCALS = 53¶

HECTOPASCALS = 133¶

KILOPASCALS = 54¶

MILLIBARS = 134¶

BARS = 55¶

POUNDS_FORCE_PER_SQUARE_INCH = 56¶

MILLIMETERS_OF_WATER = 206¶

CENTIMETERS_OF_WATER = 57¶

INCHES_OF_WATER = 58¶

MILLIMETERS_OF_MERCURY = 59¶

CENTIMETERS_OF_MERCURY = 60¶

INCHES_OF_MERCURY = 61¶

DEGREES_CELSIUS = 62¶

DEGREES_KELVIN = 63¶

DEGREES_KELVIN_PER_HOUR = 181¶

DEGREES_KELVIN_PER_MINUTE = 182¶

DEGREES_FAHRENHEIT = 64¶

DEGREE_DAYS_CELSIUS = 65¶

DEGREE_DAYS_FAHRENHEIT = 66¶

DELTA_DEGREES_FAHRENHEIT = 120¶

DELTA_DEGREES_KELVIN = 121¶

YEARS = 67¶

MONTHS = 68¶

WEEKS = 69¶

DAYS = 70¶

HOURS = 71¶

MINUTES = 72¶

SECONDS = 73¶

HUNDREDTHS_SECONDS = 158¶

MILLISECONDS = 159¶

NEWTON_METERS = 160¶

MILLIMETERS_PER_SECOND = 161¶

MILLIMETERS_PER_MINUTE = 162¶

METERS_PER_SECOND = 74¶

METERS_PER_MINUTE = 163¶

METERS_PER_HOUR = 164¶

KILOMETERS_PER_HOUR = 75¶

FEET_PER_SECOND = 76¶

FEET_PER_MINUTE = 77¶

MILES_PER_HOUR = 78¶

CUBIC_FEET = 79¶

CUBIC_METERS = 80¶

IMPERIAL_GALLONS = 81¶

MILLILITERS = 197¶

LITERS = 82¶

US_GALLONS = 83¶

CUBIC_FEET_PER_SECOND = 142¶

CUBIC_FEET_PER_MINUTE = 84¶

MILLION_STANDARD_CUBIC_FEET_PER_MINUTE = 254¶

CUBIC_FEET_PER_HOUR = 191¶

CUBIC_FEET_PER_DAY = 248¶

STANDARD_CUBIC_FEET_PER_DAY = 47808¶

MILLION_STANDARD_CUBIC_FEET_PER_DAY = 47809¶

THOUSAND_CUBIC_FEET_PER_DAY = 47810¶

THOUSAND_STANDARD_CUBIC_FEET_PER_DAY = 47811¶

POUNDS_MASS_PER_DAY = 47812¶

CUBIC_METERS_PER_SECOND = 85¶

CUBIC_METERS_PER_MINUTE = 165¶

CUBIC_METERS_PER_HOUR = 135¶

CUBIC_METERS_PER_DAY = 249¶

IMPERIAL_GALLONS_PER_MINUTE = 86¶

MILLILITERS_PER_SECOND = 198¶

LITERS_PER_SECOND = 87¶

LITERS_PER_MINUTE = 88¶

LITERS_PER_HOUR = 136¶

US_GALLONS_PER_MINUTE = 89¶

US_GALLONS_PER_HOUR = 192¶

DEGREES_ANGULAR = 90¶

DEGREES_CELSIUS_PER_HOUR = 91¶

DEGREES_CELSIUS_PER_MINUTE = 92¶

DEGREES_FAHRENHEIT_PER_HOUR = 93¶

DEGREES_FAHRENHEIT_PER_MINUTE = 94¶

JOULE_SECONDS = 183¶

KILOGRAMS_PER_CUBIC_METER = 186¶

KILOWATT_HOURS_PER_SQUARE_METER = 137¶

KILOWATT_HOURS_PER_SQUARE_FOOT = 138¶

WATT_HOURS_PER_CUBIC_METER = 250¶

JOULES_PER_CUBIC_METER = 251¶

MEGAJOULES_PER_SQUARE_METER = 139¶

MEGAJOULES_PER_SQUARE_FOOT = 140¶

MOLE_PERCENT = 252¶

NO_UNITS = 95¶

NEWTON_SECONDS = 187¶

NEWTONS_PER_METER = 188¶

PARTS_PER_MILLION = 96¶

PARTS_PER_BILLION = 97¶

PASCAL_SECONDS = 253¶

PERCENT = 98¶

PERCENT_OBSCURATION_PER_FOOT = 143¶

PERCENT_OBSCURATION_PER_METER = 144¶

PERCENT_PER_SECOND = 99¶

PER_MINUTE = 100¶

PER_SECOND = 101¶

PSI_PER_DEGREE_FAHRENHEIT = 102¶

RADIANS = 103¶

RADIANS_PER_SECOND = 184¶

REVOLUTIONS_PER_MINUTE = 104¶

SQUARE_METERS_PER_NEWTON = 185¶

WATTS_PER_METER_PER_DEGREE_KELVIN = 189¶

WATTS_PER_SQUARE_METER_DEGREE_KELVIN = 141¶

PER_MILLE = 207¶

GRAMS_PER_GRAM = 208¶

KILOGRAMS_PER_KILOGRAM = 209¶

GRAMS_PER_KILOGRAM = 210¶

MILLIGRAMS_PER_GRAM = 211¶

MILLIGRAMS_PER_KILOGRAM = 212¶

GRAMS_PER_MILLILITER = 213¶

GRAMS_PER_LITER = 214¶

MILLIGRAMS_PER_LITER = 215¶

MICROGRAMS_PER_LITER = 216¶

GRAMS_PER_CUBIC_METER = 217¶

MILLIGRAMS_PER_CUBIC_METER = 218¶

MICROGRAMS_PER_CUBIC_METER = 219¶

NANOGRAMS_PER_CUBIC_METER = 220¶

GRAMS_PER_CUBIC_CENTIMETER = 221¶

BECQUERELS = 222¶

KILOBECQUERELS = 223¶

MEGABECQUERELS = 224¶

GRAY = 225¶

MILLIGRAY = 226¶

MICROGRAY = 227¶

SIEVERTS = 228¶

MILLISIEVERTS = 229¶

MICROSIEVERTS = 230¶

MICROSIEVERTS_PER_HOUR = 231¶

MILLIREMS = 47814¶

MILLIREMS_PER_HOUR = 47815¶

DECIBELS_A = 232¶

NEPHELOMETRIC_TURBIDITY_UNIT = 233¶

PH = 234¶

GRAMS_PER_SQUARE_METER = 235¶

MINUTES_PER_DEGREE_KELVIN = 236¶

DEGREES_LOVIBOND = 47816¶

ALCOHOL_BY_VOLUME = 47817¶

INTERNATIONAL_BITTERING_UNITS = 47818¶

EUROPEAN_BITTERNESS_UNITS = 47819¶

DEGREES_PLATO = 47820¶

SPECIFIC_GRAVITY = 47821¶

EUROPEAN_BREWING_CONVENTION = 47822¶

class bac_py.types.enums.EnableDisable(*values)[source]¶

Bases: IntEnum

BACnetEnableDisable values (Clause 16.4).

ENABLE = 0¶

DISABLE = 1¶

DISABLE_INITIATION = 2¶

class bac_py.types.enums.ReinitializedState(*values)[source]¶

Bases: IntEnum

BACnetReinitializedStateOfDevice values (Clause 16.5).

COLDSTART = 0¶

WARMSTART = 1¶

START_BACKUP = 2¶

END_BACKUP = 3¶

START_RESTORE = 4¶

END_RESTORE = 5¶

ABORT_RESTORE = 6¶

ACTIVATE_CHANGES = 7¶

class bac_py.types.enums.FileAccessMethod(*values)[source]¶

Bases: IntEnum

BACnetFileAccessMethod values (Clause 12.12).

STREAM_ACCESS = 0¶

RECORD_ACCESS = 1¶

class bac_py.types.enums.ProgramState(*values)[source]¶

Bases: IntEnum

BACnetProgramState values (Clause 12.22).

IDLE = 0¶

LOADING = 1¶

RUNNING = 2¶

WAITING = 3¶

HALTED = 4¶

UNLOADING = 5¶

class bac_py.types.enums.ProgramChange(*values)[source]¶

Bases: IntEnum

BACnetProgramRequest values (Clause 12.22).

READY = 0¶

LOAD = 1¶

RUN = 2¶

HALT = 3¶

RESTART = 4¶

UNLOAD = 5¶

class bac_py.types.enums.Action(*values)[source]¶

Bases: IntEnum

BACnetAction values (Clause 12.17).

DIRECT = 0¶

REVERSE = 1¶

class bac_py.types.enums.DeviceStatus(*values)[source]¶

Bases: IntEnum

BACnetDeviceStatus values (Clause 12.11.9).

OPERATIONAL = 0¶

OPERATIONAL_READ_ONLY = 1¶

DOWNLOAD_REQUIRED = 2¶

DOWNLOAD_IN_PROGRESS = 3¶

NON_OPERATIONAL = 4¶

BACKUP_IN_PROGRESS = 5¶

class bac_py.types.enums.BackupAndRestoreState(*values)[source]¶

Bases: IntEnum

BACnetBackupAndRestoreState values (Clause 19.1).

IDLE = 0¶

PREPARING_FOR_BACKUP = 1¶

PREPARING_FOR_RESTORE = 2¶

PERFORMING_A_BACKUP = 3¶

PERFORMING_A_RESTORE = 4¶

class bac_py.types.enums.EventType(*values)[source]¶

Bases: IntEnum

BACnetEventType values (Clause 12.12.6).

CHANGE_OF_BITSTRING = 0¶

CHANGE_OF_STATE = 1¶

CHANGE_OF_VALUE = 2¶

COMMAND_FAILURE = 3¶

FLOATING_LIMIT = 4¶

OUT_OF_RANGE = 5¶

CHANGE_OF_LIFE_SAFETY = 8¶

EXTENDED = 9¶

BUFFER_READY = 10¶

UNSIGNED_RANGE = 11¶

ACCESS_EVENT = 13¶

DOUBLE_OUT_OF_RANGE = 14¶

SIGNED_OUT_OF_RANGE = 15¶

UNSIGNED_OUT_OF_RANGE = 16¶

CHANGE_OF_CHARACTERSTRING = 17¶

CHANGE_OF_STATUS_FLAGS = 18¶

CHANGE_OF_RELIABILITY = 19¶

NONE = 20¶

CHANGE_OF_DISCRETE_VALUE = 21¶

CHANGE_OF_TIMER = 22¶

class bac_py.types.enums.LoggingType(*values)[source]¶

Bases: IntEnum

BACnetLoggingType values (Clause 12.25.14).

POLLED = 0¶

COV = 1¶

TRIGGERED = 2¶

class bac_py.types.enums.NotifyType(*values)[source]¶

Bases: IntEnum

BACnetNotifyType values (Clause 12.21).

ALARM = 0¶

EVENT = 1¶

ACK_NOTIFICATION = 2¶

class bac_py.types.enums.RejectMessageReason(*values)[source]¶

Bases: IntEnum

Reject-Message-To-Network reason codes (Clause 6.4.4).

OTHER = 0¶

NOT_DIRECTLY_CONNECTED = 1¶

ROUTER_BUSY = 2¶

UNKNOWN_MESSAGE_TYPE = 3¶

MESSAGE_TOO_LONG = 4¶

SECURITY_ERROR = 5¶

ADDRESSING_ERROR = 6¶

class bac_py.types.enums.NetworkReachability(*values)[source]¶

Bases: IntEnum

Reachability status for a routing table entry (Clause 6.6.1).

REACHABLE = 0¶

BUSY = 1¶

UNREACHABLE = 2¶

class bac_py.types.enums.NetworkType(*values)[source]¶

Bases: IntEnum

BACnet data link/network layer type (Clause 12.56.44).

ETHERNET = 0¶

ARCNET = 1¶

MSTP = 2¶

PTP = 3¶

LONTALK = 4¶

IPV4 = 5¶

ZIGBEE = 6¶

VIRTUAL = 7¶

NON_BACNET = 8¶

IPV6 = 9¶

SERIAL = 10¶

class bac_py.types.enums.IPMode(*values)[source]¶

Bases: IntEnum

IP addressing mode for a NetworkPort (Clause 12.56).

NORMAL = 0¶

FOREIGN = 1¶

BBMD = 2¶

class bac_py.types.enums.NetworkPortCommand(*values)[source]¶

Bases: IntEnum

Commands for a NetworkPort object (Clause 12.56.40).

IDLE = 0¶

DISCARD_CHANGES = 1¶

RENEW_FD_REGISTRATION = 2¶

RESTART_SLAVE_DISCOVERY = 3¶

RENEW_DHCP = 4¶

RESTART_AUTONEG = 5¶

DISCONNECT = 6¶

RESTART_PORT = 7¶

class bac_py.types.enums.NetworkNumberQuality(*values)[source]¶

Bases: IntEnum

Quality of a NetworkPort’s network number (Clause 12.56.42).

UNKNOWN = 0¶

LEARNED = 1¶

LEARNED_CONFIGURED = 2¶

CONFIGURED = 3¶

class bac_py.types.enums.ProtocolLevel(*values)[source]¶

Bases: IntEnum

Protocol level of a NetworkPort (Clause 12.56).

PHYSICAL = 0¶

PROTOCOL = 1¶

BACNET_APPLICATION = 2¶

NON_BACNET_APPLICATION = 3¶

class bac_py.types.enums.WriteStatus(*values)[source]¶

Bases: IntEnum

Status of the last Channel write operation (Clause 12.53).

IDLE = 0¶

IN_PROGRESS = 1¶

SUCCESSFUL = 2¶

FAILED = 3¶

class bac_py.types.enums.LifeSafetyState(*values)[source]¶

Bases: IntEnum

Life safety point/zone sensor state (Clause 12.15/12.16).

QUIET = 0¶

PRE_ALARM = 1¶

ALARM = 2¶

FAULT = 3¶

FAULT_PRE_ALARM = 4¶

FAULT_ALARM = 5¶

NOT_READY = 6¶

ACTIVE = 7¶

TAMPER = 8¶

TEST_ALARM = 9¶

TEST_ACTIVE = 10¶

TEST_FAULT = 11¶

TEST_FAULT_ALARM = 12¶

HOLDUP = 13¶

DURESS = 14¶

TAMPER_ALARM = 15¶

ABNORMAL = 16¶

EMERGENCY_POWER = 17¶

DELAYED = 18¶

BLOCKED = 19¶

LOCAL_ALARM = 20¶

GENERAL_ALARM = 21¶

SUPERVISORY = 22¶

TEST_SUPERVISORY = 23¶

class bac_py.types.enums.LifeSafetyMode(*values)[source]¶

Bases: IntEnum

Life safety operating mode (Clause 12.15.12).

OFF = 0¶

ON = 1¶

TEST = 2¶

MANNED = 3¶

UNMANNED = 4¶

ARMED = 5¶

DISARMED = 6¶

PRE_ARMED = 7¶

SLOW = 8¶

FAST = 9¶

DISCONNECTED = 10¶

ENABLED = 11¶

DISABLED = 12¶

AUTOMATIC_RELEASE_DISABLED = 13¶

DEFAULT = 14¶

class bac_py.types.enums.LifeSafetyOperation(*values)[source]¶

Bases: IntEnum

Life safety commanded operation (Clause 12.15.13).

NONE = 0¶

SILENCE = 1¶

SILENCE_AUDIBLE = 2¶

SILENCE_VISUAL = 3¶

SILENCE_ALL = 4¶

UNSILENCE = 5¶

UNSILENCE_AUDIBLE = 6¶

UNSILENCE_VISUAL = 7¶

UNSILENCE_ALL = 8¶

RESET = 9¶

RESET_ALARM = 10¶

RESET_FAULT = 11¶

class bac_py.types.enums.SilencedState(*values)[source]¶

Bases: IntEnum

Silenced state for a life safety point/zone (Clause 12.15.14).

UNSILENCED = 0¶

AUDIBLE_SILENCED = 1¶

VISIBLE_SILENCED = 2¶

ALL_SILENCED = 3¶

class bac_py.types.enums.AcknowledgmentFilter(*values)[source]¶

Bases: IntEnum

BACnet acknowledgment filter for GetEnrollmentSummary (Clause 13.7.1).

ALL = 0¶

ACKED = 1¶

NOT_ACKED = 2¶

class bac_py.types.enums.EventTransitionBits(*values)[source]¶

Bases: IntEnum

Positional constants for the 3-element event transition bitstring.

Used to index into event_enable and acked_transitions bitstrings (Clause 12.11).

TO_OFFNORMAL = 0¶

TO_FAULT = 1¶

TO_NORMAL = 2¶

class bac_py.types.enums.TimerState(*values)[source]¶

Bases: IntEnum

BACnet timer state enumeration (Clause 12.31, new in 2020).

IDLE = 0¶

RUNNING = 1¶

EXPIRED = 2¶

class bac_py.types.enums.TimerTransition(*values)[source]¶

Bases: IntEnum

BACnet timer state transition enumeration (Clause 12.31, new in 2020).

NONE = 0¶

IDLE_TO_RUNNING = 1¶

RUNNING_TO_IDLE = 2¶

RUNNING_TO_RUNNING = 3¶

RUNNING_TO_EXPIRED = 4¶

FORCED_TO_EXPIRED = 5¶

EXPIRED_TO_IDLE = 6¶

EXPIRED_TO_RUNNING = 7¶

class bac_py.types.enums.MessagePriority(*values)[source]¶

Bases: IntEnum

BACnet message priority for TextMessage services (Clause 16.5).

NORMAL = 0¶

URGENT = 1¶

class bac_py.types.enums.VTClass(*values)[source]¶

Bases: IntEnum

BACnet virtual terminal class (Clause 17.1).

DEFAULT_TERMINAL = 0¶

ANSI_X3_64 = 1¶

DEC_VT52 = 2¶

DEC_VT100 = 3¶

DEC_VT220 = 4¶

HP_700_94 = 5¶

IBM_3130 = 6¶

class bac_py.types.enums.NodeType(*values)[source]¶

Bases: IntEnum

BACnet node type for Structured View (Clause 12.29).

UNKNOWN = 0¶

SYSTEM = 1¶

NETWORK = 2¶

DEVICE = 3¶

ORGANIZATIONAL = 4¶

AREA = 5¶

EQUIPMENT = 6¶

POINT = 7¶

COLLECTION = 8¶

PROPERTY = 9¶

FUNCTIONAL = 10¶

OTHER = 11¶

SUBSYSTEM = 12¶

BUILDING = 13¶

FLOOR = 14¶

SECTION = 15¶

MODULE = 16¶

TREE = 17¶

MEMBER = 18¶

PROTOCOL = 19¶

ROOM = 20¶

ZONE = 21¶

class bac_py.types.enums.ShedState(*values)[source]¶

Bases: IntEnum

BACnet shed state for Load Control (Clause 12.28).

SHED_INACTIVE = 0¶

SHED_REQUEST_PENDING = 1¶

SHED_COMPLIANT = 2¶

SHED_NON_COMPLIANT = 3¶

class bac_py.types.enums.DoorAlarmState(*values)[source]¶

Bases: IntEnum

BACnet door alarm state (Clause 12.26).

NORMAL = 0¶

ALARM = 1¶

DOOR_OPEN_TOO_LONG = 2¶

FORCED_OPEN = 3¶

TAMPER = 4¶

DOOR_FAULT = 5¶

LOCK_FAULT = 6¶

FREE_ACCESS = 7¶

EGRESS_OPEN = 8¶

class bac_py.types.enums.DoorStatus(*values)[source]¶

Bases: IntEnum

BACnet door status (Clause 12.26).

CLOSED = 0¶

OPENED = 1¶

UNKNOWN = 2¶

class bac_py.types.enums.LockStatus(*values)[source]¶

Bases: IntEnum

BACnet lock status (Clause 12.26).

LOCKED = 0¶

UNLOCKED = 1¶

LOCK_FAULT = 2¶

UNUSED = 3¶

UNKNOWN = 4¶

class bac_py.types.enums.DoorSecuredStatus(*values)[source]¶

Bases: IntEnum

BACnet secured status for Access Door (Clause 12.26).

SECURED = 0¶

UNSECURED = 1¶

UNKNOWN = 2¶

class bac_py.types.enums.LightingOperation(*values)[source]¶

Bases: IntEnum

BACnet lighting operation (Clause 12.54).

NONE = 0¶

FADE_TO = 1¶

RAMP_TO = 2¶

STEP_UP = 3¶

STEP_DOWN = 4¶

STEP_ON = 5¶

STEP_OFF = 6¶

WARN = 7¶

WARN_OFF = 8¶

WARN_RELINQUISH = 9¶

STOP = 10¶

class bac_py.types.enums.LightingInProgress(*values)[source]¶

Bases: IntEnum

BACnet lighting in-progress state (Clause 12.54).

IDLE = 0¶

FADE_ACTIVE = 1¶

RAMP_ACTIVE = 2¶

NOT_CONTROLLED = 3¶

OTHER = 4¶

class bac_py.types.enums.AccessEvent(*values)[source]¶

Bases: IntEnum

BACnet access event (Clause 12.33).

Values 0-127 are granted events; 128-511 are denied events. Values 0-511 reserved for ASHRAE; 512-65535 for vendor use (Clause 23).

NONE = 0¶

GRANTED = 1¶

MUSTER = 2¶

PASSBACK_DETECTED = 3¶

DURESS = 4¶

TRACE = 5¶

LOCKOUT_MAX_ATTEMPTS = 6¶

LOCKOUT_OTHER = 7¶

LOCKOUT_RELINQUISHED = 8¶

LOCKED_BY_HIGHER_PRIORITY = 9¶

OUT_OF_SERVICE = 10¶

OUT_OF_SERVICE_RELINQUISHED = 11¶

ACCOMPANIMENT_BY = 12¶

AUTHENTICATION_FACTOR_READ = 13¶

AUTHORIZATION_DELAYED = 14¶

VERIFICATION_REQUIRED = 15¶

NO_ENTRY_AFTER_GRANTED = 16¶

DENIED_DENY_ALL = 128¶

DENIED_UNKNOWN_CREDENTIAL = 129¶

DENIED_AUTHENTICATION_UNAVAILABLE = 130¶

DENIED_AUTHENTICATION_FACTOR_TIMEOUT = 131¶

DENIED_INCORRECT_AUTHENTICATION_FACTOR = 132¶

DENIED_ZONE_NO_ACCESS_RIGHTS = 133¶

DENIED_POINT_NO_ACCESS_RIGHTS = 134¶

DENIED_NO_ACCESS_RIGHTS = 135¶

DENIED_OUT_OF_TIME_RANGE = 136¶

DENIED_THREAT_LEVEL = 137¶

DENIED_PASSBACK = 138¶

DENIED_UNEXPECTED_LOCATION_USAGE = 139¶

DENIED_MAX_ATTEMPTS = 140¶

DENIED_LOWER_OCCUPANCY_LIMIT = 141¶

DENIED_UPPER_OCCUPANCY_LIMIT = 142¶

DENIED_AUTHENTICATION_FACTOR_LOST = 143¶

DENIED_AUTHENTICATION_FACTOR_STOLEN = 144¶

DENIED_AUTHENTICATION_FACTOR_DAMAGED = 145¶

DENIED_AUTHENTICATION_FACTOR_DESTROYED = 146¶

DENIED_AUTHENTICATION_FACTOR_DISABLED = 147¶

DENIED_AUTHENTICATION_FACTOR_ERROR = 148¶

DENIED_CREDENTIAL_UNASSIGNED = 149¶

DENIED_CREDENTIAL_NOT_PROVISIONED = 150¶

DENIED_CREDENTIAL_NOT_YET_ACTIVE = 151¶

DENIED_CREDENTIAL_EXPIRED = 152¶

DENIED_CREDENTIAL_MANUAL_DISABLE = 153¶

DENIED_CREDENTIAL_LOCKOUT = 154¶

DENIED_CREDENTIAL_MAX_DAYS = 155¶

DENIED_CREDENTIAL_MAX_USES = 156¶

DENIED_CREDENTIAL_INACTIVITY = 157¶

DENIED_CREDENTIAL_DISABLED = 158¶

DENIED_NO_ACCOMPANIMENT = 159¶

DENIED_INCORRECT_ACCOMPANIMENT = 160¶

DENIED_LOCKOUT = 161¶

DENIED_VERIFICATION_FAILED = 162¶

DENIED_VERIFICATION_TIMEOUT = 163¶

DENIED_OTHER = 164¶

class bac_py.types.enums.AccessCredentialDisable(*values)[source]¶

Bases: IntEnum

BACnet access credential disable (Clause 21).

Values 0-63 reserved for ASHRAE; 64-65535 for vendor use (Clause 23).

NONE = 0¶

DISABLE = 1¶

DISABLE_MANUAL = 2¶

DISABLE_LOCKOUT = 3¶

class bac_py.types.enums.AccessCredentialDisableReason(*values)[source]¶

Bases: IntEnum

BACnet access credential disable reason (Clause 21).

Values 0-63 reserved for ASHRAE; 64-65535 for vendor use (Clause 23).

DISABLED = 0¶

DISABLED_NEEDS_PROVISIONING = 1¶

DISABLED_UNASSIGNED = 2¶

DISABLED_NOT_YET_ACTIVE = 3¶

DISABLED_EXPIRED = 4¶

DISABLED_LOCKOUT = 5¶

DISABLED_MAX_DAYS = 6¶

DISABLED_MAX_USES = 7¶

DISABLED_INACTIVITY = 8¶

DISABLED_MANUAL = 9¶

class bac_py.types.enums.AccessUserType(*values)[source]¶

Bases: IntEnum

BACnet access user type (Clause 12.35).

ASSET = 0¶

GROUP = 1¶

PERSON = 2¶

class bac_py.types.enums.AuthorizationMode(*values)[source]¶

Bases: IntEnum

BACnet authorization mode (Clause 12.31).

AUTHORIZE = 0¶

GRANT_ACTIVE = 1¶

DENY_ALL = 2¶

VERIFICATION_REQUIRED = 3¶

AUTHORIZATION_DELAYED = 4¶

NONE = 5¶

class bac_py.types.enums.AccessPassbackMode(*values)[source]¶

Bases: IntEnum

BACnet access passback mode (Clause 12.32).

PASSBACK_OFF = 0¶

HARD_PASSBACK = 1¶

SOFT_PASSBACK = 2¶

class bac_py.types.enums.EscalatorMode(*values)[source]¶

Bases: IntEnum

BACnet escalator operating mode (Clause 12.60).

UNKNOWN = 0¶

STOP = 1¶

UP = 2¶

DOWN = 3¶

INSPECTION = 4¶

OUT_OF_SERVICE = 5¶

class bac_py.types.enums.EscalatorFault(*values)[source]¶

Bases: IntEnum

BACnet escalator fault signals (Clause 12.60).

CONTROLLER_FAULT = 0¶

DRIVE_AND_MOTOR_FAULT = 1¶

MECHANICAL_COMPONENT_FAULT = 2¶

OVERSPEED_FAULT = 3¶

POWER_SUPPLY_FAULT = 4¶

SAFETY_DEVICE_FAULT = 5¶

CONTROLLER_SUPPLY_FAULT = 6¶

DRIVE_TEMPERATURE_EXCEEDED = 7¶

COMB_PLATE_FAULT = 8¶

class bac_py.types.enums.LiftCarDirection(*values)[source]¶

Bases: IntEnum

BACnet lift car travel direction (Clause 12.59).

UNKNOWN = 0¶

NONE = 1¶

STOPPED = 2¶

UP = 3¶

DOWN = 4¶

UP_AND_DOWN = 5¶

class bac_py.types.enums.LiftGroupMode(*values)[source]¶

Bases: IntEnum

BACnet lift group operating mode (Clause 12.58).

UNKNOWN = 0¶

NORMAL = 1¶

DOWN_PEAK = 2¶

TWO_WAY = 3¶

FOUR_WAY = 4¶

EMERGENCY = 5¶

UP_PEAK = 6¶

class bac_py.types.enums.LiftCarDoorStatus(*values)[source]¶

Bases: IntEnum

BACnet lift car door status (Clause 12.59).

UNKNOWN = 0¶

NONE = 1¶

CLOSING = 2¶

CLOSED = 3¶

OPENING = 4¶

OPENED = 5¶

SAFETY_LOCKED = 6¶

LIMITED_OPENED = 7¶

class bac_py.types.enums.LiftCarDoorCommand(*values)[source]¶

Bases: IntEnum

BACnet lift car door command (Clause 21).

NONE = 0¶

OPEN = 1¶

CLOSE = 2¶

class bac_py.types.enums.LiftCarDriveStatus(*values)[source]¶

Bases: IntEnum

BACnet lift car drive status (Clause 21).

UNKNOWN = 0¶

STATIONARY = 1¶

BRAKING = 2¶

ACCELERATE = 3¶

DECELERATE = 4¶

RATED_SPEED = 5¶

SINGLE_FLOOR_JUMP = 6¶

TWO_FLOOR_JUMP = 7¶

THREE_FLOOR_JUMP = 8¶

MULTI_FLOOR_JUMP = 9¶

class bac_py.types.enums.LiftCarMode(*values)[source]¶

Bases: IntEnum

BACnet lift car operating mode (Clause 21).

Values 0-1023 reserved for ASHRAE; 1024-65535 for vendor use (Clause 23).

UNKNOWN = 0¶

NORMAL = 1¶

VIP = 2¶

HOMING = 3¶

PARKING = 4¶

ATTENDANT_CONTROL = 5¶

FIREFIGHTER_CONTROL = 6¶

EMERGENCY_POWER = 7¶

INSPECTION = 8¶

CABINET_RECALL = 9¶

EARTHQUAKE_OPERATION = 10¶

FIRE_OPERATION = 11¶

OUT_OF_SERVICE = 12¶

OCCUPANT_EVACUATION = 13¶

class bac_py.types.enums.LiftFault(*values)[source]¶

Bases: IntEnum

BACnet lift fault signals (Clause 21).

Values 0-1023 reserved for ASHRAE; 1024-65535 for vendor use (Clause 23).

CONTROLLER_FAULT = 0¶

DRIVE_AND_MOTOR_FAULT = 1¶

GOVERNOR_AND_SAFETY_GEAR_FAULT = 2¶

LIFT_SHAFT_DEVICE_FAULT = 3¶

POWER_SUPPLY_FAULT = 4¶

SAFETY_INTERLOCK_FAULT = 5¶

DOOR_CLOSING_FAULT = 6¶

DOOR_OPENING_FAULT = 7¶

CAR_STOPPED_OUTSIDE_LANDING_ZONE = 8¶

CALL_BUTTON_STUCK = 9¶

START_FAILURE = 10¶

CONTROLLER_SUPPLY_FAULT = 11¶

SELF_TEST_FAILURE = 12¶

RUNTIME_LIMIT_EXCEEDED = 13¶

POSITION_LOST = 14¶

DRIVE_TEMPERATURE_EXCEEDED = 15¶

LOAD_MEASUREMENT_FAULT = 16¶

class bac_py.types.enums.StagingState(*values)[source]¶

Bases: IntEnum

BACnet staging state (Clause 12.62, new in 2020).

NOT_STAGED = 0¶

STAGING = 1¶

STAGED = 2¶

COMMITTING = 3¶

COMMITTED = 4¶

ABANDONING = 5¶

ABANDONED = 6¶

class bac_py.types.enums.AuditLevel(*values)[source]¶

Bases: IntEnum

BACnet audit level (Clause 19.6, new in 2020).

NONE = 0¶

AUDIT_ALL = 1¶

AUDIT_CONFIG = 2¶

DEFAULT = 3¶

class bac_py.types.enums.AuditOperation(*values)[source]¶

Bases: IntEnum

BACnet audit operation (Clause 19.6, new in 2020).

READ = 0¶

WRITE = 1¶

CREATE = 2¶

DELETE = 3¶

LIFE_SAFETY = 4¶

ACKNOWLEDGE_ALARM = 5¶

DEVICE_DISABLE_COMM = 6¶

DEVICE_ENABLE_COMM = 7¶

DEVICE_RESET = 8¶

DEVICE_BACKUP = 9¶

DEVICE_RESTORE = 10¶

SUBSCRIPTION = 11¶

NOTIFICATION = 12¶

AUDITING_FAILURE = 13¶

NETWORK_CHANGES = 14¶

GENERAL = 15¶

class bac_py.types.enums.BACnetSuccessFilter(*values)[source]¶

Bases: IntEnum

BACnet success filter for audit log queries (Clause 13.19, new in 2020).

ALL = 0¶

SUCCESSES_ONLY = 1¶

FAILURES_ONLY = 2¶

Primitives¶

BACnet primitive data types per ASHRAE 135-2016 Clause 20.2.

class bac_py.types.primitives.ObjectIdentifier(object_type, instance_number)[source]¶

Bases: object

BACnet Object Identifier – 10-bit type, 22-bit instance (Clause 20.2.14).

Uniquely identifies a BACnet object within a device by combining an ObjectType with an instance number.

Parameters:

object_type (ObjectType)
instance_number (int)

object_type: ObjectType¶: The object type (10-bit, 0–1023).

instance_number: int¶: The instance number (22-bit, 0–4194303).

encode()[source]¶

Encode to the 4-byte BACnet wire format.

The 32-bit value is composed as (object_type << 22) | instance_number, encoded big-endian.

Return type:: bytes
Returns:: 4-byte encoded object identifier.

classmethod decode(data)[source]¶

Decode from the 4-byte BACnet wire format.

Parameters:: data (bytes | memoryview) – At least 4 bytes of wire data.
Return type:: ObjectIdentifier
Returns:: Decoded ObjectIdentifier instance.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "object_type" (hyphenated name) and "instance" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "object_type" and "instance" keys.
Return type:: ObjectIdentifier
Returns:: Decoded ObjectIdentifier instance.
Raises:: TypeError – If the resolved type is not an ObjectType.

class bac_py.types.primitives.BACnetDate(year, month, day, day_of_week)[source]¶

Bases: object

BACnet Date – year, month, day, day_of_week (Clause 20.2.12).

0xFF indicates an unspecified (wildcard) field. Year is stored as the actual year (e.g. 2024), but encoded on the wire as year - 1900.

Parameters:

year (int)
month (int)
day (int)
day_of_week (int)

year: int¶: Calendar year (e.g. 2024), or 0xFF for unspecified.

month: int¶: Month (1–12), or 0xFF for unspecified.

day: int¶: Day of month (1–31), or 0xFF for unspecified.

day_of_week: int¶: Day of week (1 = Monday … 7 = Sunday), or 0xFF for unspecified.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Wildcard values (0xFF) are represented as None.

Return type:: dict[str, Any]
Returns:: Dictionary mapping field names to values or None.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

None values are converted back to 0xFF wildcards.

Parameters:: data (dict[str, Any]) – Dictionary with "year", "month", "day", and "day_of_week" keys.
Return type:: BACnetDate
Returns:: Decoded BACnetDate instance.

class bac_py.types.primitives.BACnetTime(hour, minute, second, hundredth)[source]¶

Bases: object

BACnet Time – hour, minute, second, hundredth (Clause 20.2.13).

0xFF indicates an unspecified (wildcard) field.

Parameters:

hour (int)
minute (int)
second (int)
hundredth (int)

hour: int¶: Hour (0–23), or 0xFF for unspecified.

minute: int¶: Minute (0–59), or 0xFF for unspecified.

second: int¶: Second (0–59), or 0xFF for unspecified.

hundredth: int¶: Hundredths of a second (0–99), or 0xFF for unspecified.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Wildcard values (0xFF) are represented as None.

Return type:: dict[str, Any]
Returns:: Dictionary mapping field names to values or None.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

None values are converted back to 0xFF wildcards.

Parameters:: data (dict[str, Any]) – Dictionary with "hour", "minute", "second", and "hundredth" keys.
Return type:: BACnetTime
Returns:: Decoded BACnetTime instance.

class bac_py.types.primitives.BACnetDouble(x=0, /)[source]¶

Bases: float

Sentinel type to distinguish Double (64-bit) from Real (32-bit) encoding.

BACnet properties like LargeAnalogValue Present_Value are specified as Double (IEEE-754 64-bit, Application tag 5) per Clause 12.42. Since Python float is always 64-bit internally, this subclass serves as a marker so encode_property_value can emit the correct wire tag.

class bac_py.types.primitives.BitString(value, unused_bits=0)[source]¶

Bases: object

BACnet Bit String with named-bit support (Clause 20.2.10).

Stores raw bit data as bytes with an unused-bits count for the trailing byte. Provides indexed access to individual bits using MSB-first ordering within each byte.

Parameters:

value (bytes)
unused_bits (int)

property data: bytes¶: Raw byte data backing this bit string.

property unused_bits: int¶: Number of unused trailing bits in the last byte (0–7).

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "bits" (list of booleans) and "unused_bits" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "bits" (list of booleans) and optionally "unused_bits" keys.
Return type:: BitString
Returns:: Decoded BitString instance.

Constructed Types¶

BACnet constructed data types per ASHRAE 135-2020.

class bac_py.types.constructed.StatusFlags(in_alarm=False, fault=False, overridden=False, out_of_service=False)[source]¶

Bases: object

BACnet StatusFlags bit string (Clause 12.50, BACnetStatusFlags).

Four Boolean flags indicating the health of an object. Maps to a 4-bit BACnet BitString where bit 0 is IN_ALARM, bit 1 is FAULT, bit 2 is OVERRIDDEN, and bit 3 is OUT_OF_SERVICE.

Parameters:

in_alarm (bool)
fault (bool)
overridden (bool)
out_of_service (bool)

in_alarm: bool¶: True when the object is in an alarm state.

fault: bool¶: True when the object has a fault condition.

overridden: bool¶: True when the object value has been overridden.

out_of_service: bool¶: True when the object is out of service.

to_bit_string()[source]¶

Encode as a BACnet BitString with 4 significant bits.

Return type:: BitString
Returns:: A BitString representing the four status flags.

classmethod from_bit_string(bs)[source]¶

Decode from a BACnet BitString.

Parameters:: bs (BitString) – A BitString containing at least 4 significant bits.
Return type:: StatusFlags
Returns:: Decoded StatusFlags instance.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, bool]
Returns:: Dictionary mapping flag names to boolean values.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with boolean values keyed by flag name.
Return type:: StatusFlags
Returns:: Decoded StatusFlags instance.

class bac_py.types.constructed.BACnetDateTime(date, time)[source]¶

Bases: object

BACnet DateTime – SEQUENCE { date Date, time Time } (Clause 21).

Used by Schedule (Effective_Period), File (Modification_Date), TrendLog (Start_Time, Stop_Time), and Event Enrollment (Event_Time_Stamps).

Parameters:

date (BACnetDate)
time (BACnetTime)

date: BACnetDate¶: The date component.

time: BACnetTime¶: The time component.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "date" and "time" keys.

encode()[source]¶

Encode as application-tagged Date followed by Time.

Return type:: bytes
Returns:: Encoded bytes.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing "date" and "time" keys.
Return type:: BACnetDateTime
Returns:: Decoded BACnetDateTime instance.

class bac_py.types.constructed.BACnetTimeStamp(choice, value)[source]¶

Bases: object

BACnet TimeStamp – CHOICE { time [0], sequenceNumber [1], dateTime [2] } (Clause 21).

Used by event notifications (Clause 13.8), alarm acknowledgment (Clause 13.5), and COV services for timestamping events.

Parameters:

choice (int)
value (BACnetTime | int | BACnetDateTime)

choice: int¶: Discriminator: 0 = time, 1 = sequenceNumber, 2 = dateTime.

value: BACnetTime | int | BACnetDateTime¶: The typed value corresponding to the choice discriminator.

encode()[source]¶

Encode to context-tagged BACnet wire format.

Return type:: bytes
Returns:: Context-tagged encoded bytes.
Raises:: ValueError – If choice is not 0, 1, or 2.

classmethod decode(data, offset=0)[source]¶

Decode from context-tagged BACnet wire format.

Parameters:

data (memoryview | bytes) – Buffer to decode from.
offset (int (default: 0)) – Starting byte offset.

Return type:

tuple[BACnetTimeStamp, int]

Returns:

Tuple of (decoded BACnetTimeStamp, new offset).

Raises:

ValueError – If the context tag is not 0, 1, or 2.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "choice" and "value" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing "choice" and "value" keys.
Return type:: BACnetTimeStamp
Returns:: Decoded BACnetTimeStamp instance.
Raises:: ValueError – If the choice value is not recognized.

class bac_py.types.constructed.BACnetDateRange(start_date, end_date)[source]¶

Bases: object

BACnet DateRange – SEQUENCE { start_date Date, end_date Date } (Clause 21).

Used by Schedule (Effective_Period) and Calendar (Date_List entries).

Parameters:

start_date (BACnetDate)
end_date (BACnetDate)

start_date: BACnetDate¶: Inclusive start of the date range.

end_date: BACnetDate¶: Inclusive end of the date range.

encode()[source]¶

Encode as two application-tagged Dates.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "start_date" and "end_date" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing "start_date" and "end_date" keys.
Return type:: BACnetDateRange
Returns:: Decoded BACnetDateRange instance.

class bac_py.types.constructed.BACnetWeekNDay(month, week_of_month, day_of_week)[source]¶

Bases: object

BACnet WeekNDay – OCTET STRING (SIZE 3) (Clause 21).

Encodes a recurring date pattern by month, week-of-month, and day-of-week. Used by Calendar (Date_List entries for week-n-day patterns).

Parameters:

month (int)
week_of_month (int)
day_of_week (int)

month: int¶: Month selector: 1–14 or 0xFF (any month). 13 = odd months, 14 = even months.

week_of_month: int¶: Week selector: 1–5 (specific week), 6 = last week, 0xFF = any week.

day_of_week: int¶: Day selector: 1–7 (Monday–Sunday), 0xFF = any day.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Wildcard values (0xFF) are represented as None.

Return type:: dict[str, int | None]
Returns:: Dictionary mapping field names to integer values or None.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

None values are converted back to 0xFF wildcards.

Parameters:: data (dict[str, Any]) – Dictionary with "month", "week_of_month", and "day_of_week" keys.
Return type:: BACnetWeekNDay
Returns:: Decoded BACnetWeekNDay instance.

class bac_py.types.constructed.BACnetCalendarEntry(choice, value)[source]¶

Bases: object

BACnet CalendarEntry – CHOICE { date [0], dateRange [1], weekNDay [2] } (Clause 21).

Used by Calendar.Date_List and Schedule.Exception_Schedule.

Parameters:

choice (int)
value (BACnetDate | BACnetDateRange | BACnetWeekNDay)

choice: int¶: Discriminator: 0 = date, 1 = dateRange, 2 = weekNDay.

value: BACnetDate | BACnetDateRange | BACnetWeekNDay¶: The typed value corresponding to the choice discriminator.

encode()[source]¶

Encode as context-tagged CHOICE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "choice" and "value" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing "choice" and "value" keys.
Return type:: BACnetCalendarEntry
Returns:: Decoded BACnetCalendarEntry instance.
Raises:: ValueError – If the choice value is not 0, 1, or 2.

class bac_py.types.constructed.BACnetTimeValue(time, value)[source]¶

Bases: object

BACnet TimeValue – SEQUENCE { time Time, value ABSTRACT-SYNTAX.&Type } (Clause 21).

Used by Schedule.Weekly_Schedule as lists of time-value pairs defining the schedule for each day of the week.

Parameters:

time (BACnetTime)
value (Any)

time: BACnetTime¶: The time at which this value takes effect.

value: Any¶: The primitive application-tagged value (any type).

encode(*, int_as_real=False)[source]¶

Encode as application-tagged Time followed by value.

Parameters:: int_as_real (bool (default: False)) – If True, encode int values as Real.
Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "time" and "value" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing "time" and "value" keys.
Return type:: BACnetTimeValue
Returns:: Decoded BACnetTimeValue instance.

class bac_py.types.constructed.BACnetSpecialEvent(period, list_of_time_values, event_priority)[source]¶

Bases: object

BACnet SpecialEvent – SEQUENCE (Clause 21).

Used by Schedule.Exception_Schedule to define exception periods that override the normal weekly schedule.

Parameters:

period (BACnetCalendarEntry | ObjectIdentifier)
list_of_time_values (tuple[BACnetTimeValue, ...])
event_priority (int)

period: BACnetCalendarEntry | ObjectIdentifier¶: Calendar entry defining when this event applies, or an ObjectIdentifier referencing a Calendar object.

list_of_time_values: tuple[BACnetTimeValue, ...]¶: Time-value pairs active during this event period.

event_priority: int¶: Priority level (1–16) for schedule resolution. Lower values take precedence.

encode(*, int_as_real=False)[source]¶

Encode as context-tagged SEQUENCE per Clause 21.

Parameters:: int_as_real (bool (default: False)) – If True, encode int time-values as Real.
Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "period", "period_type", "list_of_time_values", and "event_priority" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing event fields.
Return type:: BACnetSpecialEvent
Returns:: Decoded BACnetSpecialEvent instance.

class bac_py.types.constructed.BACnetDeviceObjectPropertyReference(object_identifier, property_identifier, property_array_index=None, device_identifier=None)[source]¶

Bases: object

BACnet DeviceObjectPropertyReference – SEQUENCE (Clause 21).

A reference to a property on a specific object, optionally on a remote device. Used by TrendLog.Log_Device_Object_Property, Loop references, EventEnrollment.Object_Property_Reference, and Schedule references.

Parameters:

object_identifier (ObjectIdentifier)
property_identifier (int)
property_array_index (int | None)
device_identifier (ObjectIdentifier | None)

object_identifier: ObjectIdentifier¶: The referenced object.

property_identifier: int¶: The referenced property (as int, maps to PropertyIdentifier).

property_array_index: int | None¶: Optional array index within the property.

device_identifier: ObjectIdentifier | None¶: Optional device containing the referenced object. None means the local device.

encode()[source]¶

Encode as context-tagged SEQUENCE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

classmethod decode(data, offset=0)[source]¶

Decode from wire bytes.

Parameters:

data (memoryview | bytes) – Buffer to decode from.
offset (int (default: 0)) – Starting position in data.

Return type:

tuple[BACnetDeviceObjectPropertyReference, int]

Returns:

Tuple of decoded reference and new offset.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Optional fields are omitted from the output when None.

Return type:: dict[str, Any]
Returns:: Dictionary with reference fields.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing reference fields.
Return type:: BACnetDeviceObjectPropertyReference
Returns:: Decoded BACnetDeviceObjectPropertyReference instance.

class bac_py.types.constructed.BACnetObjectPropertyReference(object_identifier, property_identifier, property_array_index=None)[source]¶

Bases: object

BACnet ObjectPropertyReference – SEQUENCE (Clause 21).

Like BACnetDeviceObjectPropertyReference but without a device identifier (always references the local device). Used by Loop references (Controlled_Variable, Manipulated_Variable, Setpoint_Reference).

Parameters:

object_identifier (ObjectIdentifier)
property_identifier (int)
property_array_index (int | None)

object_identifier: ObjectIdentifier¶: The referenced object.

property_identifier: int¶: The referenced property (as int, maps to PropertyIdentifier).

property_array_index: int | None¶: Optional array index within the property.

encode()[source]¶

Encode as context-tagged SEQUENCE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with reference fields.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing reference fields.
Return type:: BACnetObjectPropertyReference
Returns:: Decoded BACnetObjectPropertyReference instance.

class bac_py.types.constructed.BACnetAddress(network_number, mac_address)[source]¶

Bases: object

BACnet network address for recipient routing (Clause 21).

Represents a network-layer address used in notification recipient and destination structures. Distinct from BACnetAddress which is the transport-layer address used for packet routing.

Parameters:

network_number (int)
mac_address (bytes)

network_number: int¶: DNET value: 0 = local network, 0xFFFF = broadcast.

mac_address: bytes¶: MAC-layer address bytes.

encode()[source]¶

Encode as context-tagged SEQUENCE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "network_number" and "mac_address" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "network_number" and "mac_address" keys.
Return type:: BACnetAddress
Returns:: Decoded BACnetAddress instance.

class bac_py.types.constructed.BACnetRecipient(device=None, address=None)[source]¶

Bases: object

BACnet Recipient – CHOICE { device [0], address [1] } (Clause 21).

Used by BACnetDestination in NotificationClass.Recipient_List. Exactly one of device or address should be set.

Parameters:

device (ObjectIdentifier | None)
address (BACnetAddress | None)

device: ObjectIdentifier | None¶: Target device object identifier, or None if using address.

address: BACnetAddress | None¶: Target network address, or None if using device.

encode()[source]¶

Encode as context-tagged CHOICE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with a "type" discriminator and the corresponding value.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "type" discriminator.
Return type:: BACnetRecipient
Returns:: Decoded BACnetRecipient instance.

class bac_py.types.constructed.BACnetDestination(valid_days, from_time, to_time, recipient, process_identifier, issue_confirmed_notifications, transitions)[source]¶

Bases: object

BACnet Destination – notification routing entry (Clause 21).

Used by NotificationClass.Recipient_List to define where and when event notifications should be sent.

Parameters:

valid_days (BitString)
from_time (BACnetTime)
to_time (BACnetTime)
recipient (BACnetRecipient)
process_identifier (int)
issue_confirmed_notifications (bool)
transitions (BitString)

valid_days: BitString¶: 7-bit BitString indicating valid days (Monday through Sunday).

from_time: BACnetTime¶: Start of the valid time window.

to_time: BACnetTime¶: End of the valid time window.

recipient: BACnetRecipient¶: Target device or address for notifications.

process_identifier: int¶: Process identifier on the recipient to notify.

issue_confirmed_notifications: bool¶: True for confirmed notifications, False for unconfirmed.

transitions: BitString¶: 3-bit BitString for event transitions: to-offnormal, to-fault, to-normal.

encode()[source]¶

Encode as application-tagged SEQUENCE per Clause 21.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with all destination fields.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing all destination fields.
Return type:: BACnetDestination
Returns:: Decoded BACnetDestination instance.

class bac_py.types.constructed.BACnetScale(float_scale=None, integer_scale=None)[source]¶

Bases: object

BACnet Scale – CHOICE { float_scale [0], integer_scale [1] } (Clause 12.1).

Used by Accumulator.Scale. Exactly one of float_scale or integer_scale should be set.

Parameters:

float_scale (float | None)
integer_scale (int | None)

float_scale: float | None¶: Floating-point scale factor, or None if using integer_scale.

integer_scale: int | None¶: Integer scale factor, or None if using float_scale.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "type" and "value" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "type" and "value" keys.
Return type:: BACnetScale
Returns:: Decoded BACnetScale instance.

class bac_py.types.constructed.BACnetPrescale(multiplier, modulo_divide)[source]¶

Bases: object

BACnet Prescale – SEQUENCE { multiplier Unsigned, modulo_divide Unsigned } (Clause 12.1).

Used by Accumulator.Prescale to define pulse prescaling parameters.

Parameters:

multiplier (int)
modulo_divide (int)

multiplier: int¶: Prescale multiplier value.

modulo_divide: int¶: Prescale modulo-divide value.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, int]
Returns:: Dictionary with "multiplier" and "modulo_divide" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "multiplier" and "modulo_divide" keys.
Return type:: BACnetPrescale
Returns:: Decoded BACnetPrescale instance.

class bac_py.types.constructed.BACnetLogRecord(timestamp, log_datum, status_flags=None)[source]¶

Bases: object

BACnet LogRecord for TrendLog.Log_Buffer (Clause 12.25).

Represents a single timestamped entry in a trend log buffer.

Parameters:

timestamp (BACnetDateTime)
log_datum (Any)
status_flags (StatusFlags | None)

timestamp: BACnetDateTime¶: When the value was logged.

log_datum: Any¶: The logged value. Type varies depending on the monitored property.

status_flags: StatusFlags | None¶: Optional status flags at the time of logging.

encode(*, int_as_real=False)[source]¶

Encode as application-tagged SEQUENCE per Clause 12.25.

Parameters:: int_as_real (bool (default: False)) – If True, encode int log_datum as Real.
Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "timestamp", "log_datum", and optionally "status_flags" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing log record fields.
Return type:: BACnetLogRecord
Returns:: Decoded BACnetLogRecord instance.

class bac_py.types.constructed.BACnetRecipientProcess(recipient, process_identifier)[source]¶

Bases: object

BACnet RecipientProcess – identifies a subscriber process (Clause 12.11.39).

Pairs a BACnetRecipient with a process identifier to uniquely identify a COV subscription endpoint.

Parameters:

recipient (BACnetRecipient)
process_identifier (int)

recipient: BACnetRecipient¶: The subscribing device or address.

process_identifier: int¶: The subscriber’s process ID.

encode()[source]¶

Encode as context-tagged SEQUENCE per Clause 12.11.39.

Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "recipient" and "process_identifier" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "recipient" and "process_identifier" keys.
Return type:: BACnetRecipientProcess
Returns:: Decoded BACnetRecipientProcess instance.

class bac_py.types.constructed.BACnetCOVSubscription(recipient, monitored_object, issue_confirmed_notifications, time_remaining, cov_increment=None)[source]¶

Bases: object

BACnet COVSubscription – read-only diagnostic entry (Clause 12.11.39).

Used by Device.Active_COV_Subscriptions to expose active subscriptions as a read-only list.

Parameters:

recipient (BACnetRecipientProcess)
monitored_object (ObjectIdentifier)
issue_confirmed_notifications (bool)
time_remaining (int)
cov_increment (float | None)

recipient: BACnetRecipientProcess¶: The subscriber process.

monitored_object: ObjectIdentifier¶: The object being monitored for changes.

issue_confirmed_notifications: bool¶: True for confirmed COV notifications.

time_remaining: int¶: Seconds until this subscription expires.

cov_increment: float | None¶: Optional COV increment threshold. None when not applicable.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with subscription fields.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing subscription fields.
Return type:: BACnetCOVSubscription
Returns:: Decoded BACnetCOVSubscription instance.

class bac_py.types.constructed.BACnetPriorityValue(value=None)[source]¶

Bases: object

BACnet PriorityValue – a single entry in a Priority_Array (Clause 19).

Each slot holds either a commanded value or None (relinquished / Null).

Parameters:: value (Any)

value: Any¶: The commanded value, or None if relinquished.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with a "value" key.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with a "value" key.
Return type:: BACnetPriorityValue
Returns:: Decoded BACnetPriorityValue instance.

class bac_py.types.constructed.BACnetPriorityArray(slots=<factory>)[source]¶

Bases: object

BACnet Priority_Array – ARRAY[16] OF BACnetPriorityValue (Clause 19).

Provides indexed access to the 16-level command priority array used by commandable objects (Analog Output, Binary Output, etc.).

Parameters:: slots (tuple[BACnetPriorityValue, ...])

slots: tuple[BACnetPriorityValue, ...]¶: Tuple of exactly 16 BACnetPriorityValue entries.

encode(*, int_as_real=False)[source]¶

Encode the 16-element priority array as application-tagged values.

Parameters:: int_as_real (bool (default: False)) – If True, encode int values as Real.
Return type:: bytes
Returns:: Encoded bytes.

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with a "slots" key containing a list of 16 priority value dictionaries.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with a "slots" key containing exactly 16 priority value entries.
Return type:: BACnetPriorityArray
Returns:: Decoded BACnetPriorityArray instance.
Raises:: ValueError – If the "slots" list does not contain exactly 16 entries.

class bac_py.types.constructed.BACnetLightingCommand(operation, target_level=None, ramp_rate=None, step_increment=None, fade_time=None, priority=None)[source]¶

Bases: object

BACnet lighting command (Clause 12.54).

Used to control lighting output objects with fade/ramp/step operations.

Parameters:

operation (LightingOperation)
target_level (float | None)
ramp_rate (float | None)
step_increment (float | None)
fade_time (int | None)
priority (int | None)

operation: LightingOperation¶: The lighting operation to perform.

target_level: float | None¶: Target lighting level (0.0–100.0 percent).

ramp_rate: float | None¶: Ramp rate in percent per second.

step_increment: float | None¶: Step increment in percent.

fade_time: int | None¶: Fade time in milliseconds.

priority: int | None¶: Priority for the lighting command (1–16).

class bac_py.types.constructed.BACnetShedLevel(percent=None, level=None, amount=None)[source]¶

Bases: object

BACnet shed level CHOICE type for Load Control (Clause 12.28).

Exactly one of percent, level, or amount must be set.

Parameters:

percent (int | None)
level (int | None)
amount (float | None)

percent: int | None¶: Shed as a percentage (0–100).

level: int | None¶: Shed level enumeration index.

amount: float | None¶: Shed amount in engineering units.

class bac_py.types.constructed.BACnetDeviceObjectReference(object_identifier, device_identifier=None)[source]¶

Bases: object

BACnet DeviceObjectReference (Clause 21).

SEQUENCE { deviceIdentifier [0] OPTIONAL, objectIdentifier [1] }

Parameters:

object_identifier (ObjectIdentifier)
device_identifier (ObjectIdentifier | None)

object_identifier: ObjectIdentifier¶: The referenced object.

device_identifier: ObjectIdentifier | None¶: Optional device hosting the object (None = local device).

encode()[source]¶

Encode to context-tagged wire format.

Return type:: bytes

classmethod decode(data, offset=0)[source]¶

Decode from context-tagged wire format.

Return type:

tuple[BACnetDeviceObjectReference, int]

Parameters:

data (memoryview | bytes)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "object_identifier" and optionally "device_identifier" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "object_identifier" and optionally "device_identifier" keys.
Return type:: BACnetDeviceObjectReference
Returns:: Decoded BACnetDeviceObjectReference instance.

class bac_py.types.constructed.BACnetValueSource(choice=0, value=None)[source]¶

Bases: object

BACnet ValueSource CHOICE type (Clause 19.5, new in 2020).

CHOICE { none [0] NULL, object [1] BACnetDeviceObjectReference, address [2] BACnetAddress }

Tracks the source of the last write to a commandable property.

Parameters:

choice (int)
value (None | BACnetDeviceObjectReference | bytes)

choice: int¶: Discriminator: 0 = none, 1 = object, 2 = address.

value: None | BACnetDeviceObjectReference | bytes¶: The typed value: None for choice 0, DeviceObjectReference for 1, raw address bytes for 2.

classmethod none_source()[source]¶

Create a ValueSource indicating no source.

Return type:: BACnetValueSource

classmethod from_object(ref)[source]¶

Create a ValueSource from a device/object reference.

Return type:: BACnetValueSource
Parameters:: ref (BACnetDeviceObjectReference)

classmethod from_address(address)[source]¶

Create a ValueSource from a raw BACnet address.

Return type:: BACnetValueSource
Parameters:: address (bytes)

encode()[source]¶

Encode to context-tagged wire format.

Return type:: bytes

classmethod decode(data, offset=0)[source]¶

Decode from context-tagged wire format.

Return type:

tuple[BACnetValueSource, int]

Parameters:

data (memoryview | bytes)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "choice" ("none", "object", or "address") and "value" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "choice" and "value" keys.
Return type:: BACnetValueSource
Returns:: Decoded BACnetValueSource instance.
Raises:: ValueError – If the choice value is not recognized.

Parsing¶

Flexible parsing helpers for BACnet object and property identifiers.

bac_py.types.parsing.OBJECT_TYPE_ALIASES: dict[str, ObjectType] = {'acc': ObjectType.ACCUMULATOR, 'ad': ObjectType.ACCESS_DOOR, 'ae': ObjectType.ALERT_ENROLLMENT, 'ai': ObjectType.ANALOG_INPUT, 'al': ObjectType.AUDIT_LOG, 'ao': ObjectType.ANALOG_OUTPUT, 'ap': ObjectType.ACCESS_POINT, 'ar': ObjectType.AUDIT_REPORTER, 'av': ObjectType.ANALOG_VALUE, 'avg': ObjectType.AVERAGING, 'bi': ObjectType.BINARY_INPUT, 'blo': ObjectType.BINARY_LIGHTING_OUTPUT, 'bo': ObjectType.BINARY_OUTPUT, 'bsv': ObjectType.BITSTRING_VALUE, 'bv': ObjectType.BINARY_VALUE, 'cal': ObjectType.CALENDAR, 'ch': ObjectType.CHANNEL, 'cmd': ObjectType.COMMAND, 'csv': ObjectType.CHARACTERSTRING_VALUE, 'dev': ObjectType.DEVICE, 'dtv': ObjectType.DATETIME_VALUE, 'dv': ObjectType.DATE_VALUE, 'ee': ObjectType.EVENT_ENROLLMENT, 'el': ObjectType.EVENT_LOG, 'file': ObjectType.FILE, 'gg': ObjectType.GLOBAL_GROUP, 'grp': ObjectType.GROUP, 'iv': ObjectType.INTEGER_VALUE, 'lav': ObjectType.LARGE_ANALOG_VALUE, 'lc': ObjectType.LOAD_CONTROL, 'lo': ObjectType.LIGHTING_OUTPUT, 'lp': ObjectType.LOOP, 'lsp': ObjectType.LIFE_SAFETY_POINT, 'lsz': ObjectType.LIFE_SAFETY_ZONE, 'msi': ObjectType.MULTI_STATE_INPUT, 'mso': ObjectType.MULTI_STATE_OUTPUT, 'msv': ObjectType.MULTI_STATE_VALUE, 'nc': ObjectType.NOTIFICATION_CLASS, 'nf': ObjectType.NOTIFICATION_FORWARDER, 'np': ObjectType.NETWORK_PORT, 'osv': ObjectType.OCTETSTRING_VALUE, 'pc': ObjectType.PULSE_CONVERTER, 'piv': ObjectType.POSITIVE_INTEGER_VALUE, 'prog': ObjectType.PROGRAM, 'sched': ObjectType.SCHEDULE, 'sv': ObjectType.STRUCTURED_VIEW, 'tl': ObjectType.TREND_LOG, 'tlm': ObjectType.TREND_LOG_MULTIPLE, 'tmr': ObjectType.TIMER, 'tv': ObjectType.TIME_VALUE}¶

Short aliases for commonly used object types.

Full hyphenated names (e.g. "analog-input") and underscore names (e.g. "ANALOG_INPUT") are always accepted via _resolve_object_type() without needing an alias entry here.

bac_py.types.parsing.PROPERTY_ALIASES: dict[str, PropertyIdentifier] = {'acked-transitions': PropertyIdentifier.ACKED_TRANSITIONS, 'active-text': PropertyIdentifier.ACTIVE_TEXT, 'app-version': PropertyIdentifier.APPLICATION_SOFTWARE_VERSION, 'cov-inc': PropertyIdentifier.COV_INCREMENT, 'db-revision': PropertyIdentifier.DATABASE_REVISION, 'deadband': PropertyIdentifier.DEADBAND, 'desc': PropertyIdentifier.DESCRIPTION, 'enable': PropertyIdentifier.LOG_ENABLE, 'event-enable': PropertyIdentifier.EVENT_ENABLE, 'event-state': PropertyIdentifier.EVENT_STATE, 'exception-schedule': PropertyIdentifier.EXCEPTION_SCHEDULE, 'firmware-rev': PropertyIdentifier.FIRMWARE_REVISION, 'high-limit': PropertyIdentifier.HIGH_LIMIT, 'inactive-text': PropertyIdentifier.INACTIVE_TEXT, 'limit-enable': PropertyIdentifier.LIMIT_ENABLE, 'list': PropertyIdentifier.OBJECT_LIST, 'log-buffer': PropertyIdentifier.LOG_BUFFER, 'low-limit': PropertyIdentifier.LOW_LIMIT, 'max': PropertyIdentifier.MAX_PRES_VALUE, 'max-apdu': PropertyIdentifier.MAX_APDU_LENGTH_ACCEPTED, 'min': PropertyIdentifier.MIN_PRES_VALUE, 'model-name': PropertyIdentifier.MODEL_NAME, 'name': PropertyIdentifier.OBJECT_NAME, 'notify-class': PropertyIdentifier.NOTIFICATION_CLASS, 'notify-type': PropertyIdentifier.NOTIFY_TYPE, 'num-states': PropertyIdentifier.NUMBER_OF_STATES, 'oos': PropertyIdentifier.OUT_OF_SERVICE, 'polarity': PropertyIdentifier.POLARITY, 'priority': PropertyIdentifier.PRIORITY_ARRAY, 'profile-name': PropertyIdentifier.PROFILE_NAME, 'prop-list': PropertyIdentifier.PROPERTY_LIST, 'protocol-revision': PropertyIdentifier.PROTOCOL_REVISION, 'protocol-version': PropertyIdentifier.PROTOCOL_VERSION, 'pv': PropertyIdentifier.PRESENT_VALUE, 'record-count': PropertyIdentifier.RECORD_COUNT, 'reliability': PropertyIdentifier.RELIABILITY, 'relinquish': PropertyIdentifier.RELINQUISH_DEFAULT, 'res': PropertyIdentifier.RESOLUTION, 'schedule-default': PropertyIdentifier.SCHEDULE_DEFAULT, 'seg-supported': PropertyIdentifier.SEGMENTATION_SUPPORTED, 'state-text': PropertyIdentifier.STATE_TEXT, 'status': PropertyIdentifier.STATUS_FLAGS, 'system-status': PropertyIdentifier.SYSTEM_STATUS, 'time-delay': PropertyIdentifier.TIME_DELAY, 'type': PropertyIdentifier.OBJECT_TYPE, 'units': PropertyIdentifier.UNITS, 'vendor-id': PropertyIdentifier.VENDOR_IDENTIFIER, 'vendor-name': PropertyIdentifier.VENDOR_NAME, 'weekly-schedule': PropertyIdentifier.WEEKLY_SCHEDULE}¶

Short aliases for commonly used property identifiers.

Full hyphenated names (e.g. "present-value") and underscore names (e.g. "PRESENT_VALUE") are always accepted via _resolve_property_identifier() without needing an alias entry here.

bac_py.types.parsing.parse_object_identifier(obj)[source]¶

Parse a flexible object identifier to ObjectIdentifier.

Accepted formats:

"analog-input,1"                  -> ObjectIdentifier(ANALOG_INPUT, 1)
"analog-input:1"                  -> ObjectIdentifier(ANALOG_INPUT, 1)
"ai,1"                            -> ObjectIdentifier(ANALOG_INPUT, 1)
("analog-input", 1)               -> ObjectIdentifier(ANALOG_INPUT, 1)
(ObjectType.ANALOG_INPUT, 1)      -> ObjectIdentifier(ANALOG_INPUT, 1)
(0, 1)                            -> ObjectIdentifier(ANALOG_INPUT, 1)
ObjectIdentifier(...)             -> pass-through

Parameters:: obj (str | tuple[str | ObjectType | int, int] | ObjectIdentifier) – Object identifier in any supported format.
Return type:: ObjectIdentifier
Returns:: Parsed ObjectIdentifier.
Raises:: ValueError – If the format is not recognised.

bac_py.types.parsing.parse_property_identifier(prop)[source]¶

Parse a flexible property identifier to PropertyIdentifier.

Accepted formats:

"present-value"                   -> PropertyIdentifier.PRESENT_VALUE
"present_value"                   -> PropertyIdentifier.PRESENT_VALUE
"pv"                              -> PropertyIdentifier.PRESENT_VALUE
"object-name"                     -> PropertyIdentifier.OBJECT_NAME
"name"                            -> PropertyIdentifier.OBJECT_NAME
85                                -> PropertyIdentifier(85)
PropertyIdentifier.PRESENT_VALUE  -> pass-through

Parameters:: prop (str | int | PropertyIdentifier) – Property identifier in any supported format.
Return type:: PropertyIdentifier
Returns:: Parsed PropertyIdentifier.
Raises:: ValueError – If the format is not recognised.

Notification Parameters¶

BACnet NotificationParameters CHOICE type per ASHRAE 135-2020 Clause 13.3.

Each variant is a frozen dataclass identified by its context tag number which corresponds to the BACnetEventType enumeration value. A factory function decode_notification_parameters() dispatches to the correct variant based on the opening context tag.

class bac_py.types.notification_params.ChangeOfBitstring(referenced_bitstring=<factory>, status_flags=<factory>)[source]¶

Bases: object

change-of-bitstring notification parameters (Clause 13.3.1).

Fields:: [0] referenced_bitstring BIT STRING [1] status_flags BACnetStatusFlags

Parameters:

referenced_bitstring (BitString)
status_flags (StatusFlags)

TAG: ClassVar[int] = 0¶

referenced_bitstring: BitString¶

status_flags: StatusFlags¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfBitstring, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfBitstring
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfState(new_state=b'', status_flags=<factory>)[source]¶

Bases: object

change-of-state notification parameters (Clause 13.3.2).

new_state is carried as raw bytes because BACnetPropertyStates is a large CHOICE type with 40+ variants.

Fields:: [0] new_state BACnetPropertyStates (raw bytes) [1] status_flags BACnetStatusFlags

Parameters:

new_state (bytes)
status_flags (StatusFlags)

TAG: ClassVar[int] = 1¶

new_state: bytes¶

status_flags: StatusFlags¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfState, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfState
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfValue(new_value_choice=1, new_value=0.0, status_flags=<factory>)[source]¶

Bases: object

change-of-value notification parameters (Clause 13.3.3).

The new_value CHOICE is discriminated by new_value_choice:: 0 = changed-bits (BitString), 1 = changed-value (Real).
Fields:: [0] new_value CHOICE { [0] changed-bits, [1] changed-value } [1] status_flags BACnetStatusFlags

Parameters:

new_value_choice (int)
new_value (BitString | float)
status_flags (StatusFlags)

TAG: ClassVar[int] = 2¶

new_value_choice: int¶

new_value: BitString | float¶

status_flags: StatusFlags¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfValue, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfValue
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.CommandFailure(command_value=b'', status_flags=<factory>, feedback_value=b'')[source]¶

Bases: object

command-failure notification parameters (Clause 13.3.4).

command_value and feedback_value are ABSTRACT-SYNTAX.&Type and are carried as raw bytes.

Fields:: [0] command_value (raw bytes) [1] status_flags BACnetStatusFlags [2] feedback_value (raw bytes)

Parameters:

command_value (bytes)
status_flags (StatusFlags)
feedback_value (bytes)

TAG: ClassVar[int] = 3¶

command_value: bytes¶

status_flags: StatusFlags¶

feedback_value: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[CommandFailure, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: CommandFailure
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.FloatingLimit(reference_value=0.0, status_flags=<factory>, setpoint_value=0.0, error_limit=0.0)[source]¶

Bases: object

floating-limit notification parameters (Clause 13.3.5).

Fields:: [0] reference_value REAL [1] status_flags BACnetStatusFlags [2] setpoint_value REAL [3] error_limit REAL

Parameters:

reference_value (float)
status_flags (StatusFlags)
setpoint_value (float)
error_limit (float)

TAG: ClassVar[int] = 4¶

reference_value: float¶

status_flags: StatusFlags¶

setpoint_value: float¶

error_limit: float¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FloatingLimit, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FloatingLimit
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.OutOfRange(exceeding_value=0.0, status_flags=<factory>, deadband=0.0, exceeded_limit=0.0)[source]¶

Bases: object

out-of-range notification parameters (Clause 13.3.6).

Fields:: [0] exceeding_value REAL [1] status_flags BACnetStatusFlags [2] deadband REAL [3] exceeded_limit REAL

Parameters:

exceeding_value (float)
status_flags (StatusFlags)
deadband (float)
exceeded_limit (float)

TAG: ClassVar[int] = 5¶

exceeding_value: float¶

status_flags: StatusFlags¶

deadband: float¶

exceeded_limit: float¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[OutOfRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: OutOfRange
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfLifeSafety(new_state=LifeSafetyState.QUIET, new_mode=LifeSafetyMode.OFF, status_flags=<factory>, operation_expected=LifeSafetyOperation.NONE)[source]¶

Bases: object

change-of-life-safety notification parameters (Clause 13.3.8).

Fields:: [0] new_state BACnetLifeSafetyState [1] new_mode BACnetLifeSafetyMode [2] status_flags BACnetStatusFlags [3] operation_expected BACnetLifeSafetyOperation

Parameters:

new_state (LifeSafetyState)
new_mode (LifeSafetyMode)
status_flags (StatusFlags)
operation_expected (LifeSafetyOperation)

TAG: ClassVar[int] = 8¶

new_state: LifeSafetyState¶

new_mode: LifeSafetyMode¶

status_flags: StatusFlags¶

operation_expected: LifeSafetyOperation¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfLifeSafety, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfLifeSafety
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.Extended(vendor_id=0, extended_event_type=0, parameters=b'')[source]¶

Bases: object

extended notification parameters (Clause 13.3.9).

parameters is carried as raw bytes (vendor-defined content).

Fields:: [0] vendor_id Unsigned16 [1] extended_event_type Unsigned [2] parameters SEQUENCE OF CHOICE (raw bytes)

Parameters:

vendor_id (int)
extended_event_type (int)
parameters (bytes)

TAG: ClassVar[int] = 9¶

vendor_id: int¶

extended_event_type: int¶

parameters: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[Extended, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: Extended
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.BufferReady(buffer_property=b'', previous_notification=0, current_notification=0)[source]¶

Bases: object

buffer-ready notification parameters (Clause 13.3.10).

buffer_property is carried as raw bytes representing the encoded BACnetDeviceObjectPropertyReference.

Fields:: [0] buffer_property BACnetDeviceObjectPropertyReference (raw) [1] previous_notification Unsigned32 [2] current_notification Unsigned32

Parameters:

buffer_property (bytes)
previous_notification (int)
current_notification (int)

TAG: ClassVar[int] = 10¶

buffer_property: bytes¶

previous_notification: int¶

current_notification: int¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[BufferReady, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: BufferReady
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.UnsignedRange(exceeding_value=0, status_flags=<factory>, exceeded_limit=0)[source]¶

Bases: object

unsigned-range notification parameters (Clause 13.3.11).

Fields:: [0] exceeding_value Unsigned [1] status_flags BACnetStatusFlags [2] exceeded_limit Unsigned

Parameters:

exceeding_value (int)
status_flags (StatusFlags)
exceeded_limit (int)

TAG: ClassVar[int] = 11¶

exceeding_value: int¶

status_flags: StatusFlags¶

exceeded_limit: int¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[UnsignedRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: UnsignedRange
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.AccessEvent(access_event=0, status_flags=<factory>, access_event_tag=0, access_event_time=b'', access_credential=b'', authentication_factor=None)[source]¶

Bases: object

access-event notification parameters (Clause 13.3.13).

access_event_time, access_credential, and authentication_factor are carried as raw bytes due to complexity.

Fields:: [0] access_event Enumerated [1] status_flags BACnetStatusFlags [2] access_event_tag Unsigned [3] access_event_time BACnetTimeStamp (raw) [4] access_credential BACnetDeviceObjectReference (raw) [5] authentication_factor BACnetAuthenticationFactor (raw, OPTIONAL)

Parameters:

access_event (int)
status_flags (StatusFlags)
access_event_tag (int)
access_event_time (bytes)
access_credential (bytes)
authentication_factor (bytes | None)

TAG: ClassVar[int] = 13¶

access_event: int¶

status_flags: StatusFlags¶

access_event_tag: int¶

access_event_time: bytes¶

access_credential: bytes¶

authentication_factor: bytes | None¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[AccessEvent, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: AccessEvent
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.DoubleOutOfRange(exceeding_value=0.0, status_flags=<factory>, deadband=0.0, exceeded_limit=0.0)[source]¶

Bases: object

double-out-of-range notification parameters (Clause 13.3.14).

Fields:: [0] exceeding_value Double [1] status_flags BACnetStatusFlags [2] deadband Double [3] exceeded_limit Double

Parameters:

exceeding_value (float)
status_flags (StatusFlags)
deadband (float)
exceeded_limit (float)

TAG: ClassVar[int] = 14¶

exceeding_value: float¶

status_flags: StatusFlags¶

deadband: float¶

exceeded_limit: float¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[DoubleOutOfRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: DoubleOutOfRange
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.SignedOutOfRange(exceeding_value=0, status_flags=<factory>, deadband=0, exceeded_limit=0)[source]¶

Bases: object

signed-out-of-range notification parameters (Clause 13.3.15).

Fields:: [0] exceeding_value Signed [1] status_flags BACnetStatusFlags [2] deadband Unsigned [3] exceeded_limit Signed

Parameters:

exceeding_value (int)
status_flags (StatusFlags)
deadband (int)
exceeded_limit (int)

TAG: ClassVar[int] = 15¶

exceeding_value: int¶

status_flags: StatusFlags¶

deadband: int¶

exceeded_limit: int¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[SignedOutOfRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: SignedOutOfRange
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.UnsignedOutOfRange(exceeding_value=0, status_flags=<factory>, deadband=0, exceeded_limit=0)[source]¶

Bases: object

unsigned-out-of-range notification parameters (Clause 13.3.16).

Fields:: [0] exceeding_value Unsigned [1] status_flags BACnetStatusFlags [2] deadband Unsigned [3] exceeded_limit Unsigned

Parameters:

exceeding_value (int)
status_flags (StatusFlags)
deadband (int)
exceeded_limit (int)

TAG: ClassVar[int] = 16¶

exceeding_value: int¶

status_flags: StatusFlags¶

deadband: int¶

exceeded_limit: int¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[UnsignedOutOfRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: UnsignedOutOfRange
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfCharacterstring(changed_value='', status_flags=<factory>, alarm_value='')[source]¶

Bases: object

change-of-characterstring notification parameters (Clause 13.3.17).

Fields:: [0] changed_value CharacterString [1] status_flags BACnetStatusFlags [2] alarm_value CharacterString

Parameters:

changed_value (str)
status_flags (StatusFlags)
alarm_value (str)

TAG: ClassVar[int] = 17¶

changed_value: str¶

status_flags: StatusFlags¶

alarm_value: str¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfCharacterstring, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfCharacterstring
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfStatusFlags(present_value=b'', referenced_flags=<factory>)[source]¶

Bases: object

change-of-status-flags notification parameters (Clause 13.3.18).

present_value is ABSTRACT-SYNTAX.&Type (raw bytes).

Fields:: [0] present_value (raw bytes) [1] referenced_flags BACnetStatusFlags

Parameters:

present_value (bytes)
referenced_flags (StatusFlags)

TAG: ClassVar[int] = 18¶

present_value: bytes¶

referenced_flags: StatusFlags¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfStatusFlags, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfStatusFlags
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfReliability(reliability=Reliability.NO_FAULT_DETECTED, status_flags=<factory>, property_values=b'')[source]¶

Bases: object

change-of-reliability notification parameters (Clause 13.3.19).

property_values is carried as raw bytes.

Fields:: [0] reliability BACnetReliability [1] status_flags BACnetStatusFlags [2] property_values SEQUENCE OF BACnetPropertyValue (raw)

Parameters:

reliability (Reliability)
status_flags (StatusFlags)
property_values (bytes)

TAG: ClassVar[int] = 19¶

reliability: Reliability¶

status_flags: StatusFlags¶

property_values: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfReliability, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfReliability
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.NoneParams[source]¶

Bases: object

Empty notification parameters for EventType.NONE (tag 20).

TAG: ClassVar[int] = 20¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data (no fields).

Return type:

tuple[NoneParams, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: NoneParams
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfDiscreteValue(new_value=b'', status_flags=<factory>)[source]¶

Bases: object

change-of-discrete-value notification parameters (Clause 13.3.21).

new_value is dependent on object type and carried as raw bytes.

Fields:: [0] new_value CHOICE (raw bytes) [1] status_flags BACnetStatusFlags

Parameters:

new_value (bytes)
status_flags (StatusFlags)

TAG: ClassVar[int] = 21¶

new_value: bytes¶

status_flags: StatusFlags¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfDiscreteValue, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfDiscreteValue
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.ChangeOfTimer(new_state=TimerState.IDLE, status_flags=<factory>, update_time=<factory>, last_state_change=TimerTransition.NONE, initial_timeout=None, expiration_time=None)[source]¶

Bases: object

change-of-timer notification parameters (Clause 13.3.22, new in 2020).

Fields:: [0] new_state BACnetTimerState [1] status_flags BACnetStatusFlags [2] update_time BACnetDateTime [3] last_state_change BACnetTimerTransition [4] initial_timeout Unsigned (OPTIONAL) [5] expiration_time BACnetDateTime (OPTIONAL)

Parameters:

new_state (TimerState)
status_flags (StatusFlags)
update_time (BACnetDateTime)
last_state_change (TimerTransition)
initial_timeout (int | None)
expiration_time (BACnetDateTime | None)

TAG: ClassVar[int] = 22¶

new_state: TimerState¶

status_flags: StatusFlags¶

update_time: BACnetDateTime¶

last_state_change: TimerTransition¶

initial_timeout: int | None¶

expiration_time: BACnetDateTime | None¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[ChangeOfTimer, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: ChangeOfTimer
Parameters:: d (dict[str, Any])

class bac_py.types.notification_params.RawNotificationParameters(tag_number, raw_data=b'')[source]¶

Bases: object

Fallback for unknown or reserved notification parameter variants.

Carries the raw encoded bytes between the CHOICE opening/closing tags. Used for reserved tags (6, 7, 12) or vendor-extended tags.

Parameters:

tag_number (int)
raw_data (bytes)

tag_number: int¶

raw_data: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: RawNotificationParameters
Parameters:: d (dict[str, Any])

bac_py.types.notification_params.decode_notification_parameters(data, offset=0)[source]¶

Decode a BACnetNotificationParameters CHOICE from wire data.

Reads the opening context tag to determine the variant, dispatches to the correct decoder, then consumes the closing context tag.

Parameters:

data (memoryview | bytes) – Buffer containing the encoded CHOICE.
offset (int (default: 0)) – Starting position in the buffer.

Return type:

Returns:

Tuple of (decoded variant, new offset past the closing tag).

bac_py.types.notification_params.notification_parameters_from_dict(d)[source]¶

Reconstruct a NotificationParameters variant from a dictionary.

Parameters:: d (dict[str, Any]) – Dictionary with a "type" field identifying the variant.
Return type:: ChangeOfBitstring | ChangeOfState | ChangeOfValue | CommandFailure | FloatingLimit | OutOfRange | ChangeOfLifeSafety | Extended | BufferReady | UnsignedRange | AccessEvent | DoubleOutOfRange | SignedOutOfRange | UnsignedOutOfRange | ChangeOfCharacterstring | ChangeOfStatusFlags | ChangeOfReliability | NoneParams | ChangeOfDiscreteValue | ChangeOfTimer | RawNotificationParameters
Returns:: The reconstructed variant instance.
Raises:: ValueError – If the type is not recognised.

Fault Parameters¶

BACnetFaultParameter CHOICE type per ASHRAE 135-2020 Clause 13.4.

Each variant is a frozen dataclass identified by its context tag number. A factory function decode_fault_parameter() dispatches to the correct variant based on the opening context tag.

class bac_py.types.fault_params.FaultNone[source]¶

Bases: object

fault-none parameter (Clause 13.4).

Represents the none variant of BACnetFaultParameter. Carries no fields – encoded as [0] NULL.

TAG: ClassVar[int] = 0¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultNone, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultNone
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultCharacterString(fault_values=())[source]¶

Bases: object

fault-characterstring parameter (Clause 13.4).

Fields:: [0] list-of-fault-values SEQUENCE OF CharacterString

Parameters:: fault_values (tuple[str, ...])

TAG: ClassVar[int] = 1¶

fault_values: tuple[str, ...]¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultCharacterString, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultCharacterString
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultExtended(vendor_id=0, extended_fault_type=0, parameters=b'')[source]¶

Bases: object

fault-extended parameter (Clause 13.4).

Fields:: [0] vendor-id Unsigned16 [1] extended-fault-type Unsigned [2] parameters SEQUENCE OF … (raw bytes)

Parameters:

vendor_id (int)
extended_fault_type (int)
parameters (bytes)

TAG: ClassVar[int] = 2¶

vendor_id: int¶

extended_fault_type: int¶

parameters: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultExtended, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultExtended
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultLifeSafety(fault_values=(), mode_values=())[source]¶

Bases: object

fault-life-safety parameter (Clause 13.4).

Fields:: [0] list-of-fault-values SEQUENCE OF BACnetLifeSafetyState [1] list-of-mode-values SEQUENCE OF BACnetLifeSafetyMode

Parameters:

fault_values (tuple[LifeSafetyState, ...])
mode_values (tuple[LifeSafetyMode, ...])

TAG: ClassVar[int] = 3¶

fault_values: tuple[LifeSafetyState, ...]¶

mode_values: tuple[LifeSafetyMode, ...]¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultLifeSafety, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultLifeSafety
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultState(fault_values=b'')[source]¶

Bases: object

fault-state parameter (Clause 13.4).

fault_values is carried as raw bytes because BACnetPropertyStates is a large CHOICE type with 40+ variants.

Fields:: [0] list-of-fault-values SEQUENCE OF BACnetPropertyStates (raw bytes)

Parameters:: fault_values (bytes)

TAG: ClassVar[int] = 4¶

fault_values: bytes¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultState, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultState
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultStatusFlags(status_flags_ref=<factory>)[source]¶

Bases: object

fault-status-flags parameter (Clause 13.4).

Fields:: [0] status-flags-reference BACnetDeviceObjectPropertyReference

Parameters:: status_flags_ref (BACnetDeviceObjectPropertyReference)

TAG: ClassVar[int] = 5¶

status_flags_ref: BACnetDeviceObjectPropertyReference¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultStatusFlags, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultStatusFlags
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultOutOfRange(min_normal_value=0.0, max_normal_value=0.0, min_choice=0, max_choice=0)[source]¶

Bases: object

fault-out-of-range parameter (Clause 13.4).

The min/max normal value each have an inner CHOICE:: [0] real, [1] unsigned, [2] double, [3] integer.
Fields:: [0] min-normal-value CHOICE { real [0], unsigned [1], double [2], integer [3] } [1] max-normal-value CHOICE { real [0], unsigned [1], double [2], integer [3] }

Parameters:

min_normal_value (float | int)
max_normal_value (float | int)
min_choice (int)
max_choice (int)

TAG: ClassVar[int] = 6¶

min_normal_value: float | int¶

max_normal_value: float | int¶

min_choice: int¶

max_choice: int¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultOutOfRange, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultOutOfRange
Parameters:: d (dict[str, Any])

class bac_py.types.fault_params.FaultListed(fault_list_ref=<factory>)[source]¶

Bases: object

fault-listed parameter (Clause 13.4).

Fields:: [0] fault-list-reference BACnetDeviceObjectPropertyReference

Parameters:: fault_list_ref (BACnetDeviceObjectPropertyReference)

TAG: ClassVar[int] = 7¶

fault_list_ref: BACnetDeviceObjectPropertyReference¶

encode()[source]¶

Encode to wire format with CHOICE opening/closing tags.

Return type:: bytes

classmethod decode_inner(data, offset)[source]¶

Decode inner fields from wire data.

Return type:

tuple[FaultListed, int]

Parameters:

data (memoryview)
offset (int)

to_dict()[source]¶

Convert to a JSON-serializable dict.

Return type:: dict[str, Any]

classmethod from_dict(d)[source]¶

Reconstruct from a JSON-friendly dict.

Return type:: FaultListed
Parameters:: d (dict[str, Any])

bac_py.types.fault_params.decode_fault_parameter(data, offset=0)[source]¶

Decode a BACnetFaultParameter CHOICE from wire data.

Reads the opening context tag to determine the variant, dispatches to the correct decoder, then consumes the closing context tag.

Parameters:

data (memoryview | bytes) – Buffer containing the encoded CHOICE.
offset (int (default: 0)) – Starting position in the buffer.

Return type:

Returns:

Tuple of (decoded variant, new offset past the closing tag).

Raises:

ValueError – If the opening tag is missing or the tag number is not recognised.

bac_py.types.fault_params.fault_parameter_from_dict(d)[source]¶

Reconstruct a FaultParameter variant from a dictionary.

Parameters:: d (dict[str, Any]) – Dictionary with a "type" field identifying the variant.
Return type:: FaultNone | FaultCharacterString | FaultExtended | FaultLifeSafety | FaultState | FaultStatusFlags | FaultOutOfRange | FaultListed
Returns:: The reconstructed variant instance.
Raises:: ValueError – If the type is not recognised.

Audit Types¶

BACnet audit constructed types per ASHRAE 135-2020 Clause 19.6.

BACnetAuditNotification, BACnetAuditLogRecord, AuditQueryByTarget, AuditQueryBySource.

class bac_py.types.audit_types.BACnetAuditNotification(operation=AuditOperation.GENERAL, source_device=None, source_object=None, source_comment=None, target_comment=None, invoke_id=None, source_user_id=None, source_user_role=None, target_device=None, target_object=None, target_property=None, target_array_index=None, target_priority=None, target_value=None, current_value=None, result_error_class=None, result_error_code=None)[source]¶

Bases: object

BACnetAuditNotification per Clause 19.6.

BACnetAuditNotification ::= SEQUENCE {
    source-timestamp      [0] BACnetTimeStamp OPTIONAL,
    target-timestamp      [1] BACnetTimeStamp OPTIONAL,
    source-device         [2] BACnetRecipient OPTIONAL,
    source-object         [3] BACnetObjectIdentifier OPTIONAL,
    operation             [4] BACnetAuditOperation,
    source-comment        [5] CharacterString OPTIONAL,
    target-comment        [6] CharacterString OPTIONAL,
    invoke-id             [7] Unsigned8 OPTIONAL,
    source-user-id        [8] Unsigned16 OPTIONAL,
    source-user-role      [9] Unsigned8 OPTIONAL,
    target-device         [10] BACnetRecipient OPTIONAL,
    target-object         [11] BACnetObjectIdentifier OPTIONAL,
    target-property       [12] BACnetPropertyReference OPTIONAL,
    target-priority       [13] Unsigned (1..16) OPTIONAL,
    target-value          [14] ABSTRACT-SYNTAX.&Type OPTIONAL,
    current-value         [15] ABSTRACT-SYNTAX.&Type OPTIONAL,
    result                [16] Error OPTIONAL,
}

Parameters:

operation (AuditOperation)
source_device (ObjectIdentifier | None)
source_object (ObjectIdentifier | None)
source_comment (str | None)
target_comment (str | None)
invoke_id (int | None)
source_user_id (int | None)
source_user_role (int | None)
target_device (ObjectIdentifier | None)
target_object (ObjectIdentifier | None)
target_property (int | None)
target_array_index (int | None)
target_priority (int | None)
target_value (bytes | None)
current_value (bytes | None)
result_error_class (int | None)
result_error_code (int | None)

operation: AuditOperation¶

source_device: ObjectIdentifier | None¶

source_object: ObjectIdentifier | None¶

source_comment: str | None¶

target_comment: str | None¶

invoke_id: int | None¶

source_user_id: int | None¶

source_user_role: int | None¶

target_device: ObjectIdentifier | None¶

target_object: ObjectIdentifier | None¶

target_property: int | None¶

target_array_index: int | None¶

target_priority: int | None¶

target_value: bytes | None¶

current_value: bytes | None¶

result_error_class: int | None¶

result_error_code: int | None¶

encode()[source]¶

Encode BACnetAuditNotification to ASN.1 bytes.

Return type:: bytes

classmethod decode(data)[source]¶

Decode BACnetAuditNotification from ASN.1 bytes.

Return type:: Self
Parameters:: data (memoryview | bytes)

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Optional fields are omitted when None.

Return type:: dict[str, Any]
Returns:: Dictionary with audit notification fields.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with audit notification fields.
Return type:: BACnetAuditNotification
Returns:: Decoded BACnetAuditNotification instance.

class bac_py.types.audit_types.BACnetAuditLogRecord(sequence_number, notification)[source]¶

Bases: object

Wrapper combining a sequence number with an audit notification.

Parameters:

sequence_number (int)
notification (BACnetAuditNotification)

sequence_number: int¶

notification: BACnetAuditNotification¶

encode()[source]¶

Encode BACnetAuditLogRecord.

Return type:: bytes

classmethod decode(data)[source]¶

Decode BACnetAuditLogRecord.

Return type:: Self
Parameters:: data (memoryview | bytes)

to_dict()[source]¶

Convert to a JSON-serializable dictionary.

Return type:: dict[str, Any]
Returns:: Dictionary with "sequence_number" and "notification" keys.

classmethod from_dict(data)[source]¶

Reconstruct from a JSON-friendly dictionary.

Parameters:: data (dict[str, Any]) – Dictionary with "sequence_number" and "notification" keys.
Return type:: BACnetAuditLogRecord
Returns:: Decoded BACnetAuditLogRecord instance.

class bac_py.types.audit_types.AuditQueryByTarget(target_device_identifier, target_device_address=None, target_object_identifier=None, target_property_identifier=None, target_array_index=None, target_priority=None, operations=None, result_filter=0)[source]¶

Bases: object

Query parameters for AuditLogQuery by target (Clause 13.19).

Parameters:

target_device_identifier (ObjectIdentifier)
target_device_address (bytes | None)
target_object_identifier (ObjectIdentifier | None)
target_property_identifier (int | None)
target_array_index (int | None)
target_priority (int | None)
operations (int | None)
result_filter (int)

target_device_identifier: ObjectIdentifier¶

target_device_address: bytes | None¶

target_object_identifier: ObjectIdentifier | None¶

target_property_identifier: int | None¶

target_array_index: int | None¶

target_priority: int | None¶

operations: int | None¶

result_filter: int¶

encode()[source]¶

Encode AuditQueryByTarget.

Return type:: bytes

classmethod decode(data)[source]¶

Decode AuditQueryByTarget.

Return type:: Self
Parameters:: data (memoryview | bytes)

class bac_py.types.audit_types.AuditQueryBySource(source_device_identifier, source_device_address=None, source_object_identifier=None, operations=None, result_filter=0)[source]¶

Bases: object

Query parameters for AuditLogQuery by source (Clause 13.19).

Parameters:

source_device_identifier (ObjectIdentifier)
source_device_address (bytes | None)
source_object_identifier (ObjectIdentifier | None)
operations (int | None)
result_filter (int)

source_device_identifier: ObjectIdentifier¶

source_device_address: bytes | None¶

source_object_identifier: ObjectIdentifier | None¶

operations: int | None¶

result_filter: int¶

encode()[source]¶

Encode AuditQueryBySource.

Return type:: bytes

classmethod decode(data)[source]¶

Decode AuditQueryBySource.

Return type:: Self
Parameters:: data (memoryview | bytes)