feat: add /api/thermal endpoint

Author: eltorio

rust/src/thermal_regulation/shared_state.rs

@@ -9,15 +9,15 @@
 
 use anyhow::Result;
 use rocket::serde::{Deserialize, Serialize};
+use rocket_okapi::JsonSchema;
 use std::collections::{HashMap, VecDeque};
 use std::time::{SystemTime, UNIX_EPOCH};
 use tokio::sync::RwLock;
-
 /// Maximum number of historical data points per regulator (1 day at 1Hz)
 pub const MAX_HISTORY_SIZE: usize = 86400;
 
 /// Single data point in thermal regulation history
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct ThermalDataPoint {
     /// Timestamp in Unix seconds
     pub timestamp: u64,
@@ -32,7 +32,7 @@ pub struct ThermalDataPoint {
 }
 
 /// PID controller components for analysis
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct PidComponents {
     /// Proportional term value
     pub proportional: f64,
@@ -45,7 +45,7 @@ pub struct PidComponents {
 }
 
 /// Historical data for a single thermal regulator
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct ThermalRegulatorHistory {
     /// Regulator unique identifier
     pub id: String,
@@ -64,7 +64,7 @@ pub struct ThermalRegulatorHistory {
 }
 
 /// Current status of a thermal regulator
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub enum RegulatorStatus {
     /// Regulator is not initialized
     Uninitialized,
@@ -79,7 +79,7 @@ pub enum RegulatorStatus {
 }
 
 /// Current PID parameters for a regulator
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct CurrentPidParams {
     /// Proportional gain
     pub kp: f64,
@@ -95,7 +95,7 @@ pub struct CurrentPidParams {
 }
 
 /// Shared thermal regulation state across the entire system
-#[derive(Debug)]
+#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
 pub struct SharedThermalRegulationState {
     /// Map of regulator ID to its historical data
     regulators: HashMap<String, ThermalRegulatorHistory>,
@@ -106,7 +106,7 @@ pub struct SharedThermalRegulationState {
 }
 
 /// Global thermal regulation system status
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct ThermalSystemStatus {
     /// Total number of configured regulators
     pub total_regulators: usize,

rust/src/visualization/api/get/mod.rs

@@ -4,3 +4,4 @@
 
 pub mod config;
 pub mod test;
+pub mod thermal;

rust/src/visualization/api/get/thermal.rs

@@ -0,0 +1,28 @@
+// Copyright (c) 2025 Ronan LE MEILLAT, SCTG Development
+// This file is part of the rust-photoacoustic project and is licensed under the
+// SCTG Development Non-Commercial License v1.0 (see LICENSE.md for details).
+
+//! Thermal data retrieval API for photoacoustic applications
+//! This module provides an API for retrieving thermal data from the SharedThermalRegulationState
+
+use crate::thermal_regulation::shared_state::{SharedThermalRegulationState, SharedThermalState};
+use auth_macros::openapi_protect_get;
+use rocket::get;
+use rocket_okapi::okapi::openapi3::OpenApi;
+use rocket_okapi::openapi_get_routes_spec;
+
+#[openapi_protect_get("/api/thermal", "read:api", tag = "Thermal Regulation")]
+pub async fn get_thermal_data(
+    state: &rocket::State<SharedThermalState>,
+) -> Result<rocket::serde::json::Json<SharedThermalRegulationState>, rocket::http::Status> {
+    // Retrieve the current thermal regulation state
+    let thermal_state = state.read().await.clone();
+
+    // Return the thermal state as JSON
+    Ok(rocket::serde::json::Json(thermal_state))
+}
+
+/// Centralized function to get all thermal routes with OpenAPI documentation
+pub fn get_thermal_routes() -> (Vec<rocket::Route>, OpenApi) {
+    openapi_get_routes_spec![get_thermal_data]
+}

rust/src/visualization/api/mod.rs

@@ -6,4 +6,5 @@ pub mod graph;
 pub mod post;
 pub use get::config::*;
 pub use get::test::*;
+pub use get::thermal::*;
 pub use post::test::*;

rust/src/visualization/server/builder.rs

@@ -206,9 +206,12 @@ pub async fn build_rocket(
         .manage(config.clone()); // Add config as managed state for future dynamic configuration
 
     // Add thermal regulation state if available
+    let (openapi_routes_thermal, openapi_spec_thermal) = get_thermal_routes();
     let rocket_builder = if let Some(thermal_state) = thermal_state {
         debug!("Adding SharedThermalState to Rocket state management");
-        rocket_builder.manage(thermal_state)
+        rocket_builder
+            .manage(thermal_state)
+            .mount("/", openapi_routes_thermal)
     } else {
         debug!("No thermal state provided, thermal regulation API will return 404");
         rocket_builder
@@ -248,7 +251,11 @@ pub async fn build_rocket(
         (openapi_routes_audio, openapi_spec_audio) = get_audio_streaming_routes();
 
         // Merge the audio OpenAPI spec with the base spec
-        let merged_spec = marge_spec_list(&[("/".to_string(), openapi_spec_base), ("/".to_string(),openapi_spec_audio), ("/".to_string(),openapi_spec_graph), ("/".to_string(),openapi_spec_config)]).unwrap();
+        let merged_spec = marge_spec_list(&[("/".to_string(), openapi_spec_base), 
+                                                    ("/".to_string(),openapi_spec_audio), 
+                                                    ("/".to_string(),openapi_spec_graph), 
+                                                    ("/".to_string(),openapi_spec_config),
+                                                    ( "/".to_string(), openapi_spec_thermal)]).unwrap();
         let openapi_settings = OpenApiSettings::default();
         rocket_builder
             .mount(