cognitum-one 0.2.1

Official Cognitum SDK for Rust
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
77
78
79
80
81

use serde::Serialize;

use crate::client::Client;
use crate::error::Error;
use crate::types::Device;

/// Operations on OTA devices.
pub struct DevicesResource<'a> {
    pub(crate) client: &'a Client,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct RegisterBody {
    public_key: String,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct CheckUpdateBody {
    device_id: String,
    current_version: String,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct HeartbeatBody {
    device_id: String,
}

/// Response from the update check endpoint.
#[derive(Debug, Clone, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateCheckResponse {
    /// Whether an update is available.
    pub update_available: bool,
    /// The version of the available update, if any.
    #[serde(default)]
    pub version: Option<String>,
    /// Download URL for the firmware, if an update is available.
    #[serde(default)]
    pub download_url: Option<String>,
}

/// Response from the heartbeat endpoint.
#[derive(Debug, Clone, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HeartbeatResponse {
    pub success: bool,
}

impl<'a> DevicesResource<'a> {
    /// Register a new device with its Ed25519 public key.
    pub async fn register(&self, public_key: &str) -> Result<Device, Error> {
        let body = RegisterBody {
            public_key: public_key.to_owned(),
        };
        self.client.post("/seedRegisterDevice", &body).await
    }

    /// Check whether a firmware update is available for the given device.
    pub async fn check_update(
        &self,
        device_id: &str,
        current_version: &str,
    ) -> Result<UpdateCheckResponse, Error> {
        let body = CheckUpdateBody {
            device_id: device_id.to_owned(),
            current_version: current_version.to_owned(),
        };
        self.client.post("/seedCheckUpdate", &body).await
    }

    /// Send a heartbeat for a device.
    pub async fn heartbeat(&self, device_id: &str) -> Result<HeartbeatResponse, Error> {
        let body = HeartbeatBody {
            device_id: device_id.to_owned(),
        };
        self.client.post("/seedHeartbeat", &body).await
    }
}