wot-td 0.6.2

Web of Things (WoT) Thing Description manipulation
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! MQTT Binding Template

use alloc::{string::String, vec::Vec};

use crate::extend::ExtendableThing;
use serde::{Deserialize, Serialize};
use serde_with::{serde_as, skip_serializing_none, OneOrMany};

/// MQTT Control Packet
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Hash)]
pub enum ControlPacket {
    #[serde(rename = "mqv:publish")]
    Publish,
    #[serde(rename = "mqv:subscribe")]
    Subscribe,
    #[serde(rename = "mqv:unsubscribe")]
    Unsubscribe,
}

/// MQTT Quality of service
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Hash)]
pub enum QoS {
    #[serde(rename = "quality:0")]
    AtMostOnce,
    #[serde(rename = "quality:1")]
    AtLeastOnce,
    #[serde(rename = "quality:2")]
    ExactlyOnce,
}

/// Extended fields the Form
#[serde_as]
#[skip_serializing_none]
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash, Default)]
pub struct Form {
    #[serde(
        rename = "mqv:retain",
        skip_serializing_if = "core::ops::Not::not",
        default
    )]
    pub retain: bool,
    #[serde(rename = "mqv:controlPacket")]
    pub control_packet: Option<ControlPacket>,
    #[serde(rename = "mqv:qos")]
    pub qos: Option<QoS>,
    #[serde(rename = "mqv:topic")]
    pub topic: Option<String>,
    #[serde(rename = "mqv:filter", skip_serializing_if = "Vec::is_empty", default)]
    #[serde_as(as = "OneOrMany<_>")]
    pub filter: Vec<String>,
}

/// MQTT Protocol extension
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash, Default)]
pub struct MqttProtocol {}

impl ExtendableThing for MqttProtocol {
    type InteractionAffordance = ();
    type PropertyAffordance = ();
    type ActionAffordance = ();
    type EventAffordance = ();
    type Form = Form;
    type ExpectedResponse = ();
    type DataSchema = ();
    type ObjectSchema = ();
    type ArraySchema = ();
}

#[cfg(test)]
mod test {
    use alloc::vec;

    use super::MqttProtocol;
    use crate::thing::Form;
    use crate::thing::{DefaultedFormOperations::Custom, FormOperation::*};

    fn deserialize_form(s: &str, r: Form<MqttProtocol>) {
        let f: crate::thing::Form<MqttProtocol> = serde_json::from_str(s).unwrap();
        assert_eq!(f, r);
    }

    #[test]
    fn simple_filter() {
        let s = r#"{
            "href": "mqtt://broker.com:1883",
            "op": [
                "subscribeevent",
                "unsubscribeevent"
            ],
            "mqv:filter": "thing1/events/overheating"
        }"#;

        let expected = Form {
            op: Custom(vec![SubscribeEvent, UnsubscribeEvent]),
            href: "mqtt://broker.com:1883".into(),
            other: super::Form {
                filter: vec!["thing1/events/overheating".into()],
                ..Default::default()
            },
            ..Default::default()
        };

        deserialize_form(s, expected);
    }

    #[test]
    fn complex_filter() {
        let s = r#"{
            "href": "mqtt://broker.com:1883",
            "op": [
                "readproperty",
                "observeproperty"
            ],
            "mqv:qos": "quality:1",
            "mqv:retain" : true,
            "mqv:filter": "application/devices/thing1/properties/test"
        }"#;

        let expected = Form {
            op: Custom(vec![ReadProperty, ObserveProperty]),
            href: "mqtt://broker.com:1883".into(),
            other: super::Form {
                qos: Some(super::QoS::AtLeastOnce),
                retain: true,
                filter: vec!["application/devices/thing1/properties/test".into()],
                ..Default::default()
            },
            ..Default::default()
        };

        deserialize_form(s, expected);
    }
}