burble 0.2.2

A cross-platform user-mode Bluetooth LE library
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

//! Human Interface Device API ([HID]).
//!
//! See [HID] and [HUT] for official documentation.
//!
//! [HID]: https://www.usb.org/sites/default/files/hid1_11.pdf
//! [HUT]: https://www.usb.org/sites/default/files/hut1_4.pdf

use std::collections::VecDeque;

pub mod descriptor;
pub mod kbd;
pub mod mouse;
pub mod usage;

/// Collection of HID report descriptor items that can be converted to a byte
/// vector.
pub type ReportDescriptor = descriptor::Items;

/// Basic HID.
pub trait Dev {
    /// Resets the device state.
    fn reset(&mut self);

    /// Returns a description of device report types and data formats.
    fn report_descriptor(&self, report_id: u8) -> ReportDescriptor;
}

/// HID that generates input reports.
pub trait InputDev: Dev {
    /// Length of the slice returned by [`Self::input()`].
    const IN_LEN: u8;

    /// Polls for the next input report and returns true if a new report is
    /// available.
    fn poll(&mut self) -> bool;

    /// Returns the current input report.
    fn input(&self) -> &[u8];
}

/// HID that receives output reports.
pub trait OutputDev: Dev {
    /// Length of the slice expected by [`Self::set_output()`].
    const OUT_LEN: u8;

    /// Sets the current output report.
    fn set_output(&mut self, v: &[u8]);

    /// Returns the current output report.
    fn output(&self) -> &[u8];
}

/// Helper type for implementing [`InputDev`].
#[derive(Debug)]
struct InputBuf<const N: usize> {
    v: [u8; N],
    b: VecDeque<[u8; N]>,
}

impl<const N: usize> InputBuf<N> {
    fn reset(&mut self) {
        self.v.fill(0);
        self.b.clear();
    }

    fn poll(&mut self) -> bool {
        if let Some(v) = self.b.pop_front() {
            self.v = v;
            return true;
        }
        if self.v.into_iter().any(|v| v != 0) {
            self.v.fill(0);
            return true;
        }
        false
    }

    const fn input(&self) -> &[u8] {
        &self.v
    }

    fn add_input(&mut self, v: [u8; N]) {
        self.b.push_back(v);
    }

    fn last_input(&self) -> [u8; N] {
        *self.b.back().unwrap_or(&self.v)
    }
}

impl<const N: usize> Default for InputBuf<N> {
    fn default() -> Self {
        Self {
            v: [0; N],
            b: VecDeque::new(),
        }
    }
}