twinleaf 1.8.0

Library for working with the Twinleaf I/O protocol and Twinleaf quantum sensors.
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
use crate::data::{DeviceDataParser, DeviceFullMetadata, Sample};
use crate::tio;
use proto::DeviceRoute;
use tio::{proto, proxy, util};

use std::collections::{HashMap, HashSet, VecDeque};

/// Events from a DeviceTree (multi-device monitoring).
#[derive(Debug, Clone)]
pub enum TreeEvent {
    /// First packet received from this route.
    RouteDiscovered(DeviceRoute),

    /// Event from a specific device.
    Device {
        route: DeviceRoute,
        event: super::device::DeviceEvent,
    },
}

#[derive(Debug, Clone)]
pub enum TreeItem {
    Sample(Sample, DeviceRoute),
    Event(TreeEvent),
}

pub struct DeviceTree {
    port: proxy::Port,
    root_route: DeviceRoute,
    parsers: HashMap<DeviceRoute, DeviceDataParser>,
    n_reqs: HashMap<DeviceRoute, usize>,
    known_routes: HashSet<DeviceRoute>,
    metadata_announced: HashSet<DeviceRoute>,
    sample_queue: VecDeque<(Sample, DeviceRoute)>,
    event_queue: VecDeque<TreeEvent>,
}

impl DeviceTree {
    pub fn new(port: proxy::Port, root_route: DeviceRoute) -> DeviceTree {
        DeviceTree {
            port,
            root_route,
            parsers: HashMap::new(),
            n_reqs: HashMap::new(),
            known_routes: HashSet::new(),
            metadata_announced: HashSet::new(),
            sample_queue: VecDeque::new(),
            event_queue: VecDeque::new(),
        }
    }

    pub fn open(
        proxy: &tio::proxy::Interface,
        route: DeviceRoute,
    ) -> Result<DeviceTree, proxy::PortError> {
        let port = proxy.subtree_full(route.clone())?;
        Ok(Self::new(port, route))
    }

    fn get_or_create_parser(&mut self, route: &DeviceRoute) -> &mut DeviceDataParser {
        self.parsers
            .entry(route.clone())
            .or_insert_with(|| DeviceDataParser::new(false))
    }

    fn internal_rpcs(&mut self) -> Result<(), proxy::SendError> {
        let routes: Vec<DeviceRoute> = self.parsers.keys().cloned().collect();

        for route in routes {
            let n_reqs = self.n_reqs.get(&route).copied().unwrap_or(0);

            if n_reqs == 0 {
                let parser = self.parsers.get_mut(&route).unwrap();
                let reqs = parser.requests();

                for mut req in reqs {
                    let rel = self
                        .root_route
                        .relative_route(&route)
                        .expect("parser routes must be under root_route");
                    req.routing = rel;

                    self.port.send(req)?;
                    *self.n_reqs.entry(route.clone()).or_insert(0) += 1;
                }
            }
        }

        Ok(())
    }

    fn process_packet(&mut self, pkt: &tio::Packet) {
        let absolute_route = self.root_route.absolute_route(&pkt.routing);

        if self.known_routes.insert(absolute_route.clone()) {
            self.event_queue
                .push_back(TreeEvent::RouteDiscovered(absolute_route.clone()));
        }

        match &pkt.payload {
            tio::proto::Payload::ProxyStatus(ps) => {
                self.event_queue.push_back(TreeEvent::Device {
                    route: absolute_route.clone(),
                    event: super::device::DeviceEvent::Status(ps.0),
                });

                // Forget our metadata on disconnect
                if matches!(ps.0, proto::ProxyStatus::SensorDisconnected) {
                    self.metadata_announced = HashSet::new();
                    self.parsers = HashMap::new();
                }

                // We might have new hash(es) on reconnect
                if matches!(ps.0, proto::ProxyStatus::SensorReconnected) {
                    for route in self.known_routes.iter() {
                        self.event_queue.push_back(TreeEvent::Device {
                            route: route.clone(),
                            event: super::device::DeviceEvent::NewHash(None),
                        });
                    }
                }

                return;
            }
            tio::proto::Payload::RpcUpdate(ru) => {
                self.event_queue.push_back(TreeEvent::Device {
                    route: absolute_route,
                    event: super::device::DeviceEvent::RpcInvalidated(ru.0.clone()),
                });
                return;
            }
            tio::proto::Payload::Heartbeat(hb) => {
                let session_id = match hb {
                    tio::proto::HeartbeatPayload::Session(sid) => Some(*sid),
                    tio::proto::HeartbeatPayload::Any(_) => None,
                };
                self.event_queue.push_back(TreeEvent::Device {
                    route: absolute_route.clone(),
                    event: super::device::DeviceEvent::Heartbeat { session_id },
                });
            }
            tio::proto::Payload::Settings(set) => {
                let hash = match set {
                    tio::proto::SettingsPayload::RpcHash(h) => Some(*h),
                    tio::proto::SettingsPayload::Unknown { .. } => None,
                };
                if let Some(hash) = hash {
                    self.event_queue.push_back(TreeEvent::Device {
                        route: absolute_route.clone(),
                        event: super::device::DeviceEvent::NewHash(Some(hash)),
                    });
                }
            }
            tio::proto::Payload::RpcReply(rep) => {
                if rep.id == 7855 {
                    if let Some(count) = self.n_reqs.get_mut(&absolute_route) {
                        *count = count.saturating_sub(1);
                    }
                }
            }
            tio::proto::Payload::RpcError(err) => {
                if err.id == 7855 {
                    if let Some(count) = self.n_reqs.get_mut(&absolute_route) {
                        *count = count.saturating_sub(1);
                    }
                }
            }
            _ => {}
        }

        let parser = self.get_or_create_parser(&absolute_route);
        let samples: Vec<Sample> = parser.process_packet(&pkt);

        for sample in samples {
            self.sample_queue
                .push_back((sample, absolute_route.clone()));
        }
        if !self.metadata_announced.contains(&absolute_route) {
            if let Some(parser) = self.parsers.get(&absolute_route) {
                if let Ok(full_metadata) = parser.get_metadata() {
                    self.metadata_announced.insert(absolute_route.clone());
                    self.event_queue.push_back(TreeEvent::Device {
                        route: absolute_route,
                        event: super::device::DeviceEvent::MetadataReady(full_metadata),
                    });
                }
            }
        }
    }

    pub fn get_metadata(
        &mut self,
        route: DeviceRoute,
    ) -> Result<DeviceFullMetadata, tio::proxy::RpcError> {
        loop {
            let n_reqs = self.n_reqs.get(&route).copied().unwrap_or(0);

            if n_reqs == 0 {
                let parser = self.get_or_create_parser(&route);
                match parser.get_metadata() {
                    Ok(full_meta) => {
                        return Ok(full_meta);
                    }
                    Err(reqs) => {
                        for mut req in reqs {
                            req.routing = route.clone();
                            self.port
                                .send(req)
                                .map_err(tio::proxy::RpcError::SendFailed)?;
                            *self.n_reqs.entry(route.clone()).or_insert(0) += 1;
                        }
                    }
                }
            }
            let pkt = self.port.recv().map_err(tio::proxy::RpcError::RecvFailed)?;
            self.process_packet(&pkt);
        }
    }

    pub fn next(&mut self) -> Result<(Sample, DeviceRoute), tio::proxy::RpcError> {
        loop {
            if let Some(sample) = self.sample_queue.pop_front() {
                return Ok(sample);
            }
            self.internal_rpcs()
                .map_err(tio::proxy::RpcError::SendFailed)?;

            let pkt = self.port.recv().map_err(tio::proxy::RpcError::RecvFailed)?;

            self.process_packet(&pkt);
        }
    }

    pub fn try_next(&mut self) -> Result<Option<(Sample, DeviceRoute)>, tio::proxy::RpcError> {
        loop {
            if let Some(sample) = self.sample_queue.pop_front() {
                return Ok(Some(sample));
            }
            self.internal_rpcs()
                .map_err(tio::proxy::RpcError::SendFailed)?;

            let pkt = match self.port.try_recv() {
                Ok(pkt) => pkt,
                Err(proxy::RecvError::WouldBlock) => return Ok(None),
                Err(e) => return Err(tio::proxy::RpcError::RecvFailed(e)),
            };

            self.process_packet(&pkt);
        }
    }

    pub fn drain(&mut self) -> Result<Vec<(Sample, DeviceRoute)>, tio::proxy::RpcError> {
        loop {
            self.internal_rpcs()
                .map_err(tio::proxy::RpcError::SendFailed)?;
            match self.port.try_recv() {
                Ok(pkt) => {
                    self.process_packet(&pkt);
                }
                Err(proxy::RecvError::WouldBlock) => {
                    break;
                }
                Err(e) => {
                    return Err(tio::proxy::RpcError::RecvFailed(e));
                }
            }
        }

        Ok(self.sample_queue.drain(..).collect())
    }

    pub fn try_next_event(&mut self) -> Option<TreeEvent> {
        self.event_queue.pop_front()
    }

    pub fn drain_events(&mut self) -> Vec<TreeEvent> {
        self.event_queue.drain(..).collect()
    }

    pub fn next_item(&mut self) -> Result<TreeItem, proxy::RpcError> {
        loop {
            if let Some((sample, route)) = self.sample_queue.pop_front() {
                return Ok(TreeItem::Sample(sample, route));
            }

            if let Some(event) = self.event_queue.pop_front() {
                return Ok(TreeItem::Event(event));
            }

            self.internal_rpcs()?;
            let pkt = self.port.recv()?;
            self.process_packet(&pkt);
        }
    }

    pub fn try_next_item(&mut self) -> Result<Option<TreeItem>, proxy::RpcError> {
        loop {
            if let Some((sample, route)) = self.sample_queue.pop_front() {
                return Ok(Some(TreeItem::Sample(sample, route)));
            }

            if let Some(event) = self.event_queue.pop_front() {
                return Ok(Some(TreeItem::Event(event)));
            }

            self.internal_rpcs()?;
            match self.port.try_recv() {
                Ok(pkt) => self.process_packet(&pkt),
                Err(proxy::RecvError::WouldBlock) => return Ok(None),
                Err(e) => return Err(e.into()),
            }
        }
    }

    pub fn raw_rpc(
        &mut self,
        route: DeviceRoute,
        name: &str,
        arg: &[u8],
    ) -> Result<Vec<u8>, tio::proxy::RpcError> {
        let mut req = util::PacketBuilder::make_rpc_request(name, arg, 0, DeviceRoute::root());
        let relative_routing = match self.root_route.relative_route(&route) {
            Ok(r) => r,
            Err(_) => {
                req.routing = route;
                return Err(tio::proxy::RpcError::SendFailed(
                    tio::proxy::SendError::InvalidRoute(req),
                ));
            }
        };

        req.routing = relative_routing;

        if let Err(err) = self.port.send(req) {
            return Err(tio::proxy::RpcError::SendFailed(err));
        }

        loop {
            self.internal_rpcs()
                .map_err(tio::proxy::RpcError::SendFailed)?;
            let pkt = match self.port.recv() {
                Ok(packet) => packet,
                Err(e) => return Err(tio::proxy::RpcError::RecvFailed(e)),
            };

            let absolute_route = self.root_route.absolute_route(&pkt.routing);

            if absolute_route == route {
                match &pkt.payload {
                    tio::proto::Payload::RpcReply(rep) if rep.id != 7855 => {
                        return Ok(rep.reply.clone());
                    }
                    tio::proto::Payload::RpcError(err) if err.id != 7855 => {
                        return Err(tio::proxy::RpcError::ExecError(err.clone()));
                    }
                    _ => {}
                }
            }

            self.process_packet(&pkt);
        }
    }

    pub fn rpc<ReqT: tio::util::TioRpcRequestable<ReqT>, RepT: tio::util::TioRpcReplyable<RepT>>(
        &mut self,
        route: DeviceRoute,
        name: &str,
        arg: ReqT,
    ) -> Result<RepT, tio::proxy::RpcError> {
        let ret = self.raw_rpc(route, name, &arg.to_request())?;
        if let Ok(val) = RepT::from_reply(&ret) {
            Ok(val)
        } else {
            Err(tio::proxy::RpcError::TypeError)
        }
    }

    pub fn action(&mut self, route: DeviceRoute, name: &str) -> Result<(), tio::proxy::RpcError> {
        self.rpc(route, name, ())
    }

    pub fn get<T: tio::util::TioRpcReplyable<T>>(
        &mut self,
        route: DeviceRoute,
        name: &str,
    ) -> Result<T, tio::proxy::RpcError> {
        self.rpc(route, name, ())
    }

    pub fn get_multi(
        &mut self,
        route: DeviceRoute,
        name: &str,
    ) -> Result<Vec<u8>, tio::proxy::RpcError> {
        let mut full_reply = vec![];

        for i in 0u16..=65535u16 {
            match self.raw_rpc(route.clone(), &name, &i.to_le_bytes().to_vec()) {
                Ok(mut rep) => full_reply.append(&mut rep),
                Err(err @ proxy::RpcError::ExecError(_)) => {
                    if let proxy::RpcError::ExecError(payload) = &err {
                        if let tio::proto::RpcErrorCode::InvalidArgs = payload.error {
                            break;
                        }
                    }
                    return Err(err);
                }
                Err(e) => {
                    return Err(e);
                }
            }
        }

        Ok(full_reply)
    }

    pub fn get_multi_str(
        &mut self,
        route: DeviceRoute,
        name: &str,
    ) -> Result<String, tio::proxy::RpcError> {
        let reply_bytes = self.get_multi(route, name)?;
        let result_string = String::from_utf8_lossy(&reply_bytes).to_string();
        Ok(result_string)
    }

    pub fn known_routes(&self) -> Vec<DeviceRoute> {
        self.parsers.keys().cloned().collect()
    }
}