Docs / Reference
Formats, limitations and troubleshooting
Supported formats
| Input | Trace | Adapter / Compare |
|---|---|---|
MCAP file (.mcap) | Yes | Yes — one file per run |
| rosbag2 with MCAP storage | Yes — pass the .mcap file | Yes — pass the .mcap file inside the bag directory |
rosbag2 with SQLite storage (.db3) | No | No |
| ROS 1 bag, other formats | No | No |
Timing is read from each message's recorded log time.
Current limitations
- Latency between clocks is not assessed. Timing comes from recorded log time, so delays between different clocks or machines are out of scope.
- Same-type sensor swaps cannot be prepared yet. If one sensor was removed and a different sensor of the same message type was added, mark the pair
"same_stream": false; the kit stops without producing a file. - Stream identity relies on topic names. A stream is compared across runs when it keeps its topic name or you confirm the pairing. A topic whose name stayed the same but whose meaning changed cannot be detected.
- Only complete common one-second buckets are compared. Messages after the last complete common bucket are listed under “What was not compared”.
- Compare is a Private Beta. Access is set up with each team; there is no self-service sign-up or online checkout.
- Validated environments. Trace: Ubuntu 24.04, Python 3.12. Adapter Kit: Python 3.12 or 3.13.
Troubleshooting
Error: Mapping profile could not be registered: … must contain at least one CanonicalMappingRule
No stream has labels. Set canonical_subsystem_id and canonical_category_id for at least one stream in mapping.json.
Error: Mapping profile rule #N is invalid: canonical_subsystem_id must be a non-empty string …
Set both labels for that rule, or leave both null. Remove leading or trailing spaces.
Error: These Reference/Target streams were paired without an identical, unique topic name …
A pairing in correspondence_review is unanswered, or your mapping.json predates the section. Set "same_stream": true only for pairs that really are the same stream, or re-run velune mapping init. Confirm stream pairings
Error: You marked these pairs as different streams …
This kit cannot compare the two runs (see limitations). No file was produced. Contact [email protected].
Error: Reference MCAP not found: …
Check the path. Pass the Reference file first and the Target file second, the same way for mapping init and prepare.
velune: command not found
Activate the virtual environment where you installed the kit (source .venv/bin/activate).
“Velune Adapter — preparation incomplete”
The file was written but its preview was not. Do not upload it until you can review the preview; run prepare again.
The Compare page rejects the upload
See the upload error codes.
Your browser keeps asking for a password
Compare uses the Beta username and password sent to you. If you do not have them, request access.
Versions
| Component | Version |
|---|---|
| VeluneOS Compare service | 1.0.1 · report schema 0.5.0 |
| Adapter Beta Kit | 0.1.1b5 (Velune Adapter 0.2.0) · SHA-256 |
| Velune Trace | Release v0.5.1 · main branch v0.5.2 |