openlogi-hidpp 0.6.21

OpenLogi's vendored fork of the `hidpp` crate (Logitech HID++ protocol).
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

//! The event emitted by the `Crown` feature (`0x4600`).

use num_enum::{IntoPrimitive, TryFromPrimitive};

/// Rotation phase reported in a [`CrownUpdate`].
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, IntoPrimitive, TryFromPrimitive)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
#[repr(u8)]
pub enum RotationState {
    /// Not rotating (or not diverted).
    Inactive = 0,
    /// Rotation started.
    Start = 1,
    /// Rotation ongoing.
    Active = 2,
    /// Rotation stopped.
    Stop = 3,
}

/// Proximity or touch activity phase reported in a [`CrownUpdate`].
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, IntoPrimitive, TryFromPrimitive)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
#[repr(u8)]
pub enum ActivityState {
    /// Inactive.
    Inactive = 0,
    /// Started.
    Start = 1,
    /// Ongoing.
    Active = 2,
    /// Stopped.
    Stop = 3,
}

/// Touch gesture reported in a [`CrownUpdate`].
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, IntoPrimitive, TryFromPrimitive)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
#[repr(u8)]
pub enum CrownGesture {
    /// No gesture.
    None = 0,
    /// Single tap.
    Tap = 1,
    /// Double tap.
    DoubleTap = 2,
}

/// Crown button state reported in a [`CrownUpdate`].
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, IntoPrimitive, TryFromPrimitive)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
#[repr(u8)]
pub enum ButtonState {
    /// Inactive (or not diverted).
    Inactive = 0,
    /// Press started.
    Press = 1,
    /// Short press active.
    ShortPressActive = 2,
    /// Long press reached the time threshold.
    LongPress = 3,
    /// Long press active.
    LongPressActive = 4,
    /// Released.
    Release = 5,
}

/// An event emitted by [`CrownFeature`](super::CrownFeature).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
pub enum CrownEvent {
    /// The crown's rotation, proximity, touch, gesture or button state changed.
    ///
    /// Only reported while the crown is diverted (see
    /// [`set_mode`](super::CrownFeature::set_mode)).
    Update(CrownUpdate),
}

/// Payload of [`CrownEvent::Update`].
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
pub struct CrownUpdate {
    /// Current rotation phase.
    pub rotation_state: RotationState,
    /// Slots rotated since the last event (`-127..=127`).
    pub relative_slot_rotation: i8,
    /// Ratchets rotated since the last event (`-127..=127`).
    pub relative_ratchet_rotation: i8,
    /// Proximity-sensor phase.
    pub proximity: ActivityState,
    /// Touch-sensor phase.
    pub touch: ActivityState,
    /// Touch gesture detected.
    pub gesture: CrownGesture,
    /// Button state.
    pub button: ButtonState,
    /// Crown speed in slots per second (signed).
    pub speed: i16,
}

/// Decodes the `0x4600` event payload by its sub-id.
pub(super) fn decode_event(sub_id: u8, payload: &[u8; 16]) -> Option<CrownEvent> {
    match sub_id {
        0 => Some(CrownEvent::Update(CrownUpdate {
            rotation_state: RotationState::try_from(payload[0]).ok()?,
            relative_slot_rotation: payload[1] as i8,
            relative_ratchet_rotation: payload[2] as i8,
            proximity: ActivityState::try_from(payload[3]).ok()?,
            touch: ActivityState::try_from(payload[4]).ok()?,
            gesture: CrownGesture::try_from(payload[5]).ok()?,
            button: ButtonState::try_from(payload[6]).ok()?,
            speed: i16::from_be_bytes([payload[14], payload[15]]),
        })),
        _ => None,
    }
}