edit ids that are already mapped

closes #18

.gitignore

@@ -1 +1,2 @@
 /target
+/build

Makefile

@@ -0,0 +1,61 @@
+PACKAGE_NAME := fwa
+VERSION := 1.0
+ARCH := armhf
+BUILD_DIR := build
+DEB_DIR := $(BUILD_DIR)/$(PACKAGE_NAME)-$(VERSION)
+BIN_DIR := $(DEB_DIR)/usr/local/bin
+SERVICE_DIR := $(DEB_DIR)/lib/systemd/system
+CONFIG_DIR := $(DEB_DIR)/etc
+PM3_DIR := $(DEB_DIR)/usr/share/pm3
+
+.PHONY: all build clean package prepare_package
+	
+all: package
+
+build: $(BUILD_DIR)/fwa 
+
+$(BUILD_DIR)/fwa: web/dist
+	cross build --release --target arm-unknown-linux-gnueabihf
+	cp ./target/arm-unknown-linux-gnueabihf/release/fw-anwesenheit $@
+
+prepare_package: $(DEB_DIR)/DEBIAN $(BIN_DIR)/fwa
+	mkdir -p $(SERVICE_DIR)
+	cp ./service/fwa.service $(SERVICE_DIR)/
+	cp ./service/fwa-fail.service $(SERVICE_DIR)/
+
+	mkdir -p $(CONFIG_DIR)
+	cp ./service/fwa.env $(CONFIG_DIR)/
+
+	mkdir -p $(PM3_DIR)
+	cp -r ./pre-compiled/* $(PM3_DIR)/
+
+	mkdir -p $(DEB_DIR)/var/lib/fwa/
+
+$(BIN_DIR)/fwa: $(BUILD_DIR)/fwa
+	mkdir -p $(BIN_DIR)
+	cp $< $@
+
+
+$(DEB_DIR)/DEBIAN:
+	mkdir -p $(DEB_DIR)/DEBIAN
+	echo "Package: $(PACKAGE_NAME)" > $(DEB_DIR)/DEBIAN/control
+	echo "Version: $(VERSION)" >> $(DEB_DIR)/DEBIAN/control
+	echo "Section: utils" >> $(DEB_DIR)/DEBIAN/control
+	echo "Priority: optional" >> $(DEB_DIR)/DEBIAN/control
+	echo "Architecture: $(ARCH)" >> $(DEB_DIR)/DEBIAN/control
+	echo "Depends: libc6 (>= 2.28)" >> $(DEB_DIR)/DEBIAN/control
+	echo "Maintainer: Niklas Kapelle <niklas@kapelle.org>" >> $(DEB_DIR)/DEBIAN/control
+	echo "Description: Feuerwehr anwesenheit" >> $(DEB_DIR)/DEBIAN/control
+
+	echo "/etc/fwa.env" > $(DEB_DIR)/DEBIAN/conffiles
+
+web/dist:
+	(cd web && npm run build)
+
+package: prepare_package
+	dpkg-deb --build $(DEB_DIR)
+
+clean:
+	cargo clean
+	rm -rf web/dist
+	rm -rf $(BUILD_DIR)

README.md

@@ -9,6 +9,10 @@ I²C fpr RTC `sudo raspi-config` -> interface -> enable I²C
 
 # Config 
 
+Flags:
+
+`--error` or `-e`: Enters error state. The LED turns red and the hotspot is activated. This state gets called from systemd if the service is in a failure state.
+
 Environment variables:
 
 - `PM3_BIN`: Path to the pm3 binary. Seach in path if not set. Can also be set to the `pm3_mock.sh` for testing.
@@ -18,3 +22,11 @@ Environment variables:
 - `HOTSPOT_SSID`: Set the hotspot ssid. Defaults to "fwa".
 - `HOTSPOT_PW`: Set the hotspot password. Default to "a9LG2kUVrsRRVUo1". Recommended to change.
 
+Systemd:
+
+The service is run as a systemd service. There are two service `fwa.service` and `fwa-fail.service`. They read their config 
+from a env file located at `/etc/fwa.env`. See example [env file](service/fwa.env).
+
+# Building
+
+Run `make package` to create `.deb` file. [Cross](https://github.com/cross-rs/cross) is used for building the rust code.

service/fwa-fail.service

@@ -0,0 +1,19 @@
+[Unit]
+Description=Failure state for fwa.service
+Requires=local-fs.target
+After=local-fs.target
+StartLimitIntervalSec=500
+StartLimitBurst=5
+
+[Service]
+Type=simple
+ExecStart=/usr/local/bin/fwa --error
+Restart=on-failure
+RestartSec=5
+User=root
+Group=root
+WorkingDirectory=/var/lib/fwa
+EnvironmentFile=/etc/fwa.env
+
+[Install]
+WantedBy=multi-user.target

service/fwa.env

@@ -0,0 +1,5 @@
+PM3_BIN=/usr/share/pm3/pm3
+LOG_LEVEL=warn
+HOTSPOT_IDS=578B5DF2;c1532b57
+HOTSPOT_SSID=fwa
+HOTSPOT_PW=a9LG2kUVrsRRVUo1

service/fwa.service

@@ -4,6 +4,7 @@ Requires=local-fs.target
 After=local-fs.target
 StartLimitIntervalSec=500
 StartLimitBurst=5
+OnFailure= fwa-fail.service
 
 [Service]
 Type=simple
@@ -13,12 +14,7 @@ RestartSec=5
 User=root
 Group=root
 WorkingDirectory=/var/lib/fwa
-
+EnvironmentFile=/etc/fwa.env
-Environment="PM3_BIN=/usr/local/bin/pm3/pm3"
-#Environment="LOG_LEVEL=warn"
-#Environment="HOTSPOT_IDS=578B5DF2;c1532b57"
-#Environment="HOTSPOT_SSID=fwa"
-#Environment="HOTSPOT_PW=a9LG2kUVrsRRVUo1"
 
 [Install]
 WantedBy=multi-user.target

src/feedback.rs

@@ -8,14 +8,30 @@ use tokio::{join, time::sleep};
 use crate::hardware::{Buzzer, StatusLed};
 
 #[cfg(not(feature = "mock_pi"))]
-use crate::{gpio_buzzer::GPIOBuzzer, spi_led::SpiLed};
+use crate::{hardware::GPIOBuzzer, hardware::SpiLed};
 
 #[cfg(feature = "mock_pi")]
-use crate::mock::{MockBuzzer, MockLed};
+use crate::hardware::{MockBuzzer, MockLed};
 
 const LED_BLINK_DURATION: Duration = Duration::from_secs(1);
 
+pub enum DeviceStatus {
+    NotReady,
+    Ready,
+    HotspotEnabled,
+}
+
+impl DeviceStatus {
+    pub fn color(&self) -> RGB8 {
+        match self {
+            Self::NotReady => RGB8::new(0, 0, 0),
+            Self::Ready => RGB8::new(0, 50, 0),
+            Self::HotspotEnabled => RGB8::new(0, 0, 50),
+        }
+    }
+}
 pub struct Feedback<B: Buzzer, L: StatusLed> {
+    device_status: DeviceStatus,
     buzzer: B,
     led: L,
 }
@@ -23,29 +39,70 @@ pub struct Feedback<B: Buzzer, L: StatusLed> {
 impl<B: Buzzer, L: StatusLed> Feedback<B, L> {
     pub async fn success(&mut self) {
         let buzzer_handle = Self::beep_ack(&mut self.buzzer);
-        let led_handle = Self::blink_led_for_duration(&mut self.led, GREEN, LED_BLINK_DURATION);
+        let led_handle = Self::flash_led_for_duration(&mut self.led, GREEN, LED_BLINK_DURATION);
         let (buzzer_result, _) = join!(buzzer_handle, led_handle);
 
         buzzer_result.unwrap_or_else(|err| {
             error!("Failed to buzz: {err}");
         });
+
+        let _ = self.led_to_status();
     }
 
     pub async fn failure(&mut self) {
         let buzzer_handle = Self::beep_nak(&mut self.buzzer);
-        let led_handle = Self::blink_led_for_duration(&mut self.led, RED, LED_BLINK_DURATION);
+        let led_handle = Self::flash_led_for_duration(&mut self.led, RED, LED_BLINK_DURATION);
 
         let (buzzer_result, _) = join!(buzzer_handle, led_handle);
 
         buzzer_result.unwrap_or_else(|err| {
             error!("Failed to buzz: {err}");
         });
+
+        let _ = self.led_to_status();
     }
 
-    async fn blink_led_for_duration(led: &mut L, color: RGB8, duration: Duration) -> Result<()> {
+    pub async fn activate_error_state(&mut self) -> Result<()> {
+        self.led.turn_on(RED)?;
+        Self::beep_nak(&mut self.buzzer).await?;
+        Ok(())
+    }
+
+    pub async fn startup(&mut self){
+        self.device_status = DeviceStatus::Ready;
+
+        let led_handle = Self::flash_led_for_duration(&mut self.led, GREEN, Duration::from_secs(1));
+        let buzzer_handle = Self::beep_startup(&mut self.buzzer);
+
+        let (buzzer_result, led_result) = join!(buzzer_handle, led_handle);
+
+        buzzer_result.unwrap_or_else(|err| {
+            error!("Failed to buzz: {err}");
+        });
+
+        led_result.unwrap_or_else(|err| {
+            error!("Failed to blink led: {err}");
+        });
+
+        let _ = self.led_to_status();
+    }
+
+    pub fn set_device_status(&mut self, status: DeviceStatus){
+        self.device_status = status;
+        let _ = self.led_to_status();
+    }
+
+    fn led_to_status(&mut self) -> Result<()> {
+        self.led.turn_on(self.device_status.color())
+    }
+
+    async fn flash_led_for_duration(led: &mut L, color: RGB8, duration: Duration) -> Result<()> {
         led.turn_on(color)?;
+
         sleep(duration).await;
+
         led.turn_off()?;
+
         Ok(())
     }
 
@@ -70,6 +127,31 @@ impl<B: Buzzer, L: StatusLed> Feedback<B, L> {
             .await?;
         Ok(())
     }
+
+    async fn beep_startup(buzzer: &mut B) -> Result<()> {
+        buzzer
+            .modulated_tone(523.0, Duration::from_millis(150))
+            .await?;
+        buzzer
+            .modulated_tone(659.0, Duration::from_millis(150))
+            .await?;
+        buzzer
+            .modulated_tone(784.0, Duration::from_millis(150))
+            .await?;
+        buzzer
+            .modulated_tone(1046.0, Duration::from_millis(200))
+            .await?;
+
+        sleep(Duration::from_millis(100)).await;
+
+        buzzer
+            .modulated_tone(784.0, Duration::from_millis(100))
+            .await?;
+        buzzer
+            .modulated_tone(880.0, Duration::from_millis(200))
+            .await?;
+        Ok(())
+    }
 }
 
 #[cfg(feature = "mock_pi")]
@@ -82,6 +164,7 @@ impl FeedbackImpl {
         #[cfg(feature = "mock_pi")]
         {
             Ok(Feedback {
+                device_status: DeviceStatus::NotReady,
                 buzzer: MockBuzzer {},
                 led: MockLed {},
             })
@@ -89,6 +172,7 @@ impl FeedbackImpl {
         #[cfg(not(feature = "mock_pi"))]
         {
             Ok(Feedback {
+                device_status: DeviceStatus::NotReady,
                 buzzer: GPIOBuzzer::new_default()?,
                 led: SpiLed::new()?,
             })

src/hardware/mod.rs

@@ -1,11 +1,14 @@
 use anyhow::Result;
 use std::time::Duration;
 
-#[cfg(feature = "mock_pi")]
+mod gpio_buzzer;
-use crate::mock::MockHotspot;
+mod hotspot;
+mod mock;
+mod spi_led;
 
-#[cfg(not(feature = "mock_pi"))]
+pub use gpio_buzzer::GPIOBuzzer;
-use crate::hotspot::NMHotspot;
+pub use mock::{MockBuzzer, MockHotspot, MockLed};
+pub use spi_led::SpiLed;
 
 pub trait StatusLed {
     fn turn_off(&mut self) -> Result<()>;
@@ -32,11 +35,11 @@ pub trait Hotspot {
 pub fn create_hotspot() -> Result<impl Hotspot> {
     #[cfg(feature = "mock_pi")]
     {
-        Ok(MockHotspot {})
+        Ok(mock::MockHotspot {})
     }
 
     #[cfg(not(feature = "mock_pi"))]
     {
-        NMHotspot::new_from_env()
+        hotspot::NMHotspot::new_from_env()
     }
 }

src/main.rs

@@ -1,15 +1,17 @@
 #![allow(dead_code)]
 
-use activity_fairing::{ActivityNotifier, spawn_idle_watcher};
+use anyhow::Result;
 use feedback::{Feedback, FeedbackImpl};
-use hardware::{Hotspot, create_hotspot};
-use id_store::IDStore;
 use log::{error, info, warn};
-use pm3::run_pm3;
+use std::{
-use std::{env, sync::Arc, time::Duration};
+    env::{self, args},
+    sync::Arc,
+    time::Duration,
+};
 use tally_id::TallyID;
 use tokio::{
     fs,
+    signal::unix::{SignalKind, signal},
     sync::{
         Mutex,
         broadcast::{self, Receiver, Sender},
@@ -17,22 +19,16 @@ use tokio::{
     try_join,
 };
 use webserver::start_webserver;
-use anyhow::Result;
 
-mod activity_fairing;
+use crate::{hardware::{create_hotspot, Hotspot}, pm3::run_pm3, store::IDStore, webserver::{spawn_idle_watcher, ActivityNotifier}};
+
 mod feedback;
-mod gpio_buzzer;
 mod hardware;
-mod hotspot;
-mod id_mapping;
-mod id_store;
-mod logger;
-mod mock;
-mod parser;
 mod pm3;
-mod spi_led;
+mod logger;
 mod tally_id;
 mod webserver;
+mod store;
 
 const STORE_PATH: &str = "./data.json";
 
@@ -40,6 +36,7 @@ async fn run_webserver<H>(
     store: Arc<Mutex<IDStore>>,
     id_channel: Sender<String>,
     hotspot: Arc<Mutex<H>>,
+    user_feedback: Arc<Mutex<FeedbackImpl>>,
 ) -> Result<()>
 where
     H: Hotspot + Send + Sync + 'static,
@@ -47,8 +44,13 @@ where
     let activity_channel = spawn_idle_watcher(Duration::from_secs(60 * 30), move || {
         info!("No activity on webserver. Disabling hotspot");
         let cloned_hotspot = hotspot.clone();
+        let cloned_user_feedback = user_feedback.clone();
         tokio::spawn(async move {
             let _ = cloned_hotspot.lock().await.disable_hotspot().await;
+            cloned_user_feedback
+                .lock()
+                .await
+                .set_device_status(feedback::DeviceStatus::Ready);
         });
     });
 
@@ -57,6 +59,7 @@ where
     };
 
     start_webserver(store, id_channel, notifier).await?;
+
     Ok(())
 }
 
@@ -89,32 +92,38 @@ async fn handle_ids_loop(
     hotspot_enable_ids: Vec<TallyID>,
     id_store: Arc<Mutex<IDStore>>,
     hotspot: Arc<Mutex<impl Hotspot>>,
-    mut user_feedback: FeedbackImpl,
+    user_feedback: Arc<Mutex<FeedbackImpl>>,
 ) -> Result<()> {
     while let Ok(tally_id_string) = id_channel.recv().await {
         let tally_id = TallyID(tally_id_string);
 
         if hotspot_enable_ids.contains(&tally_id) {
             info!("Enableing hotspot");
-            hotspot
+            let hotspot_enable_result = hotspot.lock().await.enable_hotspot().await;
-                .lock()
+
-                .await
+            match hotspot_enable_result {
-                .enable_hotspot()
+                Ok(_) => {
-                .await
+                    user_feedback
-                .unwrap_or_else(|err| {
+                        .lock()
-                    error!("Hotspot: {err}");
+                        .await
-                });
+                        .set_device_status(feedback::DeviceStatus::HotspotEnabled);
+                }
+                Err(e) => {
+                    error!("Hotspot: {e}");
+                }
+            }
+
             // TODO: Should the ID be added anyway or ignored ?
         }
 
         if id_store.lock().await.add_id(tally_id) {
             info!("Added new id to current day");
 
-            user_feedback.success().await;
+            user_feedback.lock().await.success().await;
 
             if let Err(e) = id_store.lock().await.export_json(STORE_PATH).await {
                 error!("Failed to save id store to file: {e}");
-                user_feedback.failure().await;
+                user_feedback.lock().await.failure().await;
                 // TODO: How to handle a failure to save ?
             }
         }
@@ -123,36 +132,60 @@ async fn handle_ids_loop(
     Ok(())
 }
 
+async fn enter_error_state(feedback: Arc<Mutex<FeedbackImpl>>, hotspot: Arc<Mutex<impl Hotspot>>) {
+    let _ = feedback.lock().await.activate_error_state().await;
+    let _ = hotspot.lock().await.enable_hotspot().await;
+
+    let mut sigterm = signal(SignalKind::terminate()).unwrap();
+    sigterm.recv().await;
+}
+
 #[tokio::main]
 async fn main() -> Result<()> {
     logger::setup_logger();
 
     info!("Starting application");
 
+    let user_feedback = Arc::new(Mutex::new(Feedback::new()?));
+    let hotspot = Arc::new(Mutex::new(create_hotspot()?));
+
+    let error_flag_set = args().any(|e| e == "--error" || e == "-e");
+    if error_flag_set {
+        error!("Error flag set. Entering error state");
+        enter_error_state(user_feedback.clone(), hotspot).await;
+        return Ok(());
+    }
+
+    let store: Arc<Mutex<IDStore>> = Arc::new(Mutex::new(load_or_create_store().await?));
+    let hotspot_enable_ids = get_hotspot_enable_ids();
+
     let (tx, rx) = broadcast::channel::<String>(32);
     let sse_tx = tx.clone();
 
-    let store: Arc<Mutex<IDStore>> = Arc::new(Mutex::new(load_or_create_store().await?));
-    let user_feedback = Feedback::new()?;
-    let hotspot = Arc::new(Mutex::new(create_hotspot()?));
-    let hotspot_enable_ids = get_hotspot_enable_ids();
-
     let pm3_handle = run_pm3(tx);
 
+    user_feedback.lock().await.startup().await;
+
     let loop_handle = handle_ids_loop(
         rx,
         hotspot_enable_ids,
         store.clone(),
         hotspot.clone(),
-        user_feedback,
+        user_feedback.clone(),
     );
 
-    let webserver_handle = run_webserver(store.clone(), sse_tx, hotspot.clone());
+    let webserver_handle = run_webserver(
+        store.clone(),
+        sse_tx,
+        hotspot.clone(),
+        user_feedback.clone(),
+    );
 
     let run_result = try_join!(pm3_handle, loop_handle, webserver_handle);
 
     if let Err(e) = run_result {
         error!("Failed to run application: {e}");
+        return Err(e);
     }
 
     Ok(())

src/pm3/mod.rs

@@ -0,0 +1,4 @@
+mod runner;
+mod parser;
+
+pub use runner::run_pm3;

src/pm3/runner.rs

@@ -62,10 +62,15 @@ pub async fn run_pm3(tx: broadcast::Sender<String>) -> Result<()> {
     };
 
     let status = cmd.wait().await?;
-    if status.success() {
+
+    // We use the exit code here because status.success() is false if the child was terminated by a
+    // signal
+    let code = status.code().unwrap_or(0);
+
+    if code == 0 {
         Ok(())
     } else {
-        Err(anyhow!("PM3 exited with a non-zero exit code"))
+        Err(anyhow!("PM3 exited with a non-zero exit code: {code}"))
     }
 }
 

src/store/id_store.rs

@@ -1,9 +1,10 @@
-use crate::{id_mapping::IDMapping, tally_id::TallyID};
 use anyhow::{Result, anyhow};
 use serde::{Deserialize, Serialize};
 use std::collections::{HashMap, HashSet};
 use tokio::fs;
 
+use crate::{store::IDMapping, tally_id::TallyID};
+
 /// Represents a single day that IDs can attend
 #[derive(Deserialize, Serialize)]
 pub struct AttendanceDay {

src/store/mod.rs

@@ -0,0 +1,5 @@
+mod id_store;
+mod id_mapping;
+
+pub use id_store::IDStore;
+pub use id_mapping::{IDMapping,Name};

src/webserver/mod.rs

@@ -0,0 +1,6 @@
+mod server;
+mod activity_fairing;
+
+pub use activity_fairing::{ActivityNotifier,spawn_idle_watcher};
+pub use server::start_webserver;
+

src/webserver/server.rs

@@ -14,10 +14,9 @@ use tokio::select;
 use tokio::sync::Mutex;
 use tokio::sync::broadcast::Sender;
 
-use crate::activity_fairing::ActivityNotifier;
+use crate::store::{IDMapping, IDStore, Name};
-use crate::id_mapping::{IDMapping, Name};
-use crate::id_store::IDStore;
 use crate::tally_id::TallyID;
+use crate::webserver::ActivityNotifier;
 
 #[derive(Embed)]
 #[folder = "web/dist"]

web/src/App.svelte

@@ -42,7 +42,9 @@
     />
   </div>
   <div>
-    <IDTable bind:this={idTable} />
+    <IDTable bind:this={idTable} onEdit={(id,firstName,lastName)=>{
+      addModal.open(id,firstName,lastName);
+    }}/>
   </div>
 
   <AddIDModal

web/src/lib/AddIDModal.svelte

@@ -9,8 +9,12 @@
 
   let modal: Modal;
 
-  export function open(id: string) {
+  export function open(presetID: string, presetFirstName?: string, presetLastName?: string) {
-    displayID = id;
+    displayID = presetID;
+
+    firstName = presetFirstName ?? "";
+    lastName = presetLastName ?? "";
+
     modal.open();
   }
 

web/src/lib/IDTable.svelte

@@ -3,6 +3,8 @@
   import type { IDMapping } from "./IDMapping";
   let data: IDMapping | undefined = $state();
 
+  let { onEdit }: { onEdit?: (string,string,string) => void } = $props();
+
   export async function reloadData() {
     let res = await fetch("/api/mapping");
 
@@ -82,6 +84,8 @@
 
             <span class="indicator">{indicator("first")}</span>
           </th>
+          <th>
+          </th>
         </tr>
       </thead>
       <tbody>
@@ -90,6 +94,9 @@
             <td class="whitespace-nowrap pr-5 pl-2 py-1">{row.id}</td>
             <td class="whitespace-nowrap pr-5">{row.last}</td>
             <td class="whitespace-nowrap pr-5">{row.first}</td>
+            <td class="pr-5" ><button onclick={()=>{
+              onEdit && onEdit(row.id,row.first,row.last);
+            }} class="cursor-pointer">🔧</button></td>
           </tr>
         {/each}
       </tbody>

web/src/lib/LastID.svelte

@@ -27,7 +27,7 @@
     <button
       class="bg-indigo-500 rounded-2xl px-2 cursor-pointer mx-2"
       onclick={() => {
-        if (onAdd && id != "") {
+        if (onAdd) {
           onAdd(id);
         }
       }}>+</button