Add top-level /setup endpoint

Author: RReverser

src/macros.rs

@@ -180,7 +180,7 @@ macro_rules! rpc_mod {
 
         pub(crate) mod internal {
             // Not really public, needed for a Voldemort trait RetrieavableDevice.
-            #[derive(PartialEq, Eq, Clone, Copy)]
+            #[derive(PartialOrd, Ord, PartialEq, Eq, Clone, Copy)]
             pub enum DeviceType {
                 $(
                     #[cfg(feature = $path)]

src/server/mod.rs

@@ -28,6 +28,8 @@ use axum::response::IntoResponse;
 use axum::routing::MethodFilter;
 use axum::{BoxError, Router};
 use net_literals::addr;
+use std::collections::BTreeMap;
+use std::fmt::Write;
 use std::future::Future;
 use std::net::SocketAddr;
 use std::pin::Pin;
@@ -216,6 +218,7 @@ impl Server {
         self.bind().await?.start().await
     }
 
+    #[allow(clippy::too_many_lines)]
     fn into_router(self) -> Router {
         let devices = Arc::new(self.devices);
         let server_info = Arc::new(self.info);
@@ -248,6 +251,68 @@ impl Server {
                     })
                 }),
             )
+            .route("/setup", {
+                let this = Arc::clone(&devices);
+
+                axum::routing::get(|| async move {
+                    let mut grouped_devices = BTreeMap::new();
+                    for (device, number) in this.iter_all() {
+                        let device = device.to_configured_device(number);
+
+                        grouped_devices
+                            .entry(device.ty)
+                            .or_insert_with(Vec::new)
+                            .push((number, device.name));
+                    }
+
+                    let mut devices_html = String::new();
+
+                    for (device_type, devices) in grouped_devices {
+                        writeln!(devices_html, "<figure>").unwrap();
+                        writeln!(devices_html, "<figcaption>{}</figcaption>", match device_type {
+                            #[cfg(feature = "camera")]
+                            DeviceType::Camera => "Cameras",
+                            #[cfg(feature = "dome")]
+                            DeviceType::Dome => "Domes",
+                            #[cfg(feature = "filterwheel")]
+                            DeviceType::FilterWheel => "Filter wheels",
+                            #[cfg(feature = "focuser")]
+                            DeviceType::Focuser => "Focusers",
+                            #[cfg(feature = "observingconditions")]
+                            DeviceType::ObservingConditions => "Weather stations",
+                            #[cfg(feature = "rotator")]
+                            DeviceType::Rotator => "Rotators",
+                            #[cfg(feature = "safetymonitor")]
+                            DeviceType::SafetyMonitor => "Safety monitors",
+                            #[cfg(feature = "switch")]
+                            DeviceType::Switch => "Switches",
+                            #[cfg(feature = "telescope")]
+                            DeviceType::Telescope => "Telescopes",
+                            #[cfg(feature = "covercalibrator")]
+                            DeviceType::CoverCalibrator => "Cover calibrators",
+                        }).unwrap();
+                        writeln!(devices_html, "<ul>").unwrap();
+                        for (device_index, device_name) in devices {
+                            writeln!(
+                                devices_html,
+                                r#"<li><a href="/api/v1/{group_path}/{device_index}/setup">{device_name}</a></li>"#,
+                                group_path = DevicePath(device_type),
+                            ).unwrap();
+                        }
+                        writeln!(devices_html, "</ul>").unwrap();
+                        writeln!(devices_html, "</figure>").unwrap();
+                    }
+
+                    axum::response::Html(include_str!("setup_template.html").replace(
+                        "<!-- devices_html -->",
+                        if devices_html.is_empty() {
+                            "<p>No devices are registered on this server.</p>"
+                        } else {
+                            &devices_html
+                        },
+                    ))
+                })
+            })
             .route(
                 "/api/v1/:device_type/:device_number/:action",
                 axum::routing::on(

src/server/setup_template.html

@@ -0,0 +1,66 @@
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Alpaca devices</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        margin: 0;
+        padding: 0;
+      }
+      h1,
+      figure {
+        margin: 1em auto;
+        width: 90vw;
+      }
+      h1 {
+        text-align: center;
+        color: #333;
+        font-size: 2.5em;
+      }
+      figure {
+        background-color: #fff;
+        box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3), 0 -2px 2px rgba(0, 0, 0, 0.3);
+      }
+      figcaption,
+      a {
+        margin: 0;
+        padding: 0.625em;
+      }
+      figcaption {
+        background-color: #f5f5f5;
+        color: #333;
+        font-size: 1.2em;
+      }
+      ul {
+        list-style: none;
+        padding: 0;
+        margin: 0;
+        display: flex;
+        flex-direction: column;
+      }
+      li:first-child {
+        border-top: 1px solid #ccc;
+      }
+      li {
+        border-bottom: 1px solid #ccc;
+      }
+      a {
+        color: #333;
+        text-decoration: none;
+        display: block;
+        transition: background-color 0.3s ease;
+      }
+      a:hover {
+        background-color: #f5f5f5;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Alpaca devices</h1>
+
+    <!-- devices_html -->
+  </body>
+</html>