Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# Library API

The main objects are the `Bus` and the `Message`. A form of CAN interface is also required.

Hint

Check the backend specific documentation for any implementation specific details.

- Bus
  - Transmitting
  - Receiving
  - Filtering
  - Bus API
  - Thread safe bus
- Message
  - `Message`
- Notifier and Listeners
  - Notifier
  - Listener
  - BufferedReader
  - RedirectReader
- File IO
  - Reading and Writing Files
  - Printer
  - CSVWriter
  - SqliteWriter
  - ASC (.asc Logging format)
  - Log (.log can-utils Logging format)
  - BLF (Binary Logging Format)
  - MF4 (Measurement Data Format v4)
  - TRC
  - Rotating Loggers
  - Replaying Files
- Asyncio support
  - Example
- Broadcast Manager
  - Message Sending Tasks
- Error Handling
  - `CanError`
  - `CanInitializationError`
  - `CanInterfaceNotImplementedError`
  - `CanOperationError`
  - `CanTimeoutError`
  - `error_check()`
- Bit Timing Configuration
  - `BitTiming`
  - `BitTimingFd`
- Utilities
  - `detect_available_configs()`
- Internal API
  - BusABC
  - Extending the `BusABC` class
  - About the IO module
  - Other Utilities