Reference¶
- Scripting API: the Python API of simulation scripts.
- Test API: the Python API of test scripts.
- QML panel API: the
panelobject of QML panels. - Supported interfaces: every CAN interface with its hardware, platforms, driver and CAN FD support.
- Command line: options and settings of
canexplorer,can-test,can-serverand thecan-db-convertconverter. - File formats: supported log files and databases and their details.
- Keyboard shortcuts
- Links: related documentation and specifications.
Stability and versioning¶
CANExplorer follows semantic versioning from version 1.0.0 on. Within a major version (1.x), the following stays compatible: scripts, files and commands written for 1.0 keep working with every later 1.x release. New features may be added; changes that break them only come with 2.0, after being deprecated (with a warning) in a 1.x release.
| Public interface | Covered |
|---|---|
| Simulation scripts | The names exported by can_explorer.scripting (its __all__), as documented in the scripting API |
| Test scripts | The names exported by can_explorer.testing (its __all__), as documented in the test API |
| QML panels | The panel object, as documented in the panel API |
| Command line | The commands canexplorer, can-test, can-server and can-db-convert with their documented options and exit codes |
| Files | Workspaces (.cxw): files of 1.0 open in every 1.x version (they carry a format version; a newer file is refused with a message rather than misread). Test reports in JUnit XML |
| Network | The can-server protocol: clients and servers of the same major version work together |
| python-can | The interface name canexplorer_remote (class RemoteBus) and its channel syntax |
Everything else is internal and may change in any release, in particular the other modules of can_explorer
(can_explorer.core, can_explorer.gui, …) even where they are importable, the layout of the HTML test report,
the application's settings storage and the user interface itself.