feat: add etc config to control GPIO pin layout

Author: DASPRiD

Cargo.toml

@@ -35,11 +35,16 @@ strip = "debuginfo"
 
 [package.metadata.deb]
 depends = "libnfc6, adduser, bloop-box-data, systemd"
-conf-files = ["/usr/local/etc/rpi0wcar.json", "/etc/systemd/system/rpi0wcar.service"]
+conf-files = ["/etc/bloop-box.conf"]
 maintainer-scripts = "debian/"
 systemd-units = { enable = true }
 extended-description = """\
 Bloop Box client for sending bloops to a server.\
 """
 section = "games"
 priority = "optional"
+assets = [
+    ["target/arm-unknown-linux-gnueabihf/release/bloop-box", "usr/bin/", "755"],
+    ["README.md", "usr/share/doc/bloop-box/", "644"],
+    ["etc/bloop-box.conf", "etc/", "644"]
+]

README.md

@@ -62,6 +62,12 @@ chown bloop-box:nogroup /var/lib/bloop-box
 
 On a development system, you might want to give the bloop-box user a login shell and a home directory.
 
+#### Hardware config
+
+In order to configure the Bloop Box for your specific hardware, you need to copy the `etc/bloop-box.conf` file to via
+SSH to `/etc/bloop-box`. If you are using our open hardware motherboard, you can leave all values in it as is, otherwise
+you need to adjust it to match your hardware.
+
 #### Systemd
 
 To have the bloop box automatically start when the system boots, create a systemd file in

etc/bloop-box.conf

@@ -0,0 +1,22 @@
+# Bloop Box Cinfiguration
+#
+# The configuration file is a TOML file. It consists of a sequence of key-value pairs, each on its own line. Strings are
+# to be enclosed in double quotes. Lists of values can be given by enclosing a comma-separated sequence of these values
+# in square brackets.
+#
+# See https://github.com/toml-lang/toml for detailed information on the format.
+#
+# This file contains all configuration settings with explanations and their default values.
+
+# GPIO pins
+#
+# Pins for connected devices. All pins are addressed via their BCM number.
+[gpio]
+# Volume control
+#volume-down-button = 24
+#volume-up-button = 23
+
+# Status RGB LED
+#red-led = 16
+#green-led = 20
+#blue-led = 26

semantic-release-build.sh

@@ -6,3 +6,26 @@ cargo install cross cargo-deb
 sed -i '/\[package\]/,/^version = "[^"]*"$/ s/^version = "[^"]*"$/version = "'"$VERSION"'"/' Cargo.toml
 cross build --target arm-unknown-linux-gnueabihf --release
 cargo-deb -v --no-build --target arm-unknown-linux-gnueabihf --no-strip
+
+# This is workaround for https://github.com/kornelski/cargo-deb/issues/47
+# Patch the generated DEB to have ./ paths compatible with `unattended-upgrade`:
+pushd target/arm-unknown-linux-gnueabihf/debian || exit 1
+DEB_FILE_NAME=$(ls -1 *.deb | head -n 1)
+DATA_ARCHIVE=$(ar t "${DEB_FILE_NAME}"| grep -E '^data\.tar')
+ar x "${DEB_FILE_NAME}" "${DATA_ARCHIVE}"
+tar tf "${DATA_ARCHIVE}"
+
+if [[ "${DATA_ARCHIVE}" == *.xz ]]; then
+  # Install XZ support that will be needed by TAR
+  apt-get -y install -y xz-utils
+  EXTRA_TAR_ARGS=J
+fi
+
+mkdir tar-hack
+tar -C tar-hack -xf "${DATA_ARCHIVE}"
+pushd tar-hack || exit 1
+tar c${EXTRA_TAR_ARGS}f "../${DATA_ARCHIVE}" ./*
+popd || exit 1
+tar tf "${DATA_ARCHIVE}"
+ar r "${DEB_FILE_NAME}" "${DATA_ARCHIVE}"
+popd || exit 1

src/etc_config.rs

@@ -0,0 +1,47 @@
+use anyhow::Result;
+use serde::Deserialize;
+use tokio::fs::File;
+use tokio::io::AsyncReadExt;
+
+fn default_volume_down_button() -> u8 {
+    24
+}
+fn default_volume_up_button() -> u8 {
+    23
+}
+fn default_red_led() -> u8 {
+    16
+}
+fn default_green_led() -> u8 {
+    20
+}
+fn default_blue_led() -> u8 {
+    26
+}
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct GpioConfig {
+    #[serde(default = "default_volume_down_button")]
+    pub volume_down_button: u8,
+    #[serde(default = "default_volume_up_button")]
+    pub volume_up_button: u8,
+    #[serde(default = "default_red_led")]
+    pub red_led: u8,
+    #[serde(default = "default_green_led")]
+    pub green_led: u8,
+    #[serde(default = "default_blue_led")]
+    pub blue_led: u8,
+}
+
+#[derive(Clone, Deserialize)]
+pub struct EtcConfig {
+    pub gpio: GpioConfig,
+}
+
+pub async fn load_etc_config() -> Result<EtcConfig> {
+    let mut file = File::open("/etc/bloop-box.conf").await?;
+    let mut toml_config = String::new();
+    file.read_to_string(&mut toml_config).await?;
+    let config: EtcConfig = toml::from_str(&toml_config)?;
+    Ok(config)
+}

src/main.rs

@@ -2,6 +2,7 @@ extern crate core;
 
 use std::path::Path;
 
+use crate::etc_config::load_etc_config;
 use anyhow::Result;
 use env_logger::{Builder, Env};
 use tokio::fs;
@@ -16,6 +17,7 @@ use crate::subsystems::led::Led;
 use crate::subsystems::networker::Networker;
 use crate::subsystems::volume_control::VolumeControl;
 
+mod etc_config;
 mod nfc;
 mod subsystems;
 mod wifi;
@@ -24,6 +26,7 @@ mod wifi;
 async fn main() -> Result<()> {
     Builder::from_env(Env::default().default_filter_or("debug")).init();
 
+    let etc_config = load_etc_config().await?;
     let share_dir = Path::new("/usr/share/bloop-box");
     let data_dir = Path::new("/var/lib/bloop-box");
     let cache_dir = Path::new(&data_dir).join("cache");
@@ -39,7 +42,7 @@ async fn main() -> Result<()> {
     let (networker_status_tx, networker_status_rx) = mpsc::channel(8);
 
     Toplevel::new()
-        .start("Led", Led::new(led_rx).into_subsystem())
+        .start("Led", Led::new(etc_config.clone(), led_rx).into_subsystem())
         .start(
             "ConfigManager",
             ConfigManager::new(data_dir, config_rx).into_subsystem(),
@@ -56,7 +59,7 @@ async fn main() -> Result<()> {
         )
         .start(
             "VolumeControl",
-            VolumeControl::new(audio_player_tx.clone()).into_subsystem(),
+            VolumeControl::new(etc_config, audio_player_tx.clone()).into_subsystem(),
         )
         .start(
             "Networker",

src/subsystems/led.rs

@@ -1,3 +1,4 @@
+use crate::etc_config::EtcConfig;
 use anyhow::{Error, Result};
 use log::info;
 use rppal::gpio::{Gpio, Level, OutputPin};
@@ -21,12 +22,13 @@ pub enum LedState {
 }
 
 pub struct Led {
+    etc_config: EtcConfig,
     rx: mpsc::Receiver<LedState>,
 }
 
 impl Led {
-    pub fn new(rx: mpsc::Receiver<LedState>) -> Self {
-        Self { rx }
+    pub fn new(etc_config: EtcConfig, rx: mpsc::Receiver<LedState>) -> Self {
+        Self { etc_config, rx }
     }
 
     async fn process(
@@ -89,7 +91,7 @@ impl IntoSubsystem<Error> for Led {
 
         subsys.start(
             "InternalLed",
-            InternalLed::new(internal_rx).into_subsystem(),
+            InternalLed::new(self.etc_config.clone(), internal_rx).into_subsystem(),
         );
 
         tokio::select! {
@@ -104,6 +106,7 @@ impl IntoSubsystem<Error> for Led {
 }
 
 struct InternalLed {
+    etc_config: EtcConfig,
     rx: mpsc::Receiver<InternalLedState>,
 }
 
@@ -113,13 +116,9 @@ enum InternalLedState {
     Off,
 }
 
-const GPIO_RED: u8 = 16;
-const GPIO_GREEN: u8 = 20;
-const GPIO_BLUE: u8 = 26;
-
 impl InternalLed {
-    pub fn new(rx: mpsc::Receiver<InternalLedState>) -> Self {
-        Self { rx }
+    pub fn new(etc_config: EtcConfig, rx: mpsc::Receiver<InternalLedState>) -> Self {
+        Self { etc_config, rx }
     }
 
     async fn process(
@@ -151,9 +150,9 @@ impl InternalLed {
 impl IntoSubsystem<Error> for InternalLed {
     async fn run(mut self, subsys: SubsystemHandle) -> Result<()> {
         let gpio = Gpio::new()?;
-        let mut red_pin = gpio.get(GPIO_RED)?.into_output_low();
-        let mut green_pin = gpio.get(GPIO_GREEN)?.into_output_low();
-        let mut blue_pin = gpio.get(GPIO_BLUE)?.into_output_low();
+        let mut red_pin = gpio.get(self.etc_config.gpio.red_led)?.into_output_low();
+        let mut green_pin = gpio.get(self.etc_config.gpio.green_led)?.into_output_low();
+        let mut blue_pin = gpio.get(self.etc_config.gpio.blue_led)?.into_output_low();
 
         tokio::select! {
             _ = subsys.on_shutdown_requested() => {

src/subsystems/volume_control.rs

@@ -1,3 +1,4 @@
+use crate::etc_config::EtcConfig;
 use anyhow::{Error, Result};
 use log::info;
 use rppal::gpio::Gpio;
@@ -9,15 +10,16 @@ use crate::subsystems::audio_player::PlayerCommand;
 use crate::subsystems::button::Button;
 
 pub struct VolumeControl {
+    etc_config: EtcConfig,
     audio_player: mpsc::Sender<PlayerCommand>,
 }
 
-const GPIO_VOLUME_DOWN: u8 = 23;
-const GPIO_VOLUME_UP: u8 = 24;
-
 impl VolumeControl {
-    pub fn new(audio_player: mpsc::Sender<PlayerCommand>) -> Self {
-        Self { audio_player }
+    pub fn new(etc_config: EtcConfig, audio_player: mpsc::Sender<PlayerCommand>) -> Self {
+        Self {
+            etc_config,
+            audio_player,
+        }
     }
 
     async fn process(&mut self, mut button_rx: mpsc::Receiver<f32>) -> Result<()> {
@@ -46,8 +48,8 @@ impl IntoSubsystem<Error> for VolumeControl {
     async fn run(mut self, subsys: SubsystemHandle) -> Result<()> {
         let gpio = Gpio::new()?;
         let (button_tx, button_rx) = mpsc::channel::<f32>(1);
-        let volume_down_pin = gpio.get(GPIO_VOLUME_DOWN)?;
-        let volume_up_pin = gpio.get(GPIO_VOLUME_UP)?;
+        let volume_down_pin = gpio.get(self.etc_config.gpio.volume_down_button)?;
+        let volume_up_pin = gpio.get(self.etc_config.gpio.volume_up_button)?;
 
         subsys.start(
             "VolumeDownButton",