Python reference

The Python reference lists the rusty_bacnet module as its type stub, rusty_bacnet.pyi, describes it: classes, methods, signatures with their keyword defaults, and docstrings. The stub ships in the wheel, so an editor shows the same signatures. Async methods return native awaitables; await them on a running asyncio loop. Each group below has its own page.

On dev after the release

These pages are generated from the type stub on the dev branch and track the next release, so they can list classes, methods and keywords merged after v0.15.0 that the released wheel doesn’t have. The v0.15.0 release notes and the changes waiting for the next release say what changed.

Signatures and short contracts are here. Lifecycle, cancellation and error contracts that are too long for a docstring are in the Python API guide. For tasks, start with Read with Python or the local lab.

website/scripts/reference-python.py writes the group pages and the list below from the stub; edit the stub, not the pages.

Client

The client, its options and what its methods return.

BACnetClient, ScReconnect, ScCertificateMetadata, ScSubjectAltName, ScInspectionFinding, ScExtensionInspection, ScInspectedCertificate, ScKeyFilePermissions, ScPemInspection, ScPeerCertificate, ScUntrustedPeerInfo, ScPeerInfo, ScEvent, ScLinkStatus, ScEventIterator, _DeviceReadBatchResult, _DeviceRpmBatchResult, _DeviceWriteBatchResult

Server

The server, its policies and counters, and the BACnet/SC hub.

BACnetServer, ScHub, ReinitializeRequest, MutationContext, ScHubCertificateBinding, CovCounters, CovPolicy, TimeSyncPolicy, ForwarderSaveCounters, EventNotificationCounters, DccOutcomeCounters, ScNpduDropCounts, RequestAdmissionCounters, ScHubOutcomeCounts, ScHubStatus, ReinitializeHandler, AfterReinitialize, MutationHandler

Router

Owned B/IP routing between numbered networks.

BACnetRouter, BipRouterPort, RouterPortInfo, RouterRoute, RouterCleanupFailure

Shared endpoints

One transport that runs both the client and server roles.

BipEndpoint, ScEndpoint, MstpEndpoint, EndpointClient, EndpointServer, EndpointStatus, ReadRangeResult, LogGap, LogPage, ReadPropertyResult, ReadAccessResult, ReferenceTime, LogCursor

Types and values

Identifiers, property values, structured values and B/IP modes.

ObjectIdentifier, BACnetTimeStamp, BitString, PropertyValue, DiscoveredDevice, CovNotification, CovNotificationIterator, IHave, IHaveIterator, DiscoveredRouter, NetworkReport, NetworkReportIterator, ForeignDevice, Bbmd, Multicast, UNSPECIFIED, ActionCommand, DeviceObjectPropertyReference, AccessRule, AssignedAccessRights, AccessRulePosition, UnresolvedAccessRights, AccessRightsEvaluation, NameValue, CalendarDate, CalendarDateRange, CalendarWeekNDay, SpecialEvent, AuditReporterConfiguration, AuditRecipientDevice, AuditRecipientAddress, Destination, AuditPropertyReference, AuditNotificationInput, AuditNotificationRequestInput, AuditLogQueryByTargetInput, AuditLogQueryBySourceInput, AuditLogQueryRequestInput, AuditPropertyReferenceResult, AuditNotification, AtomicReadFileStreamResult, AtomicReadFileRecordResult, AtomicWriteFileStreamResult, AtomicWriteFileRecordResult, AuditLogStatusDatum, AuditNotificationDatum, AuditTimeChangeDatum, AuditLogRecord, AuditLogRecordResult, AuditLogQueryAck, ForeignRegistrationStatus, FdtEntry, AuthenticationPolicy, BACnetDate, BACnetTime, TimeValue, CalendarEntry, AuditRecipientInput, AuditLogQueryParametersInput, BACnetDateTime, AtomicReadFileResult, AtomicWriteFileResult, AuditLogDatum

Enumerations

Named BACnet constants. Each also takes vendor or unknown values from their number.

ObjectType, PropertyIdentifier, ErrorClass, ErrorCode, RejectReason, AbortReason, EngineeringUnits, AuditOperation, EnableDisable, ReinitializedState, Segmentation, EventState, AcknowledgmentFilter, EnrollmentSummaryEventStateFilter, EventType, NotifyType, MessagePriority, VTClass, LifeSafetyOperation

Errors

The exceptions methods raise.

BacnetError, BacnetProtocolError, BacnetTimeoutError, BacnetRejectError, BacnetAbortError, BacnetLogNotAdvancingError, BacnetReadRangeViolationError, BacnetBvlcNakError, BacnetBvlcUnexpectedResponseError, BacnetTransportError, BacnetRouterCloseError, ObjectPropertyReference

Module functions

Functions at the top of the rusty_bacnet module.

enum_name, decode_log_records, list_serial_ports, refresh_logging, inspect_sc_pem, inspect_sc_pem_files