blues-notecard 0.6.0

A driver for the Blues.io Notecard
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! <https://dev.blues.io/api-reference/notecard-api/web-requests>

#[allow(unused_imports)]
use defmt::{debug, error, info, trace, warn};
use embedded_hal::blocking::delay::DelayMs;
use embedded_hal::blocking::i2c::{Read, SevenBitAddress, Write};
use serde::{Deserialize, Serialize};

use super::{str_string, FutureResponse, NoteError, Notecard};

pub struct Web<'a, IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BS: usize> {
    note: &'a mut Notecard<IOM, BS>,
}

impl<'a, IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BS: usize> Web<'a, IOM, BS> {
    pub fn from(note: &mut Notecard<IOM, BS>) -> Web<'_, IOM, BS> {
        Web { note }
    }

    /// Performs a simple HTTP or HTTPS POST request against an external endpoint, and returns the response to the Notecard.
    pub fn post<T: Serialize + Default>(
        self,
        delay: &mut impl DelayMs<u16>,
        route: &str,
        name: Option<&str>,
        body: Option<T>,
        payload: Option<&str>,
        content: Option<&str>,
        seconds: Option<u16>,
        max: Option<u16>,
        verify: Option<bool>,
        nasync: Option<bool>,
    ) -> Result<FutureResponse<'a, res::Post, IOM, BS>, NoteError> {
        self.note.request(
            delay,
            req::Post::<T> {
                req: "web.post",
                route: heapless::String::try_from(route).map_err(NoteError::string_err)?,
                name: str_string(name)?,
                body,
                payload,
                content: str_string(content)?,
                seconds,
                max,
                verify,
                nasync,
            },
        )?;
        Ok(FutureResponse::from(self.note))
    }
}

mod req {
    use super::*;

    #[derive(Deserialize, Serialize, Debug, defmt::Format, Default)]
    pub struct Post<'a, T: Serialize + Default> {
        pub req: &'static str,

        pub route: heapless::String<256>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub name: Option<heapless::String<256>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub body: Option<T>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub payload: Option<&'a str>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub content: Option<heapless::String<256>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub seconds: Option<u16>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub max: Option<u16>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub verify: Option<bool>,

        #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
        pub nasync: Option<bool>,
    }
}

pub mod res {
    use super::*;

    #[derive(Deserialize, Debug, defmt::Format)]
    pub struct Post {
        result: Option<u32>,
        // body: Option<&'a str>,
        // payload: Option<&'a str>,
        // status: Option<&'a str>,
        // cobs: Option<u32>,
        // length: Option<u32>,
    }
}