octoprint 0.1.3

(WIP) A client library for the Octoprint REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use serde::{Deserialize, Serialize};

use crate::client::file::model::{Filament, FileInfo};

#[derive(Serialize, Deserialize, Debug)]
pub struct JobInfo {
    /// The file that is the target of the current print job
    pub file: FileInfo,
    /// The estimated print time for the file, in seconds
    #[serde(rename = "estimatedPrintTime")]
    pub estimated_print_time: Option<f64>,
    /// The print time of the last print of the file, in seconds
    #[serde(rename = "lastPrintTime")]
    pub last_print_time: Option<f64>,
    /// Information regarding the estimated filament usage of the print job
    pub filament: Option<Filament>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ProgressInfo {
    /// Percentage of the completion of the current print job
    pub completion: f64,
    /// Current position in the file being printed in bytes from the beginning
    pub filepos: usize,
    /// Time already spent printing in seconds
    #[serde(rename = "printTime")]
    pub print_time: usize,
    /// Estimate of time left to print in seconds
    #[serde(rename = "printTimeLeft")]
    pub print_time_left: usize,
    /// Origin of the current time left estimate
    #[serde(rename = "printTimeLeftOrigin")]
    pub print_time_left_origin: PrintTimeLeftOrigin,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum PrintTimeLeftOrigin {
    /// Based on a linear approximation of the progress in the file in bytes vs time
    #[serde(rename = "linear")]
    Linear,
    /// Based on an analysis of the file
    #[serde(rename = "analysis")]
    Analysis,
    /// calculated estimate after stabilization of linear estimation
    #[serde(rename = "estimate")]
    Estimate,
    /// Based on the average total from past prints of the same model against the same printer profile
    #[serde(rename = "average")]
    Average,
    /// Mixture of `estimate` and `analysis`
    #[serde(rename = "mixed-analysis")]
    MixedAnalysis,
    /// Mixture of `estimate` and `average`
    #[serde(rename = "mixed-average")]
    MixedAverage,
}