API reference

For a general library overview, read Architecture. Navigation resources:

• Index

• Module Index

• Search Page

pycyphal root module

Submodule import policy

The following submodules are auto-imported when the root module pycyphal is imported:

• pycyphal.dsdl

• pycyphal.transport, but not concrete transport implementation submodules.

• pycyphal.presentation

• pycyphal.util

Submodule pycyphal.application is not auto-imported because in order to have it imported the DSDL-generated package uavcan containing the standard data types must be compiled first.

Log level override

The environment variable PYCYPHAL_LOGLEVEL can be set to one of the following values to override the library log level:

• CRITICAL

• FATAL

• ERROR

• WARNING

• INFO

• DEBUG

pycyphal.CYPHAL_SPECIFICATION_VERSION = (1, 0)

Version of the Cyphal protocol implemented by this library, major and minor. The corresponding field in uavcan.node.GetInfo.Response is initialized from this value, see pycyphal.application.make_node().

Submodules

• pycyphal.dsdl package
  • Module contents
    • compile()
    • compile_all()
    • GeneratedPackageInfo
    • add_import_hook()
    • remove_import_hooks()
    • serialize()
    • deserialize()
    • get_model()
    • get_class()
    • get_extent_bytes()
    • get_fixed_port_id()
    • get_attribute()
    • set_attribute()
    • is_serializable()
    • is_message_type()
    • is_service_type()
    • to_builtin()
    • update_from_builtin()
    • generate_package()
    • install_import_hook()
• pycyphal.application package
  • Subpackages
    • pycyphal.application.register package
  • Submodules
    • pycyphal.application.diagnostic module
    • pycyphal.application.file module
    • pycyphal.application.heartbeat_publisher module
    • pycyphal.application.node_tracker module
    • pycyphal.application.plug_and_play module
  • Module contents
    • Application layer overview
    • Node class
    • Application-layer function implementations
    • Node
    • NodeInfo
    • PortNotConfiguredError
    • make_node()
    • make_transport()
    • make_registry()
    • NetworkTimeoutError
• pycyphal.presentation package
  • Subpackages
    • pycyphal.presentation.subscription_synchronizer package
  • Module contents
    • Presentation layer overview
    • Usage example
    • Presentation
    • Publisher
    • Subscriber
    • Client
    • Server
    • SubscriberStatistics
    • ClientStatistics
    • ServerStatistics
    • ServiceRequestMetadata
    • Port
    • MessagePort
    • ServicePort
    • OutgoingTransferIDCounter
    • PortClosedError
    • RequestTransferIDVariabilityExhaustedError
• pycyphal.transport package
  • Subpackages
    • pycyphal.transport.can package
    • pycyphal.transport.commons package
    • pycyphal.transport.loopback package
    • pycyphal.transport.redundant package
    • pycyphal.transport.serial package
    • pycyphal.transport.udp package
  • Module contents
    • Abstract transport model
    • Sessions
    • Sniffing/snooping and tracing
    • Implementing new transports
    • Class inheritance diagram
    • Transport
    • ProtocolParameters
    • TransportStatistics
    • Transfer
    • TransferFrom
    • Priority
    • DataSpecifier
    • MessageDataSpecifier
    • ServiceDataSpecifier
    • SessionSpecifier
    • InputSessionSpecifier
    • OutputSessionSpecifier
    • Session
    • InputSession
    • OutputSession
    • PayloadMetadata
    • SessionStatistics
    • Feedback
    • Timestamp
    • TransportError
    • UnsupportedSessionConfigurationError
    • OperationNotDefinedForAnonymousNodeError
    • InvalidTransportConfigurationError
    • InvalidMediaConfigurationError
    • ResourceClosedError
    • Capture
    • AlienSessionSpecifier
    • AlienTransferMetadata
    • AlienTransfer
    • Trace
    • ErrorTrace
    • TransferTrace
    • Tracer
• pycyphal.util package
  • Submodules
    • pycyphal.util.error_reporting module
  • Module contents
    • set_internal_error_handler()
    • broadcast()
    • import_submodules()
    • iter_descendants()
    • mark_last()
    • repr_attributes()
    • repr_attributes_noexcept()