API reference
For a general library overview, read Architecture. Navigation resources:
pycyphal root module
Submodule import policy
The following submodules are auto-imported when the root module pycyphal
is imported:
pycyphal.transport
, but not concrete transport implementation submodules.
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, seepycyphal.application.make_node()
.
Submodules
- pycyphal.dsdl package
- pycyphal.application package
- pycyphal.presentation package
- pycyphal.transport package
- Subpackages
- 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