Skip to content

README.md

Latest commit

 

History

History
185 lines (125 loc) · 6.82 KB

README.md

File metadata and controls

185 lines (125 loc) · 6.82 KB

LIVI

LIVI – Linux In-Vehicle Infotainment

LIVI is an open-source Apple CarPlay and Android Auto head unit for Linux.

It is a standalone cross-platform Electron head unit with hardware-accelerated video decoding, low-latency audio, multitouch + D-Pad navigation, and support for very small embedded/OEM displays.

LIVI supports native Android Auto on Linux. For CarPlay, a dongle with an MFi chip is currently required.

Supported USB adapters: Carlinkit CPC200-CCPA (wireless/wired) and CPC200-CCPW (wired)

Project Status

Release Main Version TS Main Build Main Coverage Main Coverage Renderer

Installation

Important

LIVI requires WebGL2 or WebGPU support.

Raspberry Pi OS

curl -fL -o install.sh https://raw.githubusercontent.com/f-io/LIVI/main/scripts/install/pi/install.sh
chmod +x install.sh
./install.sh

Raspberry Pi OS Trixie or newer is required for WebGL2 support.

The install.sh script performs the following tasks:

  1. checks for required tools: curl and xdg-user-dir
  2. configures udev rules to ensure proper access rights for the CarPlay dongle
  3. downloads the latest LIVI AppImage
  4. creates an autostart entry so the application launches automatically on boot
  5. creates a desktop shortcut for easy access

This install script is not actively tested on other Linux distributions.

Linux (x86_64)

This AppImage has been tested on Debian Trixie (13) with Wayland, Ubuntu/Kubuntu 25 and Fedora 44. No additional software is required, just download the -x86_64.AppImage and make it executable:

chmod +x LIVI-*-x86_64.AppImage

On first launch, LIVI will detect if the udev rule for the USB dongle is missing and prompt you to install it automatically.

Ubuntu / Kubuntu users: Due to AppArmor restrictions, use the .deb package instead of the AppImage. The .deb automatically configures all required permissions. Alternatively, the AppImage can be started with --no-sandbox as a workaround.

Mac (arm64)

Download the -arm64.dmg, open it, and drag LIVI.app into Applications.

When launching the app for the first time, macOS may block it. In that case:

  1. Try to open the app once (it will be blocked)
  2. Go to System Settings → Privacy & Security
  3. Scroll down and click “Open Anyway”
  4. Confirm the dialog

After this, the app will launch normally and future updates will work without additional steps.

Windows (x64)

Important

The Windows build is provided on a best-effort basis. Windows is not a primary target platform of this project and receives limited testing.

It is mainly intended for development, experimentation, and desktop testing.

USB Driver Requirement

The Carlinkit dongle requires a compatible WinUSB (winusb.sys) driver on Windows. You can install it using a tool such as Zadig (libwdi): https://github.com/pbatard/libwdi/releases

Steps:

  1. Plug in the Carlinkit dongle
  2. Start Zadig
  3. Select the dongle from the device list
  4. Install the WinUSB (winusb.sys) driver

Build Environment

Node pnpm electron chrome release gstreamer

System Requirements (build)

Make sure the following packages and tools are installed on your system before building:

  • Python 3.x (for native module builds via node-gyp)
  • build-essential (Linux: includes gcc, g++, make, etc.)
  • libusb-1.0-0-dev (required for node-usb)
  • libudev-dev (optional but recommended for USB detection on Linux)
  • fuse (required to run AppImages)

Clone & Build

git clone --branch main --single-branch https://github.com/f-io/LIVI.git \
  && cd LIVI \
  && corepack enable \
  && corepack install

# Install dependencies from lockfile
pnpm run install:ci

# --- Build targets ---

# Linux x86_64 (AppImage)
pnpm run build:linux

# Linux ARM64 (AppImage)
pnpm run build:armLinux

# macOS (arm64 dmg)
pnpm run build:mac

Dashboard

The Dashboard is currently in an early stage. While the IPC/socket telemetry payload already supports many signals, the UI exposes only a small subset. Widgets and layouts will be extended over time.

Telemetry Simulator (local)

To feed demo telemetry into the app, you can run the simulator from scripts/tools:

pnpm -C scripts/tools install
pnpm -C scripts/tools run telemetry:cycle

Dashboard

Images

CarPlay   Android Auto

Media   Settings

Maps (Cluster Stream)   Telemetry

Credits

See CREDITS for acknowledgements and prior art.

Disclaimer

Apple and CarPlay are trademarks of Apple Inc. Android and Android Auto are trademarks of Google LLC. This project is not affiliated with or endorsed by Apple or Google. All product names, logos, and brands are the property of their respective owners.

License

This project is licensed under the MIT License.