megarefactor

Cargo.toml

@@ -6,12 +6,24 @@ edition = "2021"
 [profile.dev]
 panic = "abort"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[workspace]
+members = [
+	"bambulabs",
+	"moonraker"
+]
+
+[features]
+default = ["bambu", "formlabs", "moonraker", "serial"]
+debug = ["dep:delouse", "dep:console-subscriber"]
+bambu = ["dep:bambulabs"]
+formlabs = []
+serial = ["dep:tokio-serial"]
+moonraker = ["dep:moonraker"]
 
 [dependencies]
 anyhow = "1.0.86"
 async-trait = "0.1.81"
-bambulabs = { path = "bambulabs" }
+bambulabs = { path = "bambulabs", optional = true }
 bytes = "1.7.1"
 chrono = { version = "0.4", default-features = false, features = ["serde"] }
 clap = { version = "4.5.16", features = ["cargo", "derive", "env", "unicode"] }
@@ -22,18 +34,18 @@ dropshot = "0.11"
 futures = "0.3.28"
 futures-util = "0.3.30"
 git_rev = "0.1.0"
-http = "1.1.0"
-libmdns = "0.9.1"
+libmdns = "0.8.0"
 mdns = "3.0.0"
 multer = { version = "3.1.0", features = ["json"] }
+moonraker = { path = "moonraker", optional = true }
 opentelemetry = "0.24.0"
 opentelemetry-otlp = "0.17.0"
 opentelemetry_sdk = { version = "0.24.1", features = ["rt-tokio"] }
 reqwest = { version = "0.12", default-features = false, features = ["json", "rustls-tls"] }
 schemars = { version = "0.8", features = ["chrono", "uuid1", "bigdecimal"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-serialport = "4.5.0"
+signal-hook = "0.3"
 slog = "2.7.0"
 slog-async = "2.7.0"
 slog-json = "2.6.1"
@@ -46,6 +58,10 @@ tracing = "0.1"
 tracing-opentelemetry = "0.25.0"
 tracing-subscriber = { version = "0.3.18", features = ["registry", "std", "fmt", "smallvec", "ansi", "tracing-log", "json", "env-filter"] }
 uuid = "1.10.0"
+tokio-serial = { version = "5", optional = true, features = ["tokio-util", "libudev"] }
+tracing-slog = "0.3.0"
+http = "0.2.9"
+hyper = "0.14"
 
 [dev-dependencies]
 async-trait = "0.1"
@@ -56,13 +72,3 @@ pretty_assertions = "1"
 rand = "0.8"
 test-context = "0.3.0"
 testresult = "0.4.1"
-
-[features]
-debug = ["dep:delouse", "dep:console-subscriber"]
-
-[workspace]
-members = [
-	"bambulabs",
-	"moonraker"
-]
-

README.md

@@ -9,13 +9,23 @@ This API intends to provide a standardized local interface to any machines used
 Here is a sample config file:
 
 ```toml
-[bambulabs]
-machines = [
-    { id = "YOUR_ID_HERE", access_code = "YOUR_ACCESS_CODE_HERE", slicer_config = "./config/bambu/" },
-    { id = "YOUR_ID_HERE", access_code = "YOUR_ACCESS_CODE_HERE", slicer_config = "./config/bambu/" },
-]
-
-[formlabs]
+[machines.mk3]
+type = "Usb"
+port = "/dev/ttyUSB0"
+baud = 115200
+variant = "PrusaMk3"
+slicer.type = "Prusa"
+slicer.config = "config/prusa/mk3.ini"
+
+[machines.nada]
+type = "Noop"
+
+[machines.neptune"]
+type = "Moonraker"
+endpoint = "http://192.168.1.102"
+variant = "Neptune4"
+slicer.type = "Prusa"
+slicer.config = "config/prusa/neptune4.ini"
 ```
 
 The cli looks by default for a file called `machine-api.toml` in the current
@@ -27,14 +37,13 @@ directory. You can also specify a different file with the `--config` flag.
 You can run this server locally assuming rust is installed:
 
 ```
-cargo run server --address 0.0.0.0:8585
+cargo run -- serve --bind 0.0.0.0:8585
 ```
 
 The full API is described by the OpenAPI spec, but to start you can list the connected machines:
 
 ```bash
 $ curl http://localhost:8585/machines
-# [{"port":"/dev/ttyACM0","id":"CZPX2418X004XK68718","manufacturer":"Prusa Research (prusa3d.com)","model":"Original Prusa i3 MK3"}]
 ```
 
 The ID is what you'll use to identify the machine. You can use that ID to start a print job. 

flake.nix

@@ -58,6 +58,7 @@
             # dependencies for machine-api
             just
             pkg-config
+            openssl
           ]) ++ pkgs.lib.optionals pkgs.stdenv.isLinux (with pkgs; [
             udev
           ]) ++ pkgs.lib.optionals pkgs.stdenv.isDarwin (with pkgs; [

moonraker/Cargo.toml

@@ -5,8 +5,10 @@ edition = "2021"
 
 [dependencies]
 anyhow = "1"
-bytes = "1.7.1"
+bytes = "1"
 reqwest = { version = "0", features = ["json", "multipart"] }
-serde = { version = "1.0.209", features = ["derive"] }
+
+serde = { version = "1.0.208", features = ["derive"] }
 serde_json = "1"
 tokio = { version = "1", features = ["full"] }
+tracing = "0"

moonraker/src/bin/print.rs

@@ -6,7 +6,7 @@
 async fn main() -> Result<()> {
     let args: Vec<String> = std::env::args().collect();
 
-    let printer = moonraker::PrintManager::new(&args[1])?;
+    let printer = moonraker::Client::new(&args[1])?;
     let path: PathBuf = args[2].parse().unwrap();
     let path: PathBuf = printer.upload_file(&path).await?.item.path.parse().unwrap();
     eprintln!("Uploaded {}", path.display());

moonraker/src/lib.rs

@@ -19,15 +19,17 @@
 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 {
+/// Client is a moonraker instance which can accept gcode for printing.
+pub struct Client {
     pub(crate) url_base: String,
 }
 
-impl PrintManager {
-    /// Create a new PrintManager handle to control the printer via the
+impl Client {
+    /// Create a new Client handle to control the printer via the
     /// moonraker interface.
     pub fn new(url_base: &str) -> Result<Self> {
+        tracing::debug!(base = url_base, "new");
+
         Ok(Self {
             url_base: url_base.to_owned(),
         })

moonraker/src/metrics.rs

@@ -1,10 +1,10 @@
 use anyhow::Result;
 use serde::{Deserialize, Serialize};
 
-use super::PrintManager;
+use super::Client;
 
 /// Temperature readings from a heated element controlled by klipper.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct ControlledTemperatureReadings {
     /// Observed temperatures, from oldest (0th) to latest (last)
     pub temperatures: Vec<f64>,
@@ -17,7 +17,7 @@
 }
 
 /// TemperatureReadings as reported by klipper.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct TemperatureReadings {
     /// Information about the 3D printer extruder head.
     pub extruder: ControlledTemperatureReadings,
@@ -26,14 +26,15 @@
     pub heater_bed: Option<ControlledTemperatureReadings>,
 }
 
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 struct TemperatureReadingsWrapper {
     result: TemperatureReadings,
 }
 
-impl PrintManager {
+impl Client {
     /// Print an uploaded file.
     pub async fn temperatures(&self) -> Result<TemperatureReadings> {
+        tracing::debug!(base = self.url_base, "requesting temperatures");
         let client = reqwest::Client::new();
 
         let resp: TemperatureReadingsWrapper = client

moonraker/src/print.rs

@@ -3,10 +3,10 @@
 use anyhow::Result;
 use serde::{Deserialize, Serialize};
 
-use super::PrintManager;
+use super::Client;
 
 /// Information about the underlying Klipper runtime and host computer.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct InfoResponse {
     /// slug defining what state the printer is currently in, such as
     /// `ready`.
@@ -25,14 +25,16 @@
     pub cpu_info: String,
 }
 
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 struct InfoResponseWrapper {
     pub result: InfoResponse,
 }
 
-impl PrintManager {
+impl Client {
     /// Print an uploaded file.
     pub async fn print(&self, file_name: &Path) -> Result<()> {
+        tracing::debug!(base = self.url_base, "requesting print");
+
         let file_name = file_name.to_str().unwrap();
         let client = reqwest::Client::new();
         client
@@ -48,6 +50,7 @@
     /// button and also used if a user enters M112(emergency stop) via a
     /// console.
     pub async fn emergency_stop(&self) -> Result<()> {
+        tracing::warn!(base = self.url_base, "requesting emergency stop");
         let client = reqwest::Client::new();
         client
             .post(format!("{}/printer/emergency_stop", self.url_base))
@@ -58,6 +61,7 @@
 
     /// Get information regarding the processor and its state.
     pub async fn info(&self) -> Result<InfoResponse> {
+        tracing::debug!(base = self.url_base, "requesting info");
         let client = reqwest::Client::new();
         let resp: InfoResponseWrapper = client
             .post(format!("{}/printer/info", self.url_base))
@@ -70,13 +74,15 @@
 
     /// Restart the printer (shut down and reboot).
     pub async fn restart(&self) -> Result<()> {
+        tracing::debug!(base = self.url_base, "requesting restart");
         let client = reqwest::Client::new();
         client.post(format!("{}/printer/restart", self.url_base)).send().await?;
         Ok(())
     }
 
     /// Cancel a print job.
     pub async fn cancel_print(&self) -> Result<()> {
+        tracing::debug!(base = self.url_base, "requesting cancel");
         let client = reqwest::Client::new();
         client
             .post(format!("{}/printer/print/cancel", self.url_base))
@@ -87,6 +93,7 @@
 
     /// Pause a print job.
     pub async fn pause_print(&self) -> Result<()> {
+        tracing::debug!(base = self.url_base, "requesting pause");
         let client = reqwest::Client::new();
         client
             .post(format!("{}/printer/print/pause", self.url_base))
@@ -97,6 +104,7 @@
 
     /// Resume a print job.
     pub async fn resume_print(&self) -> Result<()> {
+        tracing::debug!(base = self.url_base, "requesting resume");
         let client = reqwest::Client::new();
         client
             .post(format!("{}/printer/print/resume", self.url_base))

moonraker/src/upload.rs

@@ -5,10 +5,10 @@
 use reqwest::multipart;
 use serde::{Deserialize, Serialize};
 
-use super::PrintManager;
+use super::Client;
 
 /// File that has been uploaded to Moonraker.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct UploadResponseItem {
     /// Path of the file relative to the root directory.
     pub path: String,
@@ -20,20 +20,14 @@
 }
 
 /// Response to an upload request.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, 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,
 }
 
 /// File that has been deleted from Moonraker.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct DeleteResponseItem {
     /// Path of the file relative to the root directory.
     pub path: String,
@@ -45,20 +39,21 @@
 }
 
 /// Response to a delete request.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct DeleteResponse {
     /// `gcode` file that has been deleted.
     pub item: DeleteResponseItem,
 }
 
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 struct DeleteResponseWrapper {
     result: DeleteResponse,
 }
 
-impl PrintManager {
+impl Client {
     /// Upload a file with some gcode to the server.
     pub async fn upload_file(&self, file_name: &Path) -> Result<UploadResponse> {
+        tracing::info!(file_path = file_name.to_str().unwrap(), "uploading file");
         self.upload(
             &PathBuf::from(file_name.file_name().unwrap().to_str().unwrap()),
             &std::fs::read(file_name)?,
@@ -69,6 +64,7 @@
     /// Upload a byte array of gcode to the print queue.
     pub async fn upload(&self, file_name: &Path, gcode: &[u8]) -> Result<UploadResponse> {
         let file_name = file_name.to_str().unwrap();
+        tracing::info!(file_name = file_name, "uploading gcode to the printer");
         let gcode = multipart::Part::bytes(gcode.to_owned())
             .file_name(file_name.to_owned())
             .mime_str("text/x-gcode")?;
@@ -100,6 +96,7 @@
 
     /// Delete an uploaded file from the print queue.
     pub async fn delete(&self, file_name: &Path) -> Result<DeleteResponse> {
+        tracing::info!(file_path = file_name.to_str().unwrap(), "deleting file");
         let file_name = file_name.to_str().unwrap();
         let client = reqwest::Client::new();
         let resp: DeleteResponseWrapper = client