mirajazz 0.5.0

A library for interfacing with Mirabox and Ajazz stream controller devices
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

#[derive(Eq, PartialEq, Hash, Clone, Debug)]
pub struct DeviceInfo {
    pub vid: u16,
    pub pid: u16,
    pub serial_number: String,
}

impl DeviceInfo {
    pub fn new(vid: u16, pid: u16, serial_number: String) -> Self {
        Self {
            vid,
            pid,
            serial_number,
        }
    }
}

/// Connection / Disconnection event for watchers
#[derive(Eq, PartialEq, Hash, Clone, Debug)]
pub enum DeviceLifecycleEvent {
    Connected(DeviceInfo),
    Disconnected(DeviceInfo),
}

/// Type of input that the device produced
#[derive(Clone, Debug)]
pub enum DeviceInput {
    /// No data was passed from the device
    NoData,

    /// Button was pressed
    ButtonStateChange(Vec<bool>),

    /// Encoder/Knob was pressed
    EncoderStateChange(Vec<bool>),

    /// Encoder/Knob was twisted/turned
    EncoderTwist(Vec<i8>),
}

impl DeviceInput {
    /// Checks if there's data received or not
    pub fn is_empty(&self) -> bool {
        matches!(self, DeviceInput::NoData)
    }
}

/// Image format used by the device
#[derive(Copy, Clone, Debug, Hash)]
pub struct ImageFormat {
    /// Image format/mode
    pub mode: ImageMode,
    /// Image size
    pub size: (usize, usize),
    /// Image rotation
    pub rotation: ImageRotation,
    /// Image mirroring
    pub mirror: ImageMirroring,
}

impl Default for ImageFormat {
    fn default() -> Self {
        Self {
            mode: ImageMode::None,
            size: (0, 0),
            rotation: ImageRotation::Rot0,
            mirror: ImageMirroring::None,
        }
    }
}

/// Image rotation
#[derive(Copy, Clone, Debug, Hash)]
pub enum ImageRotation {
    /// No rotation
    Rot0,
    /// 90 degrees clockwise
    Rot90,
    /// 180 degrees
    Rot180,
    /// 90 degrees counter-clockwise
    Rot270,
}

/// Image mirroring
#[derive(Copy, Clone, Debug, Hash)]
pub enum ImageMirroring {
    /// No image mirroring
    None,
    /// Flip by X
    X,
    /// Flip by Y
    Y,
    /// Flip by both axes
    Both,
}

/// Image format
#[derive(Copy, Clone, Debug, Hash)]
pub enum ImageMode {
    /// No image
    None,
    /// Bitmap image
    BMP,
    /// Jpeg image
    JPEG,
}