Python enumerations

Named BACnet constants. Each also takes vendor or unknown values from their number. The Python reference lists every group. Each page opens with its main classes, then the other classes, the dictionaries (TypedDict) and the type aliases, in stub order.

ObjectType

BACnet object type enumeration (Clause 12).

Standard types 0-64; vendor-proprietary 128-1023. Use ObjectType.from_raw(n) for values not listed here.

65 constants:

ANALOG_INPUT, ANALOG_OUTPUT, ANALOG_VALUE, BINARY_INPUT, BINARY_OUTPUT, BINARY_VALUE, CALENDAR, COMMAND, DEVICE, EVENT_ENROLLMENT, FILE, GROUP, LOOP, MULTI_STATE_INPUT, MULTI_STATE_OUTPUT, NOTIFICATION_CLASS, PROGRAM, SCHEDULE, AVERAGING, MULTI_STATE_VALUE, TREND_LOG, LIFE_SAFETY_POINT, LIFE_SAFETY_ZONE, ACCUMULATOR, PULSE_CONVERTER, EVENT_LOG, GLOBAL_GROUP, TREND_LOG_MULTIPLE, LOAD_CONTROL, STRUCTURED_VIEW, ACCESS_DOOR, TIMER, ACCESS_CREDENTIAL, ACCESS_POINT, ACCESS_RIGHTS, ACCESS_USER, ACCESS_ZONE, CREDENTIAL_DATA_INPUT, NETWORK_SECURITY, BITSTRING_VALUE, CHARACTERSTRING_VALUE, DATEPATTERN_VALUE, DATE_VALUE, DATETIMEPATTERN_VALUE, DATETIME_VALUE, INTEGER_VALUE, LARGE_ANALOG_VALUE, OCTETSTRING_VALUE, POSITIVE_INTEGER_VALUE, TIMEPATTERN_VALUE, TIME_VALUE, NOTIFICATION_FORWARDER, ALERT_ENROLLMENT, CHANNEL, LIGHTING_OUTPUT, BINARY_LIGHTING_OUTPUT, NETWORK_PORT, ELEVATOR_GROUP, ESCALATOR, LIFT, STAGING, AUDIT_REPORTER, AUDIT_LOG, COLOR, COLOR_TEMPERATURE

Properties:

name: str | None: The constant’s name ("ANALOG_INPUT"), or None for a value without one.

ObjectType.from_raw

@staticmethod
def from_raw(value: int) -> ObjectType

ObjectType.to_raw

def to_raw(self) -> int

PropertyIdentifier

BACnet property identifier enumeration (Clause 12).

All named properties registered at runtime are listed below as class attributes matching the BACnet constant names. Use PropertyIdentifier.from_raw(n) for vendor-proprietary values.

486 constants:

ACKED_TRANSITIONS, ACK_REQUIRED, ACTION, ACTION_TEXT, ACTIVE_TEXT, ACTIVE_VT_SESSIONS, ALARM_VALUE, ALARM_VALUES, ALL, ALL_WRITES_SUCCESSFUL, APDU_SEGMENT_TIMEOUT, APDU_TIMEOUT, APPLICATION_SOFTWARE_VERSION, CHANGE_OF_STATE_COUNT, CHANGE_OF_STATE_TIME, NOTIFICATION_CLASS, CONTROLLED_VARIABLE_REFERENCE, COV_INCREMENT, DATE_LIST, DEADBAND, DESCRIPTION, DEVICE_ADDRESS_BINDING, DEVICE_TYPE, EFFECTIVE_PERIOD, EVENT_ENABLE, EVENT_STATE, EVENT_TYPE, EXCEPTION_SCHEDULE, FEEDBACK_VALUE, FILE_ACCESS_METHOD, FILE_SIZE, FILE_TYPE, FIRMWARE_REVISION, HIGH_LIMIT, INACTIVE_TEXT, IN_PROCESS, LIMIT_ENABLE, LIST_OF_GROUP_MEMBERS, LIST_OF_OBJECT_PROPERTY_REFERENCES, LOCAL_DATE, LOCAL_TIME, LOCATION, LOW_LIMIT, MAX_APDU_LENGTH_ACCEPTED, MAX_INFO_FRAMES, MAX_MASTER, MAX_PRES_VALUE, MIN_PRES_VALUE, MODEL_NAME, NOTIFY_TYPE, NUMBER_OF_APDU_RETRIES, NUMBER_OF_STATES, OBJECT_IDENTIFIER, OBJECT_LIST, OBJECT_NAME, OBJECT_PROPERTY_REFERENCE, OBJECT_TYPE, OUT_OF_SERVICE, OUTPUT_UNITS, EVENT_PARAMETERS, POLARITY, PRESENT_VALUE, PRIORITY, PRIORITY_ARRAY, PRIORITY_FOR_WRITING, PROCESS_IDENTIFIER, PROGRAM_CHANGE, PROGRAM_STATE, PROTOCOL_OBJECT_TYPES_SUPPORTED, PROTOCOL_SERVICES_SUPPORTED, PROTOCOL_VERSION, RECIPIENT_LIST, RELIABILITY, RELINQUISH_DEFAULT, RESOLUTION, SEGMENTATION_SUPPORTED, SETPOINT, STATE_TEXT, STATUS_FLAGS, SYSTEM_STATUS, TIME_DELAY, UNITS, UPDATE_INTERVAL, UTC_OFFSET, VENDOR_IDENTIFIER, VENDOR_NAME, WEEKLY_SCHEDULE, BUFFER_SIZE, COV_RESUBSCRIPTION_INTERVAL, EVENT_TIME_STAMPS, EVENT_MESSAGE_TEXTS, EVENT_MESSAGE_TEXTS_CONFIG, LOG_BUFFER, LOG_DEVICE_OBJECT_PROPERTY, LOG_ENABLE, LOG_INTERVAL, PROTOCOL_REVISION, RECORD_COUNT, START_TIME, STOP_TIME, STOP_WHEN_FULL, TOTAL_RECORD_COUNT, ACTIVE_COV_SUBSCRIPTIONS, DATABASE_REVISION, MAINTENANCE_REQUIRED, MEMBER_OF, MODE, SILENCED, TRACKING_VALUE, ZONE_MEMBERS, LIFE_SAFETY_ALARM_VALUES, MAX_SEGMENTS_ACCEPTED, PROFILE_NAME, SCHEDULE_DEFAULT, LOGGING_OBJECT, LOGGING_TYPE, ALIGN_INTERVALS, INTERVAL_OFFSET, LAST_RESTART_REASON, TIME_OF_DEVICE_RESTART, TIME_SYNCHRONIZATION_INTERVAL, UTC_TIME_SYNCHRONIZATION_RECIPIENTS, NODE_SUBTYPE, NODE_TYPE, STRUCTURED_OBJECT_LIST, SUBORDINATE_LIST, ACTUAL_SHED_LEVEL, REQUESTED_SHED_LEVEL, PROPERTY_LIST, EVENT_DETECTION_ENABLE, EVENT_ALGORITHM_INHIBIT, EVENT_ALGORITHM_INHIBIT_REF, TIME_DELAY_NORMAL, RELIABILITY_EVALUATION_INHIBIT, FAULT_TYPE, CHANNEL_NUMBER, CONTROL_GROUPS, EXECUTION_DELAY, NETWORK_NUMBER, NETWORK_TYPE, MAC_ADDRESS, COMMAND_TIME_ARRAY, CURRENT_COMMAND_PRIORITY, LAST_COMMAND_TIME, VALUE_SOURCE, VALUE_SOURCE_ARRAY, BACNET_IPV6_MODE, TAGS, PRESENT_STAGE, STAGES, STAGE_NAMES, AUDIT_LEVEL, DEVICE_UUID, ARCHIVE, BIAS, CONTROLLED_VARIABLE_UNITS, CONTROLLED_VARIABLE_VALUE, DAYLIGHT_SAVINGS_STATUS, DERIVATIVE_CONSTANT, DERIVATIVE_CONSTANT_UNITS, DESCRIPTION_OF_HALT, ELAPSED_ACTIVE_TIME, ERROR_LIMIT, FAULT_VALUES, INSTANCE_OF, INTEGRAL_CONSTANT, INTEGRAL_CONSTANT_UNITS, ISSUE_CONFIRMED_NOTIFICATIONS, MANIPULATED_VARIABLE_REFERENCE, MAXIMUM_OUTPUT, MINIMUM_OFF_TIME, MINIMUM_ON_TIME, MINIMUM_OUTPUT, MODIFICATION_DATE, OPTIONAL, PROGRAM_LOCATION, PROPORTIONAL_CONSTANT, PROPORTIONAL_CONSTANT_UNITS, READ_ONLY, REASON_FOR_HALT, REQUIRED, SETPOINT_REFERENCE, TIME_OF_ACTIVE_TIME_RESET, TIME_OF_STATE_COUNT_RESET, TIME_SYNCHRONIZATION_RECIPIENTS, VT_CLASSES_SUPPORTED, ATTEMPTED_SAMPLES, AVERAGE_VALUE, CLIENT_COV_INCREMENT, MAXIMUM_VALUE, MINIMUM_VALUE, NOTIFICATION_THRESHOLD, RECORDS_SINCE_NOTIFICATION, VALID_SAMPLES, WINDOW_INTERVAL, WINDOW_SAMPLES, MAXIMUM_VALUE_TIMESTAMP, MINIMUM_VALUE_TIMESTAMP, VARIANCE_VALUE, BACKUP_FAILURE_TIMEOUT, CONFIGURATION_FILES, DIRECT_READING, LAST_RESTORE_TIME, OPERATION_EXPECTED, SETTING, AUTO_SLAVE_DISCOVERY, MANUAL_SLAVE_ADDRESS_BINDING, SLAVE_ADDRESS_BINDING, SLAVE_PROXY_ENABLE, LAST_NOTIFY_RECORD, ACCEPTED_MODES, ADJUST_VALUE, COUNT, COUNT_BEFORE_CHANGE, COUNT_CHANGE_TIME, COV_PERIOD, INPUT_REFERENCE, LIMIT_MONITORING_INTERVAL, LOGGING_RECORD, PRESCALE, PULSE_RATE, SCALE, SCALE_FACTOR, UPDATE_TIME, VALUE_BEFORE_CHANGE, VALUE_SET, VALUE_CHANGE_TIME, RESTART_NOTIFICATION_RECIPIENTS, TRIGGER, SUBORDINATE_ANNOTATIONS, DUTY_WINDOW, EXPECTED_SHED_LEVEL, FULL_DUTY_BASELINE, SHED_DURATION, SHED_LEVEL_DESCRIPTIONS, SHED_LEVELS, STATE_DESCRIPTION, DOOR_ALARM_STATE, DOOR_EXTENDED_PULSE_TIME, DOOR_MEMBERS, DOOR_OPEN_TOO_LONG_TIME, DOOR_PULSE_TIME, DOOR_STATUS, DOOR_UNLOCK_DELAY_TIME, LOCK_STATUS, MASKED_ALARM_VALUES, SECURED_STATUS, ABSENTEE_LIMIT, ACCESS_ALARM_EVENTS, ACCESS_DOORS, ACCESS_EVENT, ACCESS_EVENT_AUTHENTICATION_FACTOR, ACCESS_EVENT_CREDENTIAL, ACCESS_EVENT_TIME, ACCESS_TRANSACTION_EVENTS, ACCOMPANIMENT, ACCOMPANIMENT_TIME, ACTIVATION_TIME, ACTIVE_AUTHENTICATION_POLICY, ASSIGNED_ACCESS_RIGHTS, AUTHENTICATION_FACTORS, AUTHENTICATION_POLICY_LIST, AUTHENTICATION_POLICY_NAMES, AUTHENTICATION_STATUS, AUTHORIZATION_MODE, BELONGS_TO, CREDENTIAL_DISABLE, CREDENTIAL_STATUS, CREDENTIALS, CREDENTIALS_IN_ZONE, DAYS_REMAINING, ENTRY_POINTS, EXIT_POINTS, EXPIRATION_TIME, EXTENDED_TIME_ENABLE, FAILED_ATTEMPT_EVENTS, FAILED_ATTEMPTS, FAILED_ATTEMPTS_TIME, LAST_ACCESS_EVENT, LAST_ACCESS_POINT, LAST_CREDENTIAL_ADDED, LAST_CREDENTIAL_ADDED_TIME, LAST_CREDENTIAL_REMOVED, LAST_CREDENTIAL_REMOVED_TIME, LAST_USE_TIME, LOCKOUT, LOCKOUT_RELINQUISH_TIME, MAX_FAILED_ATTEMPTS, MEMBERS, MUSTER_POINT, NEGATIVE_ACCESS_RULES, NUMBER_OF_AUTHENTICATION_POLICIES, OCCUPANCY_COUNT, OCCUPANCY_COUNT_ADJUST, OCCUPANCY_COUNT_ENABLE, OCCUPANCY_LOWER_LIMIT, OCCUPANCY_LOWER_LIMIT_ENFORCED, OCCUPANCY_STATE, OCCUPANCY_UPPER_LIMIT, OCCUPANCY_UPPER_LIMIT_ENFORCED, PASSBACK_MODE, PASSBACK_TIMEOUT, POSITIVE_ACCESS_RULES, REASON_FOR_DISABLE, SUPPORTED_FORMATS, SUPPORTED_FORMAT_CLASSES, THREAT_AUTHORITY, THREAT_LEVEL, TRACE_FLAG, TRANSACTION_NOTIFICATION_CLASS, USER_EXTERNAL_IDENTIFIER, USER_INFORMATION_REFERENCE, USER_NAME, USER_TYPE, USES_REMAINING, ZONE_FROM, ZONE_TO, ACCESS_EVENT_TAG, GLOBAL_IDENTIFIER, VERIFICATION_TIME, BASE_DEVICE_SECURITY_POLICY, DISTRIBUTION_KEY_REVISION, DO_NOT_HIDE, KEY_SETS, LAST_KEY_SERVER, NETWORK_ACCESS_SECURITY_POLICIES, PACKET_REORDER_TIME, SECURITY_PDU_TIMEOUT, SECURITY_TIME_WINDOW, SUPPORTED_SECURITY_ALGORITHMS, UPDATE_KEY_SET_TIMEOUT, BACKUP_AND_RESTORE_STATE, BACKUP_PREPARATION_TIME, RESTORE_COMPLETION_TIME, RESTORE_PREPARATION_TIME, BIT_MASK, BIT_TEXT, IS_UTC, GROUP_MEMBERS, GROUP_MEMBER_NAMES, MEMBER_STATUS_FLAGS, REQUESTED_UPDATE_INTERVAL, COVU_PERIOD, COVU_RECIPIENTS, FAULT_PARAMETERS, LOCAL_FORWARDING_ONLY, PROCESS_IDENTIFIER_FILTER, SUBSCRIBED_RECIPIENTS, PORT_FILTER, AUTHORIZATION_EXEMPTIONS, ALLOW_GROUP_DELAY_INHIBIT, LAST_PRIORITY, WRITE_STATUS, SERIAL_NUMBER, BLINK_WARN_ENABLE, DEFAULT_FADE_TIME, DEFAULT_RAMP_RATE, DEFAULT_STEP_INCREMENT, EGRESS_TIME, IN_PROGRESS, INSTANTANEOUS_POWER, LIGHTING_COMMAND, LIGHTING_COMMAND_DEFAULT_PRIORITY, MAX_ACTUAL_VALUE, MIN_ACTUAL_VALUE, POWER, TRANSITION, EGRESS_ACTIVE, INTERFACE_VALUE, FAULT_HIGH_LIMIT, FAULT_LOW_LIMIT, LOW_DIFF_LIMIT, STRIKE_COUNT, TIME_OF_STRIKE_COUNT_RESET, DEFAULT_TIMEOUT, INITIAL_TIMEOUT, LAST_STATE_CHANGE, STATE_CHANGE_VALUES, TIMER_RUNNING, TIMER_STATE, APDU_LENGTH, IP_ADDRESS, IP_DEFAULT_GATEWAY, IP_DHCP_ENABLE, IP_DHCP_LEASE_TIME, IP_DHCP_LEASE_TIME_REMAINING, IP_DHCP_SERVER, IP_DNS_SERVER, BACNET_IP_GLOBAL_ADDRESS, BACNET_IP_MODE, BACNET_IP_MULTICAST_ADDRESS, BACNET_IP_NAT_TRAVERSAL, IP_SUBNET_MASK, BACNET_IP_UDP_PORT, BBMD_ACCEPT_FD_REGISTRATIONS, BBMD_BROADCAST_DISTRIBUTION_TABLE, BBMD_FOREIGN_DEVICE_TABLE, CHANGES_PENDING, COMMAND_NP, FD_BBMD_ADDRESS, FD_SUBSCRIPTION_LIFETIME, LINK_SPEED, LINK_SPEEDS, LINK_SPEED_AUTONEGOTIATE, NETWORK_INTERFACE_NAME, NETWORK_NUMBER_QUALITY, ROUTING_TABLE, VIRTUAL_MAC_ADDRESS_TABLE, IPV6_ADDRESS, IPV6_PREFIX_LENGTH, BACNET_IPV6_UDP_PORT, IPV6_DEFAULT_GATEWAY, BACNET_IPV6_MULTICAST_ADDRESS, IPV6_DNS_SERVER, IPV6_AUTO_ADDRESSING_ENABLE, IPV6_DHCP_LEASE_TIME, IPV6_DHCP_LEASE_TIME_REMAINING, IPV6_DHCP_SERVER, IPV6_ZONE_INDEX, ASSIGNED_LANDING_CALLS, CAR_ASSIGNED_DIRECTION, CAR_DOOR_COMMAND, CAR_DOOR_STATUS, CAR_DOOR_TEXT, CAR_DOOR_ZONE, CAR_DRIVE_STATUS, CAR_LOAD, CAR_LOAD_UNITS, CAR_MODE, CAR_MOVING_DIRECTION, CAR_POSITION, ELEVATOR_GROUP, ENERGY_METER, ENERGY_METER_REF, ESCALATOR_MODE, FAULT_SIGNALS, FLOOR_TEXT, GROUP_ID, GROUP_MODE, HIGHER_DECK, INSTALLATION_ID, LANDING_CALLS, LANDING_CALL_CONTROL, LANDING_DOOR_STATUS, LOWER_DECK, MACHINE_ROOM_ID, MAKING_CAR_CALL, NEXT_STOPPING_FLOOR, OPERATION_DIRECTION, PASSENGER_ALARM, POWER_MODE, REGISTERED_CAR_CALL, ACTIVE_COV_MULTIPLE_SUBSCRIPTIONS, PROTOCOL_LEVEL, REFERENCE_PORT, DEPLOYED_PROFILE_LOCATION, PROFILE_LOCATION, SUBORDINATE_NODE_TYPES, SUBORDINATE_TAGS, SUBORDINATE_RELATIONSHIPS, DEFAULT_SUBORDINATE_RELATIONSHIP, REPRESENTS, DEFAULT_PRESENT_VALUE, TARGET_REFERENCES, AUDIT_SOURCE_REPORTER, AUDIT_NOTIFICATION_RECIPIENT, AUDIT_PRIORITY_FILTER, AUDITABLE_OPERATIONS, DELETE_ON_FORWARD, MAXIMUM_SEND_DELAY, MONITORED_OBJECTS, SEND_NOW, FLOOR_NUMBER, ADDITIONAL_REFERENCE_PORTS, CERTIFICATE_SIGNING_REQUEST_FILE, COMMAND_VALIDATION_RESULT, ISSUER_CERTIFICATE_FILES, COLOR_OVERRIDE, COLOR_REFERENCE, DEFAULT_COLOR, DEFAULT_COLOR_TEMPERATURE, OVERRIDE_COLOR_REFERENCE, COLOR_COMMAND, HIGH_END_TRIM, LOW_END_TRIM, TRIM_FADE_TIME

Properties:

name: str | None: The constant’s name ("ACKED_TRANSITIONS"), or None for a value without one.

PropertyIdentifier.from_raw

@staticmethod
def from_raw(value: int) -> PropertyIdentifier

PropertyIdentifier.to_raw

def to_raw(self) -> int

ErrorClass

class ErrorClass(enum.IntEnum)

BACnet error class enumeration (Clause 18).

An enum.IntEnum (#1816): members are ints, compare equal to their numbers and hash like them, so an int works wherever a member does. A value without a name (a proprietary or unknown one) is a pseudo-member: ErrorClass(1000) and ErrorClass.from_raw(1000) both give one, equal to 1000, with name None and repr ErrorClass(1000). A number outside 0 to 65535 raises ValueError.

8 constants:

DEVICE, OBJECT, PROPERTY, RESOURCES, SECURITY, SERVICES, VT, COMMUNICATION

ErrorClass.from_raw

@classmethod
def from_raw(cls, value: int) -> ErrorClass

The member for value; a pseudo-member when it has no name.

ErrorClass.to_raw

def to_raw(self) -> int

The raw integer value.

ErrorCode

class ErrorCode(enum.IntEnum)

BACnet error code enumeration (Clause 18).

An enum.IntEnum (#1816): members are ints, compare equal to their numbers and hash like them, so an int works wherever a member does. A value without a name (a proprietary or unknown one) is a pseudo-member: ErrorCode(1000) and ErrorCode.from_raw(1000) both give one, equal to 1000, with name None and repr ErrorCode(1000). A number outside 0 to 65535 raises ValueError.

151 constants:

OTHER, AUTHENTICATION_FAILED, CONFIGURATION_IN_PROGRESS, DEVICE_BUSY, DYNAMIC_CREATION_NOT_SUPPORTED, FILE_ACCESS_DENIED, INCOMPATIBLE_SECURITY_LEVELS, INCONSISTENT_PARAMETERS, INCONSISTENT_SELECTION_CRITERION, INVALID_DATA_TYPE, INVALID_FILE_ACCESS_METHOD, INVALID_FILE_START_POSITION, INVALID_OPERATOR_NAME, INVALID_PARAMETER_DATA_TYPE, INVALID_TIME_STAMP, KEY_GENERATION_ERROR, MISSING_REQUIRED_PARAMETER, NO_OBJECTS_OF_SPECIFIED_TYPE, NO_SPACE_FOR_OBJECT, NO_SPACE_TO_ADD_LIST_ELEMENT, NO_SPACE_TO_WRITE_PROPERTY, NO_VT_SESSIONS_AVAILABLE, PROPERTY_IS_NOT_A_LIST, OBJECT_DELETION_NOT_PERMITTED, OBJECT_IDENTIFIER_ALREADY_EXISTS, OPERATIONAL_PROBLEM, PASSWORD_FAILURE, READ_ACCESS_DENIED, SECURITY_NOT_SUPPORTED, SERVICE_REQUEST_DENIED, TIMEOUT, UNKNOWN_OBJECT, UNKNOWN_PROPERTY, UNKNOWN_VT_CLASS, UNKNOWN_VT_SESSION, UNSUPPORTED_OBJECT_TYPE, VALUE_OUT_OF_RANGE, VT_SESSION_ALREADY_CLOSED, VT_SESSION_TERMINATION_FAILURE, WRITE_ACCESS_DENIED, CHARACTER_SET_NOT_SUPPORTED, INVALID_ARRAY_INDEX, COV_SUBSCRIPTION_FAILED, NOT_COV_PROPERTY, OPTIONAL_FUNCTIONALITY_NOT_SUPPORTED, INVALID_CONFIGURATION_DATA, DATATYPE_NOT_SUPPORTED, DUPLICATE_NAME, DUPLICATE_OBJECT_ID, PROPERTY_IS_NOT_AN_ARRAY, ABORT_BUFFER_OVERFLOW, ABORT_INVALID_APDU_IN_THIS_STATE, ABORT_PREEMPTED_BY_HIGHER_PRIORITY_TASK, ABORT_SEGMENTATION_NOT_SUPPORTED, ABORT_PROPRIETARY, ABORT_OTHER, INVALID_TAG, NETWORK_DOWN, REJECT_BUFFER_OVERFLOW, REJECT_INCONSISTENT_PARAMETERS, REJECT_INVALID_PARAMETER_DATA_TYPE, REJECT_INVALID_TAG, REJECT_MISSING_REQUIRED_PARAMETER, REJECT_PARAMETER_OUT_OF_RANGE, REJECT_TOO_MANY_ARGUMENTS, REJECT_UNDEFINED_ENUMERATION, REJECT_UNRECOGNIZED_SERVICE, REJECT_PROPRIETARY, REJECT_OTHER, UNKNOWN_DEVICE, UNKNOWN_ROUTE, VALUE_NOT_INITIALIZED, INVALID_EVENT_STATE, NO_ALARM_CONFIGURED, LOG_BUFFER_FULL, LOGGED_VALUE_PURGED, NO_PROPERTY_SPECIFIED, NOT_CONFIGURED_FOR_TRIGGERED_LOGGING, UNKNOWN_SUBSCRIPTION, PARAMETER_OUT_OF_RANGE, LIST_ELEMENT_NOT_FOUND, BUSY, COMMUNICATION_DISABLED, SUCCESS, ACCESS_DENIED, BAD_DESTINATION_ADDRESS, BAD_DESTINATION_DEVICE_ID, BAD_SIGNATURE, BAD_SOURCE_ADDRESS, BAD_TIMESTAMP, CANNOT_USE_KEY, CANNOT_VERIFY_MESSAGE_ID, CORRECT_KEY_REVISION, DESTINATION_DEVICE_ID_REQUIRED, DUPLICATE_MESSAGE, ENCRYPTION_NOT_CONFIGURED, ENCRYPTION_REQUIRED, INCORRECT_KEY, INVALID_KEY_DATA, KEY_UPDATE_IN_PROGRESS, MALFORMED_MESSAGE, NOT_KEY_SERVER, SECURITY_NOT_CONFIGURED, SOURCE_SECURITY_REQUIRED, TOO_MANY_KEYS, UNKNOWN_AUTHENTICATION_TYPE, UNKNOWN_KEY, UNKNOWN_KEY_REVISION, UNKNOWN_SOURCE_MESSAGE, NOT_ROUTER_TO_DNET, ROUTER_BUSY, UNKNOWN_NETWORK_MESSAGE, MESSAGE_TOO_LONG, SECURITY_ERROR, ADDRESSING_ERROR, WRITE_BDT_FAILED, READ_BDT_FAILED, REGISTER_FOREIGN_DEVICE_FAILED, READ_FDT_FAILED, DELETE_FDT_ENTRY_FAILED, DISTRIBUTE_BROADCAST_FAILED, UNKNOWN_FILE_SIZE, ABORT_APDU_TOO_LONG, ABORT_APPLICATION_EXCEEDED_REPLY_TIME, ABORT_OUT_OF_RESOURCES, ABORT_TSM_TIMEOUT, ABORT_WINDOW_SIZE_OUT_OF_RANGE, FILE_FULL, INCONSISTENT_CONFIGURATION, INCONSISTENT_OBJECT_TYPE, INTERNAL_ERROR, NOT_CONFIGURED, OUT_OF_MEMORY, VALUE_TOO_LONG, ABORT_INSUFFICIENT_SECURITY, ABORT_SECURITY_ERROR, DUPLICATE_ENTRY, INVALID_VALUE_IN_THIS_STATE, INVALID_OPERATION_IN_THIS_STATE, LIST_ITEM_NOT_NUMBERED, LIST_ITEM_NOT_TIMESTAMPED, INVALID_DATA_ENCODING, BVLC_FUNCTION_UNKNOWN, BVLC_PROPRIETARY_FUNCTION_UNKNOWN, HEADER_ENCODING_ERROR, HEADER_NOT_UNDERSTOOD, MESSAGE_INCOMPLETE, NOT_A_BACNET_SC_HUB, PAYLOAD_EXPECTED, UNEXPECTED_DATA, NODE_DUPLICATE_VMAC

ErrorCode.from_raw

@classmethod
def from_raw(cls, value: int) -> ErrorCode

The member for value; a pseudo-member when it has no name.

ErrorCode.to_raw

def to_raw(self) -> int

The raw integer value.

RejectReason

class RejectReason(enum.IntEnum)

BACnet reject reason enumeration (Clause 18.9).

An enum.IntEnum (#1816): members are ints, compare equal to their numbers and hash like them, so an int works wherever a member does. A value without a name (a proprietary or unknown one) is a pseudo-member: RejectReason(200) and RejectReason.from_raw(200) both give one, equal to 200, with name None and repr RejectReason(200). A number outside 0 to 255 raises ValueError.

11 constants:

OTHER, BUFFER_OVERFLOW, INCONSISTENT_PARAMETERS, INVALID_PARAMETER_DATA_TYPE, INVALID_TAG, MISSING_REQUIRED_PARAMETER, PARAMETER_OUT_OF_RANGE, TOO_MANY_ARGUMENTS, UNDEFINED_ENUMERATION, UNRECOGNIZED_SERVICE, INVALID_DATA_ENCODING

RejectReason.from_raw

@classmethod
def from_raw(cls, value: int) -> RejectReason

The member for value; a pseudo-member when it has no name.

RejectReason.to_raw

def to_raw(self) -> int

The raw integer value.

AbortReason

class AbortReason(enum.IntEnum)

BACnet abort reason enumeration (Clause 18.10).

An enum.IntEnum (#1816): members are ints, compare equal to their numbers and hash like them, so an int works wherever a member does. A value without a name (a proprietary or unknown one) is a pseudo-member: AbortReason(200) and AbortReason.from_raw(200) both give one, equal to 200, with name None and repr AbortReason(200). A number outside 0 to 255 raises ValueError.

12 constants:

OTHER, BUFFER_OVERFLOW, INVALID_APDU_IN_THIS_STATE, PREEMPTED_BY_HIGHER_PRIORITY_TASK, SEGMENTATION_NOT_SUPPORTED, SECURITY_ERROR, INSUFFICIENT_SECURITY, WINDOW_SIZE_OUT_OF_RANGE, APPLICATION_EXCEEDED_REPLY_TIME, OUT_OF_RESOURCES, TSM_TIMEOUT, APDU_TOO_LONG

AbortReason.from_raw

@classmethod
def from_raw(cls, value: int) -> AbortReason

The member for value; a pseudo-member when it has no name.

AbortReason.to_raw

def to_raw(self) -> int

The raw integer value.

EngineeringUnits

class EngineeringUnits(enum.IntEnum)

BACnet engineering units (Clause 21, BACnetEngineeringUnits).

An enum.IntEnum (#1816): members are ints, compare equal to their numbers and hash like them, so an int works wherever a member does. A value without a name (a proprietary or unknown one) is a pseudo-member: EngineeringUnits(1000) and EngineeringUnits.from_raw(1000) both give one, equal to 1000, with name None and repr EngineeringUnits(1000). A number outside 0 to 4294967295 raises ValueError.

269 constants:

METERS_PER_SECOND_PER_SECOND, SQUARE_METERS, SQUARE_CENTIMETERS, SQUARE_FEET, SQUARE_INCHES, CURRENCY1, CURRENCY2, CURRENCY3, CURRENCY4, CURRENCY5, CURRENCY6, CURRENCY7, CURRENCY8, CURRENCY9, CURRENCY10, MILLIAMPERES, AMPERES, AMPERES_PER_METER, AMPERES_PER_SQUARE_METER, AMPERE_SQUARE_METERS, DECIBELS, DECIBELS_MILLIVOLT, DECIBELS_VOLT, FARADS, HENRYS, OHMS, OHM_METER_SQUARED_PER_METER, OHM_METERS, MILLIOHMS, KILOHMS, MEGOHMS, MICROSIEMENS, MILLISIEMENS, SIEMENS, SIEMENS_PER_METER, TESLAS, VOLTS, MILLIVOLTS, KILOVOLTS, MEGAVOLTS, VOLT_AMPERES, KILOVOLT_AMPERES, MEGAVOLT_AMPERES, VOLT_AMPERES_REACTIVE, KILOVOLT_AMPERES_REACTIVE, MEGAVOLT_AMPERES_REACTIVE, VOLTS_PER_DEGREE_KELVIN, VOLTS_PER_METER, DEGREES_PHASE, POWER_FACTOR, WEBERS, AMPERE_SECONDS, VOLT_AMPERE_HOURS, KILOVOLT_AMPERE_HOURS, MEGAVOLT_AMPERE_HOURS, VOLT_AMPERE_HOURS_REACTIVE, KILOVOLT_AMPERE_HOURS_REACTIVE, MEGAVOLT_AMPERE_HOURS_REACTIVE, VOLT_SQUARE_HOURS, AMPERE_SQUARE_HOURS, JOULES, KILOJOULES, KILOJOULES_PER_KILOGRAM, MEGAJOULES, WATT_HOURS, KILOWATT_HOURS, MEGAWATT_HOURS, WATT_HOURS_REACTIVE, KILOWATT_HOURS_REACTIVE, MEGAWATT_HOURS_REACTIVE, BTUS, KILO_BTUS, MEGA_BTUS, THERMS, TON_HOURS, JOULES_PER_KILOGRAM_DRY_AIR, KILOJOULES_PER_KILOGRAM_DRY_AIR, MEGAJOULES_PER_KILOGRAM_DRY_AIR, BTUS_PER_POUND_DRY_AIR, BTUS_PER_POUND, JOULES_PER_DEGREE_KELVIN, KILOJOULES_PER_DEGREE_KELVIN, MEGAJOULES_PER_DEGREE_KELVIN, JOULES_PER_KILOGRAM_DEGREE_KELVIN, NEWTON, CYCLES_PER_HOUR, CYCLES_PER_MINUTE, HERTZ, KILOHERTZ, MEGAHERTZ, PER_HOUR, GRAMS_OF_WATER_PER_KILOGRAM_DRY_AIR, PERCENT_RELATIVE_HUMIDITY, MICROMETERS, MILLIMETERS, CENTIMETERS, KILOMETERS, METERS, INCHES, FEET, CANDELAS, CANDELAS_PER_SQUARE_METER, WATTS_PER_SQUARE_FOOT, WATTS_PER_SQUARE_METER, LUMENS, LUXES, FOOT_CANDLES, MILLIGRAMS, GRAMS, KILOGRAMS, POUNDS_MASS, TONS, GRAMS_PER_SECOND, GRAMS_PER_MINUTE, KILOGRAMS_PER_SECOND, KILOGRAMS_PER_MINUTE, KILOGRAMS_PER_HOUR, POUNDS_MASS_PER_SECOND, POUNDS_MASS_PER_MINUTE, POUNDS_MASS_PER_HOUR, TONS_PER_HOUR, MILLIWATTS, WATTS, KILOWATTS, MEGAWATTS, BTUS_PER_HOUR, KILO_BTUS_PER_HOUR, JOULE_PER_HOURS, HORSEPOWER, TONS_REFRIGERATION, PASCALS, HECTOPASCALS, KILOPASCALS, MILLIBARS, BARS, POUNDS_FORCE_PER_SQUARE_INCH, MILLIMETERS_OF_WATER, CENTIMETERS_OF_WATER, INCHES_OF_WATER, MILLIMETERS_OF_MERCURY, CENTIMETERS_OF_MERCURY, INCHES_OF_MERCURY, DEGREES_CELSIUS, DEGREES_KELVIN, DEGREES_KELVIN_PER_HOUR, DEGREES_KELVIN_PER_MINUTE, DEGREES_FAHRENHEIT, DEGREE_DAYS_CELSIUS, DEGREE_DAYS_FAHRENHEIT, DELTA_DEGREES_FAHRENHEIT, DELTA_DEGREES_KELVIN, YEARS, MONTHS, WEEKS, DAYS, HOURS, MINUTES, SECONDS, HUNDREDTHS_SECONDS, MILLISECONDS, NEWTON_METERS, MILLIMETERS_PER_SECOND, MILLIMETERS_PER_MINUTE, METERS_PER_SECOND, METERS_PER_MINUTE, METERS_PER_HOUR, KILOMETERS_PER_HOUR, FEET_PER_SECOND, FEET_PER_MINUTE, MILES_PER_HOUR, CUBIC_FEET, CUBIC_METERS, IMPERIAL_GALLONS, MILLILITERS, LITERS, US_GALLONS, CUBIC_FEET_PER_SECOND, CUBIC_FEET_PER_MINUTE, MILLION_STANDARD_CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_HOUR, CUBIC_FEET_PER_DAY, STANDARD_CUBIC_FEET_PER_DAY, MILLION_STANDARD_CUBIC_FEET_PER_DAY, THOUSAND_CUBIC_FEET_PER_DAY, THOUSAND_STANDARD_CUBIC_FEET_PER_DAY, POUNDS_MASS_PER_DAY, CUBIC_METERS_PER_SECOND, CUBIC_METERS_PER_MINUTE, CUBIC_METERS_PER_HOUR, CUBIC_METERS_PER_DAY, IMPERIAL_GALLONS_PER_MINUTE, MILLILITERS_PER_SECOND, LITERS_PER_SECOND, LITERS_PER_MINUTE, LITERS_PER_HOUR, US_GALLONS_PER_MINUTE, US_GALLONS_PER_HOUR, DEGREES_ANGULAR, DEGREES_CELSIUS_PER_HOUR, DEGREES_CELSIUS_PER_MINUTE, DEGREES_FAHRENHEIT_PER_HOUR, DEGREES_FAHRENHEIT_PER_MINUTE, JOULE_SECONDS, KILOGRAMS_PER_CUBIC_METER, KILOWATT_HOURS_PER_SQUARE_METER, KILOWATT_HOURS_PER_SQUARE_FOOT, WATT_HOURS_PER_CUBIC_METER, JOULES_PER_CUBIC_METER, MEGAJOULES_PER_SQUARE_METER, MEGAJOULES_PER_SQUARE_FOOT, MOLE_PERCENT, NO_UNITS, NEWTON_SECONDS, NEWTONS_PER_METER, PARTS_PER_MILLION, PARTS_PER_BILLION, PASCAL_SECONDS, PERCENT, PERCENT_OBSCURATION_PER_FOOT, PERCENT_OBSCURATION_PER_METER, PERCENT_PER_SECOND, PER_MINUTE, PER_SECOND, PSI_PER_DEGREE_FAHRENHEIT, RADIANS, RADIANS_PER_SECOND, REVOLUTIONS_PER_MINUTE, SQUARE_METERS_PER_NEWTON, WATTS_PER_METER_PER_DEGREE_KELVIN, WATTS_PER_SQUARE_METER_DEGREE_KELVIN, PER_MILLE, GRAMS_PER_GRAM, KILOGRAMS_PER_KILOGRAM, GRAMS_PER_KILOGRAM, MILLIGRAMS_PER_GRAM, MILLIGRAMS_PER_KILOGRAM, GRAMS_PER_MILLILITER, GRAMS_PER_LITER, MILLIGRAMS_PER_LITER, MICROGRAMS_PER_LITER, GRAMS_PER_CUBIC_METER, MILLIGRAMS_PER_CUBIC_METER, MICROGRAMS_PER_CUBIC_METER, NANOGRAMS_PER_CUBIC_METER, GRAMS_PER_CUBIC_CENTIMETER, BECQUERELS, KILOBECQUERELS, MEGABECQUERELS, GRAY, MILLIGRAY, MICROGRAY, SIEVERTS, MILLISIEVERTS, MICROSIEVERTS, MICROSIEVERTS_PER_HOUR, MILLIREMS, MILLIREMS_PER_HOUR, DECIBELS_A, NEPHELOMETRIC_TURBIDITY_UNIT, PH, GRAMS_PER_SQUARE_METER, MINUTES_PER_DEGREE_KELVIN, DEGREES_LOVIBOND, ALCOHOL_BY_VOLUME, INTERNATIONAL_BITTERING_UNITS, EUROPEAN_BITTERNESS_UNITS, DEGREES_PLATO, SPECIFIC_GRAVITY, EUROPEAN_BREWING_CONVENTION

EngineeringUnits.from_raw

@classmethod
def from_raw(cls, value: int) -> EngineeringUnits

The member for value; a pseudo-member when it has no name.

EngineeringUnits.to_raw

def to_raw(self) -> int

The raw integer value.

AuditOperation

BACnet audit operation.

Typed Audit request mappings accept standard values 0..15 and proprietary values 32..63. from_raw() remains a lossless enum-wrapper constructor; reserved or wider values are rejected when used in a request mapping.

16 constants:

READ, WRITE, CREATE, DELETE, LIFE_SAFETY, ACKNOWLEDGE_ALARM, DEVICE_DISABLE_COMM, DEVICE_ENABLE_COMM, DEVICE_RESET, DEVICE_BACKUP, DEVICE_RESTORE, SUBSCRIPTION, NOTIFICATION, AUDITING_FAILURE, NETWORK_CHANGES, GENERAL

Properties:

name: str | None: The constant’s name ("READ"), or None for a value without one.

AuditOperation.from_raw

@staticmethod
def from_raw(value: int) -> AuditOperation

AuditOperation.to_raw

def to_raw(self) -> int

EnableDisable

BACnet DeviceCommunicationControl enable/disable options (Clause 16.1).

3 constants:

ENABLE, DISABLE, DISABLE_INITIATION

Properties:

name: str | None: The constant’s name ("ENABLE"), or None for a value without one.

EnableDisable.from_raw

@staticmethod
def from_raw(value: int) -> EnableDisable

EnableDisable.to_raw

def to_raw(self) -> int

ReinitializedState

BACnet ReinitializeDevice state options (Clause 16.4).

8 constants:

COLDSTART, WARMSTART, START_BACKUP, END_BACKUP, START_RESTORE, END_RESTORE, ABORT_RESTORE, ACTIVATE_CHANGES

Properties:

name: str | None: The constant’s name ("COLDSTART"), or None for a value without one.

ReinitializedState.from_raw

@staticmethod
def from_raw(value: int) -> ReinitializedState

ReinitializedState.to_raw

def to_raw(self) -> int

Segmentation

BACnet segmentation support options (Clause 20.1.2.4).

4 constants:

BOTH, TRANSMIT, RECEIVE, NONE

Properties:

name: str | None: The constant’s name ("BOTH"), or None for a value without one.

Segmentation.from_raw

@staticmethod
def from_raw(value: int) -> Segmentation

Segmentation.to_raw

def to_raw(self) -> int

EventState

BACnet event state enumeration (Clause 12).

6 constants:

NORMAL, FAULT, OFFNORMAL, HIGH_LIMIT, LOW_LIMIT, LIFE_SAFETY_ALARM

Properties:

name: str | None: The constant’s name ("NORMAL"), or None for a value without one.

EventState.from_raw

@staticmethod
def from_raw(value: int) -> EventState

EventState.to_raw

def to_raw(self) -> int

AcknowledgmentFilter

GetEnrollmentSummary acknowledgment filter (Clause 13.11.1.1).

3 constants:

ALL, ACKED, NOT_ACKED

Properties:

name: str | None: The constant’s name ("ALL"), or None for a value without one.

AcknowledgmentFilter.from_raw

@staticmethod
def from_raw(value: int) -> AcknowledgmentFilter

AcknowledgmentFilter.to_raw

def to_raw(self) -> int

EnrollmentSummaryEventStateFilter

GetEnrollmentSummary event-state filter (Clause 13.11.1.1).

5 constants:

OFFNORMAL, FAULT, NORMAL, ALL, ACTIVE

Properties:

name: str | None: The constant’s name ("OFFNORMAL"), or None for a value without one.

EnrollmentSummaryEventStateFilter.from_raw

@staticmethod
def from_raw(value: int) -> EnrollmentSummaryEventStateFilter

EnrollmentSummaryEventStateFilter.to_raw

def to_raw(self) -> int

EventType

BACnet event type enumeration (Clause 12.12.6).

20 constants:

CHANGE_OF_BITSTRING, CHANGE_OF_STATE, CHANGE_OF_VALUE, COMMAND_FAILURE, FLOATING_LIMIT, OUT_OF_RANGE, CHANGE_OF_LIFE_SAFETY, EXTENDED, BUFFER_READY, UNSIGNED_RANGE, ACCESS_EVENT, DOUBLE_OUT_OF_RANGE, SIGNED_OUT_OF_RANGE, UNSIGNED_OUT_OF_RANGE, CHANGE_OF_CHARACTERSTRING, CHANGE_OF_STATUS_FLAGS, CHANGE_OF_RELIABILITY, NONE, CHANGE_OF_DISCRETE_VALUE, CHANGE_OF_TIMER

Properties:

name: str | None: The constant’s name ("CHANGE_OF_BITSTRING"), or None for a value without one.

EventType.from_raw

@staticmethod
def from_raw(value: int) -> EventType

EventType.to_raw

def to_raw(self) -> int

NotifyType

BACnetNotifyType (Clause 21): whether a transition is reported as an alarm or an event.

3 constants:

ALARM, EVENT, ACK_NOTIFICATION

Properties:

name: str | None: The constant’s name ("ALARM"), or None for a value without one.

NotifyType.from_raw

@staticmethod
def from_raw(value: int) -> NotifyType

NotifyType.to_raw

def to_raw(self) -> int

MessagePriority

BACnet text message priority (Clause 16.5).

2 constants:

NORMAL, URGENT

Properties:

name: str | None: The constant’s name ("NORMAL"), or None for a value without one.

MessagePriority.from_raw

@staticmethod
def from_raw(value: int) -> MessagePriority

MessagePriority.to_raw

def to_raw(self) -> int

VTClass

BACnet virtual terminal class for VT-Open (Clause 17.2).

7 constants:

DEFAULT_TERMINAL, ANSI_X3_64, DEC_VT52, DEC_VT100, DEC_VT220, HP_700_94, IBM_3130

Properties:

name: str | None: The constant’s name ("DEFAULT_TERMINAL"), or None for a value without one.

VTClass.from_raw

@staticmethod
def from_raw(value: int) -> VTClass

VTClass.to_raw

def to_raw(self) -> int

LifeSafetyOperation

BACnet life safety operation codes (Clause 12.15.13, Table 12-54).

10 constants:

NONE, SILENCE, SILENCE_AUDIBLE, SILENCE_VISUAL, RESET, RESET_ALARM, RESET_FAULT, UNSILENCE, UNSILENCE_AUDIBLE, UNSILENCE_VISUAL

Properties:

name: str | None: The constant’s name ("NONE"), or None for a value without one.

LifeSafetyOperation.from_raw

@staticmethod
def from_raw(value: int) -> LifeSafetyOperation

LifeSafetyOperation.to_raw

def to_raw(self) -> int

Release v0.15.0 ·Build and integrate. Pre-1.0 APIs; partial conformance.Support & limitations