Skip to content

Havne v0.6.0

Choose a tag to compare

@github-actions github-actions released this 07 Nov 21:59
· 1054 commits to main since this release
623e795

Havne 0.6.0 is for people who script and share: everything it reads reaches havne-cli and Python as well as the app, a recording goes out as a scrubbed pcapng, CSV or folder copy with the car's identity left out and checked, a car's health is one file to hand to a shop or a buyer, and a simulated car answers as an ELM327 adapter so other tools read it with no car. Read DISCLAIMER.md before connecting it to a vehicle.

Downloads

For Download
Windows (x64) havne-0.6.0-windows-x64.zip
Linux (x86_64), the app havne-0.6.0-linux-x86_64.AppImage
Linux (64-bit ARM: a Raspberry Pi 3 or later), the app havne-0.6.0-linux-aarch64.AppImage
Android 12 or later (64-bit ARM) havne-0.6.0-android-arm64-v8a.apk
Linux (x86_64): havne-cli and core alone, for your own programs havne-core_0.6.0_amd64.deb (Debian, Ubuntu) or havne-core-0.6.0-linux-x86_64.tar.gz
Linux (64-bit ARM): havne-cli and core alone havne-core_0.6.0_arm64.deb (Raspberry Pi OS, Debian, Ubuntu) or havne-core-0.6.0-linux-aarch64.tar.gz
Python wheel (Windows x64, Linux x86_64 and arm64, macOS arm64 13+) pip install havne-0.6.0-py3-none-<platform>.whl; Python 3.11 or later

The other files under Assets check a download or debug one: SHA256SUMS.txt, the build provenance (.intoto.jsonl) and the SBOM (.spdx.json), described below under Verifying the downloads; the Windows PDBs (-symbols.zip) and havne-cli's Linux debug info (-dbgsym deb, -debug tarball). GitHub adds the source code archives.

Try it

Windows

  1. Download havne-0.6.0-windows-x64.zip and unzip the whole folder.
  2. Run havne.exe. The program isn't code-signed, so SmartScreen may stop it the first time: choose More info, then Run anyway.
  3. In Settings, tick Developer mode under Display, then press the mock://demo preset under Adapter and Connect.

The zip's README.txt covers adapters and what each file is. havne-cli.exe is beside havne.exe: havne-cli stream mock://demo --values --count 20 prints a simulated car's frames and values.

Linux (x86_64 or 64-bit ARM, glibc 2.39 or later: Ubuntu 24.04 and newer, Debian 13 and Raspberry Pi OS 13, Fedora 40 and newer, Arch)

  1. Download havne-0.6.0-linux-x86_64.AppImage, or on 64-bit ARM (a Raspberry Pi 3 or later on a 64-bit system) havne-0.6.0-linux-aarch64.AppImage.
  2. chmod +x it, then run it.
  3. In Settings, tick Developer mode under Display, then press the mock://demo preset under Adapter and Connect.

It takes OpenGL, fonts and FUSE from the system; a minimal install may lack them. docs/linux.md says what to install, how to reach an adapter (serial permissions, Bluetooth, SocketCAN) and where Havne keeps its files.

For havne-cli and the core alone: sudo apt install ./havne-core_0.6.0_amd64.deb (./havne-core_0.6.0_arm64.deb on ARM), or unpack havne-core-0.6.0-linux-x86_64.tar.gz (havne-core-0.6.0-linux-aarch64.tar.gz) anywhere.

Android 12 or later (64-bit ARM)

  1. On the phone, download havne-0.6.0-android-arm64-v8a.apk and open it. Android asks to let your browser or file manager install apps the first time; Play Protect may offer to scan an app from outside Google Play.
  2. Open Havne. In Settings, tick Developer mode under Display, then press the mock://demo preset under Adapter and Connect.

A later release installs over this one and keeps its settings and recordings. A Havne built by CI or from source carries another key, so uninstall it first.

What's new since 0.5.1

Python

  • The havne package: sessions on every transport, their frames and decoded values read as iterators, recordings, the simulated ECU, a script's own signals and a plugin's variants, over core's shared library through ctypes, with no compiler at install time (ADR-0053).
  • A wheel for each platform: Windows x64, Linux x86_64 and 64-bit ARM, and macOS on Apple silicon (13 or later), with core's library inside (and on Windows the J2534 helpers), for Python 3.11 or later: pip install havne-0.6.0-py3-none-<platform>.whl.
  • Examples you can run with no car (python/examples/): read_pids.py on any session, did_scan.py listing the identifiers an ECU answers, isotp_fuzz.py sending malformed ISO-TP exchanges to the simulated ECU on a Linux virtual CAN bus (and refusing any real interface), and a notebook predicting fuel cut from a synthetic recording.

Sharing a recording, scrubbed

  • havne-cli export writes a recording as pcapng for Wireshark (its ISO-TP reassembled by Wireshark's own dissector), as CSV of its values for a spreadsheet, pandas or R, or as a copy of its folder that Havne opens, views and replays like the original.
  • Scrubbed unless --raw: identification replies (Service 09, the F180-F1FF DIDs) on any CAN ID and in either addressing layout, and text signals, are left out and counted; then every message, segments joined on any ID, and the file itself are searched for the car's identity values and anything shaped like a VIN, and a match writes nothing. A failed export leaves nothing behind (ADR-0054).
  • The Log page's frame table (developer mode) filters by ID, bytes, direction and flag, lists one row per ID with its rate, and Export CSV writes what it shows through the same scrub.

A car's health in one file

  • havne-cli health, and Save report on Diagnostics and in the log viewer, write the vehicle from its VIN (never the VIN itself), the emissions inspection's verdict, each ECU's readiness, trouble codes with titles, freeze frame, the values since the codes were cleared and the key values, as JSON or text, from a live session (reads only) or a recording, checked for the car's identity before it's written.

Imports and a baseline

  • havne-cli import candump reads a candump -L log into a recording; havne-cli import csv reads another logger's CSV by a column map. Both open in the viewer and through replay://, and Python has both.
  • A vehicle's baseline recording: kept from the Recordings page, it overlays a new run lined up on their engine starts, and havne-cli view --align-on engine-start does the same.

The simulated car, as an adapter

  • havne-cli sim <uri> --elm327 tcp:<port> serves the simulated car as an ELM327 adapter on a TCP port: Havne's own elm327://127.0.0.1:<port>, python-OBD and ELM327 apps that take a WiFi adapter's address read it (ADR-0055).

More

  • havne-cli clear <uri> --yes clears trouble codes from a script through the app's own gate (engine stopped unless you say otherwise), reporting what each ECU did.
  • The viewer and havne-cli view --frames decode a recording's frames through a profile, so a raw recording has values to plot. Settings imports an OBDb signal set for a vehicle. JSON Schemas for signal files and plugins let an editor check a file as you write it.

For programs that use core

  • Core builds as a shared library (ecuio.dll, libecuio.so, libecuio.dylib) exporting the C API and nothing else, with ecuio_version; the pull queue (ecuio/queue.h) reads a session's frames or values from a thread of your own. The C ABI grows append-only (a minor release, ADR-0048).

Fixes

  • havne-cli exits with a failure when its output can't be written; a value that isn't a number is recorded readably on every platform; a packed Service 01 reply gives each text-decoded PID its value; signals import obdb writes through a file of its own. The full list is in the CHANGELOG.

What's verified, and where

Havne's claims are tiered (docs/testing.md):

  • Every build runs the full test suite on Windows, macOS and Linux in CI, plus sanitizers, fuzzing (the exports and the health report among the harnesses), clang-tidy, CodeQL and the load test; a GCC or Clang warning fails it. On Windows the suite is 1607 cases, all passing but six that need the cross-arch step, the car's raw recordings, Linux or Wireshark's tshark, and the cross-arch cases pass through the x86 helper too. The Python package's tests run in each CI job against that job's own core, and each wheel is installed into a fresh environment and runs read_pids.py before the release publishes it.
  • The scrub against real recordings: scrubbed pcapng, CSV and folder exports of every archived real-car, bench and phone recording (159) hold none of their cars' identity values, searched whole and in pieces, as bytes and as hex; over the 245 recordings on hand, the scrub refuses none.
  • Other tools: Wireshark's tshark reads an export and reassembles its ISO-TP; python-OBD reads the simulated car through the ELM327 emulator on Windows; the Python package reads SocketCAN on a virtual bus and the ELM327 emulator.
  • Not yet run: this release's new features against a real car or adapter (each run so far is the simulated car's or a recording's); an export or a health report saved on the phone; the iPhone app on a device. This build itself hasn't connected to an adapter or a car.

Verifying the downloads

SHA256SUMS.txt holds every download's SHA-256, the debug files' and the SBOM's. One signed build provenance from this repository's release workflow covers every download, attached as havne-0.6.0.intoto.jsonl. Check them with the GitHub CLI:

sha256sum -c --ignore-missing SHA256SUMS.txt
gh attestation verify havne-0.6.0-windows-x64.zip -R erickramer42/havne
gh attestation verify havne-0.6.0-android-arm64-v8a.apk -R erickramer42/havne
gh attestation verify havne-0.6.0-linux-x86_64.AppImage -R erickramer42/havne
gh attestation verify havne-core_0.6.0_amd64.deb -R erickramer42/havne
gh attestation verify havne-0.6.0-py3-none-win_amd64.whl -R erickramer42/havne

Those read GitHub's attestation store; add --bundle havne-0.6.0.intoto.jsonl to check against the attached file instead.

The SBOM, havne-0.6.0.spdx.json, is attested to the zip, the APK, the AppImages, the debs, the tarballs and the wheels: add --predicate-type https://spdx.dev/Document/v2.3 to check it.

The APK is signed with Havne's release key, whose certificate SHA-256 is fb4f415a1f6c0dc56ee54dcd454c29d2226bc293c7b4c978a9b9bc8e74c4210f (packaging/android/release-cert.sha256). With the Android SDK's build tools, apksigner verify --print-certs havne-0.6.0-android-arm64-v8a.apk prints it.

Third-party data

Havne's core carries data from others, each under its own terms, listed in core/THIRD_PARTY_NOTICES.txt, which the Windows zip and core's packages ship, and compiled into every binary:

  • Trouble-code titles: SAE J2012's generic powertrain and network codes, from Wal33D/dtc-database (MIT).
  • Vehicle makes: the manufacturer codes of NHTSA's vPIC, a work of the US government.