Add metrics endpoint(s), expose return values.

Author: paultag

Cargo.lock

@@ -8,4 +8,5 @@ anyhow = "1"
 bytes = "1.7.1"
 reqwest = { version = "0", features = ["json", "multipart"] }
 serde = { version = "1.0.204", features = ["derive"] }
+serde_json = "1"
 tokio = { version = "1", features = ["full"] }

moonraker/Cargo.toml

@@ -10,11 +10,16 @@
 //! This crate implements support for interfacing with the moonraker 3d printer
 //! api, proxying calls to klipper.
 
+mod metrics;
 mod print;
 mod upload;
 
 use anyhow::Result;
 
+pub use metrics::{ControlledTemperatureReadings, TemperatureReadings};
+pub use print::InfoResponse;
+pub use upload::{DeleteResponse, DeleteResponseItem, UploadResponse, UploadResponseItem};
+
 /// PrintManager is a moonraker instance which can accept gcode for printing.
 pub struct PrintManager {
     pub(crate) url_base: String,

moonraker/src/lib.rs

@@ -0,0 +1,48 @@
+use anyhow::Result;
+use serde::{Deserialize, Serialize};
+
+use super::PrintManager;
+
+/// Temperature readings from a heated element controlled by klipper.
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct ControlledTemperatureReadings {
+    /// Observed temperatures, from oldest (0th) to latest (last)
+    pub temperatures: Vec<f64>,
+
+    /// Target temperatures, from oldest (0th) to latest (last)
+    pub targets: Vec<f64>,
+
+    /// Controlled power level, from oldest (0th) to latest (last)
+    pub powers: Vec<f64>,
+}
+
+/// TemperatureReadings as reported by klipper.
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct TemperatureReadings {
+    /// Information about the 3D printer extruder head.
+    pub extruder: ControlledTemperatureReadings,
+
+    /// Information about a heated bed, if present
+    pub heater_bed: Option<ControlledTemperatureReadings>,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+struct TemperatureReadingsWrapper {
+    result: TemperatureReadings,
+}
+
+impl PrintManager {
+    /// Print an uploaded file.
+    pub async fn temperatures(&self) -> Result<TemperatureReadings> {
+        let client = reqwest::Client::new();
+
+        let resp: TemperatureReadingsWrapper = client
+            .get(format!("{}/server/temperature_store", self.url_base))
+            .send()
+            .await?
+            .json()
+            .await?;
+
+        Ok(resp.result)
+    }
+}

moonraker/src/metrics.rs

@@ -4,12 +4,23 @@ use std::path::Path;
 
 use super::PrintManager;
 
+/// Information about the underlying Klipper runtime and host computer.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct InfoResponse {
+    /// slug defining what state the printer is currently in, such as
+    /// `ready`.
     pub state: String,
+
+    /// Human readable description of the state above.
     pub state_message: String,
+
+    /// Hostname of the host computer.
     pub hostname: String,
+
+    /// Version of Klipper running on the host computer.
     pub software_version: String,
+
+    /// CPU of the host running Klipper.
     pub cpu_info: String,
 }
 

moonraker/src/print.rs

@@ -6,30 +6,48 @@ use std::path::{Path, PathBuf};
 
 use super::PrintManager;
 
+/// File that has been uploaded to Moonraker.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct UploadResponseItem {
+    /// Path of the file relative to the root directory.
     pub path: String,
+
+    /// Root folder. Currently only a limted set are supported,
+    /// check the moonraker docs for more information. This code
+    /// assumes everything is `gcodes` for now.
     pub root: String,
 }
 
+/// Response to an upload request.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct UploadResponse {
+    /// `gcode` file uploaded to the printer.
     pub item: UploadResponseItem,
+
+    /// Has this print been started?
     pub print_started: bool,
+
+    /// Has this print been enqueued?
     pub print_queued: bool,
-    pub action: String,
 }
 
+/// File that has been deleted from Moonraker.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct DeleteResponseItem {
+    /// Path of the file relative to the root directory.
     pub path: String,
+
+    /// Root folder. Currently only a limted set are supported,
+    /// check the moonraker docs for more information. This code
+    /// assumes everything is `gcodes` for now.
     pub root: String,
 }
 
+/// Response to a delete request.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct DeleteResponse {
+    /// `gcode` file that has been deleted.
     pub item: DeleteResponseItem,
-    pub action: String,
 }
 
 #[derive(Clone, Debug, Deserialize, Serialize)]