busylib 0.0.4

BUSY Bar Rust HTTP client
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
76

//! System endpoints

use crate::client::Call;
use crate::error::Result;
use crate::model::system::{
    LogDumpResponse, NetworkInterfaceInfo, Status, StatusDevice, StatusFirmware, StatusPower,
    StatusSystem, TransportType, VersionInfo,
};
use crate::transport::HttpTransport;
use crate::types::log_name::LogName;
use crate::types::try_into_value::TryIntoValue;

crate::api::endpoint!(
    /// System information and control
    System
);

impl<T: HttpTransport> System<'_, T> {
    /// Get API version information
    ///
    /// Retrieves API version
    pub async fn version(&self) -> Result<String> {
        let response: VersionInfo = self.client.json(Call::get("version")).await?;
        Ok(response.api_semver)
    }

    /// Get device network connection info
    ///
    /// Retrieves device transport type (usb/wifi)
    pub async fn transport(&self) -> Result<TransportType> {
        let response: NetworkInterfaceInfo = self.client.json(Call::get("transport")).await?;
        Ok(response.r#type)
    }

    /// Get device status
    pub async fn status(&self) -> Result<Status> {
        self.client.json(Call::get("status")).await
    }

    /// Get device info
    pub async fn device(&self) -> Result<StatusDevice> {
        self.client.json(Call::get("status/device")).await
    }

    /// Get firmware info
    pub async fn firmware(&self) -> Result<StatusFirmware> {
        self.client.json(Call::get("status/firmware")).await
    }

    /// Get system status
    pub async fn system_info(&self) -> Result<StatusSystem> {
        self.client.json(Call::get("status/system")).await
    }

    /// Get power status
    pub async fn power(&self) -> Result<StatusPower> {
        self.client.json(Call::get("status/power")).await
    }

    /// Dump captured log
    ///
    /// Snapshot the in-memory log buffer to a file (defaults to /ext/log.txt)
    pub async fn dump_log(&self) -> Result<String> {
        let response: LogDumpResponse = self.client.json(Call::post("log_dump")).await?;
        Ok(response.path)
    }

    /// Dump captured log
    ///
    /// Snapshot the in-memory log buffer to a file (defaults to /ext/log.txt)
    pub async fn dump_log_as(&self, filename: impl TryIntoValue<LogName>) -> Result<String> {
        let request = Call::post("log_dump").query("filename", filename.try_into_value()?);
        let response: LogDumpResponse = self.client.json(request).await?;
        Ok(response.path)
    }
}