Skip to content

Latest commit

 

History

History
94 lines (74 loc) · 7.76 KB

REPOS.md

File metadata and controls

94 lines (74 loc) · 7.76 KB

Repository Reference

REPOS.md says what each WLAN Pi repository should be. When a repository differs, that is drift to fix in that repository, or a deliberate change to the standard here.

Current versions are in each repo's debian/changelog and on its GitHub Releases page, https://github.com/WLAN-Pi/<repo>/releases.

Standards

An application deploy workflow should call the shared workflows in gh-workflows: sbuild-pkg, sbuild-deploy-pkg, and tag-release.

CI builds and tests Debian Trixie packages, plus compiler builds and tests.

A debian/changelog push to main uploads to Packagecloud wlanpi/dev. Promotion to wlanpi/main is done by hand. An upload to wlanpi/main when the release pull request merges, and an automatic tag, are planned. See What Is Live.

pi-gen and wlanpi-kernel follow their own release rules. See Scope.

Applications

Repository Purpose Default branch Package Note
scandump Scans for Wi-Fi networks with the 802.11 netlink API and writes PCAP main scandump Fork of intuitibits/scandump. Version as <upstream>+wlanpi<N>.
wlanpi-bluetooth Enables Bluetooth management access to the WLAN Pi main wlanpi-bluetooth
wlanpi-common Common scripts and files for WLAN Pi RPi and CM4 hardware main wlanpi-common
wlanpi-core Shares data between core services and applications on the WLAN Pi main wlanpi-core Repo-specific build and test rules belong in this repo's own AGENTS.md.
wlanpi-ctx Wi-Fi continuous transmitter testing tool main wlanpi-ctx
wlanpi-desktop Desktop environment configuration for WLAN Pi main wlanpi-desktop Optional apt package. The full image doesn't include it.
wlanpi-fpms Front Panel Menu System for WLAN Pi RPi and CM4 hardware main wlanpi-fpms
wlanpi-grafana Grafana dashboards main wlanpi-grafana
wlanpi-hotspot Hotspot mode for the WLAN Pi RPi/CM4 hardware main wlanpi-hotspot
wlanpi-hwtest Drives a suite of tests for diagnostic health of WLAN Pi Pro hardware main wlanpi-hwtest
wlanpi-librespeed-cli librespeed-cli tool packaged by the WLAN Pi team main wlanpi-librespeed-cli
wlanpi-mcp On-device MCP server for the WLAN Pi main wlanpi-mcp
wlanpi-misc-firmware Packages miscellaneous firmware files, such as MediaTek main wlanpi-misc-firmware
wlanpi-persistent-identity Prevents "host identification changed" SSH warnings across A/B partition switches main wlanpi-persistent-identity
wlanpi-profiler Wi-Fi client capabilities analyzer for the WLAN Pi main wlanpi-profiler
wlanpi-shell-config Shell configuration and environment defaults for WLAN Pi main wlanpi-shell-config
wlanpi-usb-ethernet Debian package that installs the USB ethernet gadget main wlanpi-usb-ethernet
wlanpi-webui Web app for the WLAN Pi main wlanpi-webui
wlanpi-wipry Dumps spectral data from an Oscium WiPry Clarity spectrum analyzer main wlanpi-wipry

Platform and build

Repository Purpose Default branch Package Note
wlanpi-kernel Syncs and builds the kernel for WLAN Pi 7.3-trixie wlanpi-kernel, wlanpi-kernel-headers Own release rules. See Scope.
wlanpi-misc-packages Packages miscellaneous binaries, such as iwlwifi and iw main hostapd, iperf, iperf3, iw, wavemon, wlanpi-linux-firmware, wpasupplicant
pi-gen WLAN Pi OS image build tool for RPi based hardware trixie64 none (OS image) Fork of RPi-Distro/pi-gen. Own release rules. New image work belongs here.

WLAN Pi Go is BE200-only. It ships every iwlwifi-gl-c0-fm-c0-* ucode file plus pnvm, and no wpa_supplicant. The user can set the regulatory domain.

Tooling

Repository Purpose Default branch Package Note
developers Guidance for WLAN Pi developers including style guides, architecture, git, testing, and more main none This repository.
gh-workflows Reusable workflows for GitHub Actions used by WLAN Pi CI main none Application deploys should call sbuild-pkg, sbuild-deploy-pkg, and tag-release.
sbuild-debian-package Builds a Debian package using sbuild main none Fork of danielmundi/sbuild-debian-package.
.github Community health files for the WLAN-Pi org main none

Legacy

pi-gen-bookworm builds the WLAN Pi image using Debian Bookworm. Default branch bookworm. New image work belongs in pi-gen.

Legacy candidates

Repository Default branch Note
feedback main Public feedback discussions for WLAN Pi, our software, and more
experimental main
drivers main Drivers that can be used for the WLAN Pi such as RNDIS
neo2 master WLAN Pi release repository
build main Image build tool for WLAN Pi NEO2 hardware running Armbian. Fork of danielmundi/build.
armbian-build wlanpi-neo2-6e Armbian Linux build framework. Fork of adriangranados/build.
rpi-linux rpi-5.14.y Kernel source tree for Raspberry Pi Foundation-provided kernel builds. Fork of raspberrypi/linux.
pidcodes.github.com master Website for pid.codes. Fork of pidcodes/pidcodes.github.com.

Retired

wlanpi-bridge, wlanpi-server, wlanpi-wconsole, and wlanpi-chat-bot are archived.