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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

pub mod temperature;

use serde::{Deserialize, Serialize};

use self::temperature::TemperatureState;

#[derive(Serialize, Deserialize)]
pub struct FullStateResponse {
    /// The printer's temperature state data
    pub temperature: Option<TemperatureState>,
    /// The printer's sd state data
    pub sd: Option<SDState>,
    /// The printer's general state
    pub state: Option<PrinterState>,
}

/// Used exclusively in [`OctoClient::get_printer_state`]
#[derive(Serialize, Deserialize, Debug)]
pub enum StateExclude {
    Temperature,
    SD,
    State,
}

/// The printer's general state
#[derive(Serialize, Deserialize)]
pub struct PrinterState {
    /// A textual representation of the current state of the printer
    /// e.g. "Operational" or "Printing"
    text: String,
    /// A few boolean printer state flags
    flags: PrinterStateFlags,
}

/// A few boolean printer state flags
#[derive(Serialize, Deserialize)]
pub struct PrinterStateFlags {
    /// `true` if the printer is operational, `false` otherwise
    pub operational: bool,
    /// `true` if the printer is currently paused, `false` otherwise
    pub paused: bool,
    /// `true` if the printer is currently printing, `false` otherwise
    pub printing: bool,
    /// `true` if the printer is currently printing and is in the process of pausing, `false` otherwise
    pub pausing: bool,
    /// `true` if the printer is currently printing and in the process of pausing, `false` otherwise
    pub cancelling: bool,
    /// `true` if the printer's SD card is available and initialized, `false` otherwise. This is redundant information to the SD State
    #[serde(rename = "sdReady")]
    pub sd_ready: bool,
    /// `true` if an unrecoverable error occurred, `false` otherwise
    pub error: bool,
    /// `true` if the printer is operational and no data is currently being streamed to SD, so ready to recieve instructions
    pub ready: bool,
    /// `true` if the printer is disconnected (possibly due to an error), `false` otherwise
    #[serde(rename = "closedError")]
    pub closed_error: bool,
}

#[derive(Serialize, Deserialize)]
pub struct ResendStats {
    /// Number of resend requests recieved since connecting
    pub count: usize,
    /// Number of transmitted lines since connecting
    pub transmitted: usize,
    /// Percentage of resend requests vs transmitted lines. Value between 0 and 100
    pub ratio: usize,
}

/// The printer's sd state data
#[derive(Serialize, Deserialize)]
pub struct SDState {
    /// Whether the SD card has been initalized
    ready: bool,
}