Build deb on bookworm debian 12; minor improvements

Author: seriyps

.github/workflows/build.yml

@@ -25,7 +25,9 @@ jobs:
           sudo apt-get install -y qemu-user-static
 
       - name: Build
-        run: make qemu_build
+        run: |
+          make qemu_build
+          rm -f disk.raw  # for some reason reusing the disc causes `pgpconf` to hang
 
       - name: Build deb package
         run: make qemu_build_deb

Makefile

@@ -1,9 +1,6 @@
-# https://cloud.debian.org/images/cloud/bullseye/latest/debian-11-generic-arm64.tar.xz
-# https://github.com/OpenIPC/sbc-groundstations/releases/download/zero3w-v1.7.0/radxaZero3wrev2.img.xz
-
-DEBIAN_HOST=https://cloud.debian.org/images/cloud/bullseye
+DEBIAN_HOST=https://cloud.debian.org/images/cloud/bookworm
 DEBIAN_RELEASE=latest
-DEBIAN_SYSTEM=debian-11-generic-arm64.tar
+DEBIAN_SYSTEM=debian-12-generic-arm64.tar
 OUTPUT=output
 DEB_VERSION=1.3.0
 
@@ -19,30 +16,48 @@ disk.raw: $(DEBIAN_SYSTEM).xz
 	touch disk.raw
 
 .PHONY: qemu_build
-qemu_build: disk.raw
+qemu_build:
 	mkdir -p $(OUTPUT)
-	sudo mount `sudo losetup -P --show -f disk.raw`p1 $(OUTPUT)
-	sudo mkdir -p $(OUTPUT)/usr/src/PixelPilot_rk
-	sudo mount -o bind `pwd` $(OUTPUT)/usr/src/PixelPilot_rk
+	make mount
 
-	#sudo cp -r build.sh run.sh CMakeLists.txt pixelpilot_config.h.in src lvgl lv_conf.h $(OUTPUT)/home
 	sudo rm $(OUTPUT)/etc/resolv.conf
 	echo nameserver 1.1.1.1 | sudo tee -a $(OUTPUT)/etc/resolv.conf
-	sudo chroot $(OUTPUT) /usr/src/PixelPilot_rk/tools/container_build.sh --wipe-boot
+	LC_ALL=en_US.UTF-8 sudo chroot $(OUTPUT) /usr/src/PixelPilot_rk/tools/container_build.sh --wipe-boot --build-type bin
 	sudo chroot $(OUTPUT) /usr/src/PixelPilot_rk/tools/container_run.sh --version
 	sudo cp $(OUTPUT)/usr/src/PixelPilot_rk/build/pixelpilot .
-	sudo umount $(OUTPUT)/usr/src/PixelPilot_rk
-	sudo umount $(OUTPUT)
+	make umount
 
--PHONY: qemu_build_deb
-qemu_build_deb: disk.raw
+.PHONY: qemu_build_deb
+qemu_build_deb:
 	mkdir -p $(OUTPUT)
+	make mount
+
+	sudo rm $(OUTPUT)/etc/resolv.conf
+	echo nameserver 1.1.1.1 | sudo tee -a $(OUTPUT)/etc/resolv.conf
+	LC_ALL=en_US.UTF-8 sudo chroot $(OUTPUT) /usr/src/PixelPilot_rk/tools/container_build.sh --wipe-boot --pkg-version $(DEB_VERSION) --build-type deb
+	make umount
+
+.PHONY: mount
+mount: disk.raw
 	sudo mount `sudo losetup -P --show -f disk.raw`p1 $(OUTPUT)
 	sudo mkdir -p $(OUTPUT)/usr/src/PixelPilot_rk
 	sudo mount -o bind `pwd` $(OUTPUT)/usr/src/PixelPilot_rk
+	mkdir .apt_cache || true
+	sudo mount -o bind .apt_cache/ $(OUTPUT)/var/cache/apt
 
-	sudo rm $(OUTPUT)/etc/resolv.conf
-	echo nameserver 1.1.1.1 | sudo tee -a $(OUTPUT)/etc/resolv.conf
-	sudo chroot $(OUTPUT) /usr/src/PixelPilot_rk/tools/container_build_deb.sh --wipe-boot --pkg-version $(DEB_VERSION)
+.PHONY: umount
+umount:
+	sudo umount $(OUTPUT)/var/cache/apt
 	sudo umount $(OUTPUT)/usr/src/PixelPilot_rk
 	sudo umount $(OUTPUT)
+	sudo losetup --detach `losetup | grep disk.raw | cut -f 1 -d " "`
+
+.PHONY: clean
+clean:
+	rm -f pixelpilot-rk-dbgsym_$(DEB_VERSION)*.deb
+	rm -f pixelpilot-rk_$(DEB_VERSION)*.buildinfo pixelpilot-rk_$(DEB_VERSION)*.changes pixelpilot-rk_$(DEB_VERSION)*.deb pixelpilot-rk_*.orig.tar.gz
+	rm -rf pixelpilot-rk_$(DEB_VERSION)/
+	rm -rf output
+	rm -rf build
+	rm -rf .apt_cache
+	rm -f disk.raw

README.md

@@ -13,11 +13,47 @@ This project is based on a unique frozen development [FPVue_rk](https://github.c
 
 Tested on RK3566 (Radxa Zero 3W) and RK3588s (Orange Pi 5).
 
-## Compilation
+## Installation
+
+It can be installed as a binary DEB package or built from source.
+
+### DEB package
+
+Currently we have packages for Debian Bookworm (12).
+First you need to add a repository that contains `wfb-ng` dependency
+
+```
+curl -s https://apt.wfb-ng.org/public.asc | sudo gpg --dearmor --yes -o /usr/share/keyrings/wfb-ng.gpg
+echo "deb [signed-by=/usr/share/keyrings/wfb-ng.gpg] https://apt.wfb-ng.org/ $(lsb_release -cs) master" | sudo tee /etc/apt/sources.list.d/wfb-ng.list
+sudo apt update
+```
+Also make sure Radxa's repositories are enabled
+
+```
+$ ls /etc/apt/sources.list.d/*radxa*.list
+/etc/apt/sources.list.d/70-radxa.list  /etc/apt/sources.list.d/80-radxa-rk3566.list
+$ cat /etc/apt/sources.list.d/*radxa*.list
+deb [signed-by="/usr/share/keyrings/radxa-archive-keyring.gpg"] https://radxa-repo.github.io/bookworm bookworm main
+deb [signed-by="/usr/share/keyrings/radxa-archive-keyring.gpg"] https://radxa-repo.github.io/rk3566-bookworm rk3566-bookworm main
+```
+
+Then download the latest `.deb` package from "releases" section on Github and install it:
+
+```
+sudo apt install ./pixelpilot-rk_*_arm64.deb
+```
+
+Configuration files are:
+
+* `/etc/pixelpilot/pixelpilot.yaml` - GPIO settings etc
+* `/etc/pixelpilot/osd_config.json` - OSD configuration
+* `/etc/default/pixelpilot` - systemd overrides / command line parameters
+
+### Build from source
 
 Build on the Rockchip linux system directly.
 
-## Install dependencies
+#### Install dependencies
 
 - drm, cairo, mpp, logging, json, msgpack, gpiod, yaml-cpp
 
@@ -31,7 +67,7 @@ sudo apt install libdrm-dev libcairo-dev librockchip-mpp-dev libspdlog-dev nlohm
 sudo apt install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev
 ```
 
-## Build Instructions
+#### Build Instructions
 
 Build and run application in production environment:
 
@@ -63,6 +99,27 @@ Build and run gsmenu SDL simulator locally
 Simulator has w,a,s,d,Enter input.
 Press t to toggle drone detection.
 
+### Build from source for arm64
+
+To build it on a non-ARM host machine, it is possible to build with QEMU emulator.
+
+```
+sudo apt-get install qemu-user-static
+```
+and then either build the binary:
+
+```
+make qemu_build
+ls -l pixelpilot
+```
+
+or build .deb package:
+
+```
+make qemu_build_deb
+ls -l pixelpilot-rk_*.deb
+```
+
 ## Usage
 
 Show command line options:
@@ -73,7 +130,7 @@ pixelpilot --help
 ### OSD config
 
 OSD is set-up declaratively in `/etc/pixelpilot/config_osd.json` file (or whatever is set via `--osd-config`
-command line key.
+command line key).
 
 OSD is described as an array of widgets which may subscribe to fact updates (they receive each fact
 update they subscribe to) and those widgets are periodically rendered on the screen (in the order they
@@ -285,7 +342,8 @@ Pixelpilot starts several threads:
 
 ## Release
 
-* update project version in `CMakeList.txt`, `project(pixelpilot, VERSION <X.Y.Z>)`, commit
+* update project version in `CMakeList.txt`: `project(pixelpilot, VERSION <X.Y.Z>)`, in
+  `Makefile`: `DEB_VERSION`, and update `debian/changelog` (with `dch -v <X.Y.Z>`). Commit
 * push that commit to master (either directly or with PR)
 * tag the tip of the master branch with the same `<X.Y.Z>` version
-* run `git push --tags`; it will publish a new GitHub release
+* run `git push --tags`; it will trigger a build job that would publish a new GitHub release

debian/pixelpilot-rk.pixelpilot.service

@@ -1,16 +1,17 @@
 [Unit]
 Description="OpenIPC Pixelpilot Server"
-StartLimitInterval=10s
-StartLimitBurst=2
 Requires=wifibroadcast.service
 After=wifibroadcast.service
 
 [Service]
 Type=simple
 EnvironmentFile=/etc/default/pixelpilot
-ExecStart=/usr/bin/pixelpilot --osd --osd-custom-message --osd-config $OSD_PATH --screen-mode $SCREEN_MODE --dvr-framerate $DVR_FPS --dvr-fmp4 --dvr-sequenced-files --dvr-template $DVR_PATH/$DVR_TEMPLATE --config $CONFIG $EXTRA_OPTS
+ExecStart=/usr/bin/pixelpilot --osd --osd-custom-message --osd-config ${OSD_PATH} --screen-mode ${SCREEN_MODE} --dvr-framerate ${DVR_FPS} --dvr-fmp4 --dvr-sequenced-files --dvr-template ${DVR_PATH}/${DVR_TEMPLATE} --config ${CONFIG} $EXTRA_OPTS
 Restart=always
+# Sleep between 3 and 10 seconds between restart attempts; it will keep restarting forever
 RestartSec=3
+RestartSteps=5
+RestartMaxDelaySec=10
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=multi-user.target