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
//! Implements the `DisableKeys` feature (ID `0x4521`) that disables a fixed set
//! of lock / system keys.
//!
//! For disabling arbitrary keys by HID usage, see
//! [`DisableKeysByUsage`](super::disable_keys_by_usage) (`0x4522`).
use openlogi_hidpp_derive::Feature;
use crate::{feature::FeatureEndpoint, protocol::v20::Hidpp20Error};
bitflags::bitflags! {
/// The set of keys a [`DisableKeysFeature`] device can disable.
///
/// Used both for the device's capabilities and for the currently disabled
/// keys.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct DisableableKeys: u8 {
/// The Caps Lock key.
const CAPS_LOCK = 1 << 0;
/// The Num Lock key.
const NUM_LOCK = 1 << 1;
/// The Scroll Lock key.
const SCROLL_LOCK = 1 << 2;
/// The Insert key.
const INSERT = 1 << 3;
/// The Windows / Start key.
const WINDOWS = 1 << 4;
}
}
/// Implements the `DisableKeys` / `0x4521` feature.
#[derive(Clone, Feature)]
#[creatable(id = 0x4521, version = 0)]
pub struct DisableKeysFeature {
/// The endpoint this feature talks to.
endpoint: FeatureEndpoint,
}
impl DisableKeysFeature {
/// Whether an unsolicited report with `function_id` announces that the
/// disabled-key set changed, such as software on another host replacing
/// it.
///
/// Reverse-engineered, not from the spec: Logi Options+ 2.8 turns an
/// unsolicited function-2 report — the [`Self::set_disabled_keys`] id —
/// into a setting change and reads byte 0 as the new mask. No
/// specification or capture confirms that layout, so the payload is not
/// decoded: a listener re-reads the set with [`Self::get_disabled_keys`].
#[must_use]
pub const fn is_state_broadcast(function_id: u8) -> bool {
function_id == 2
}
/// Retrieves the set of keys the device allows software to disable.
pub async fn get_capabilities(&self) -> Result<DisableableKeys, Hidpp20Error> {
let payload = self.endpoint.call(0, [0; 3]).await?.extend_payload();
Ok(DisableableKeys::from_bits_retain(payload[0]))
}
/// Retrieves the set of keys currently disabled.
pub async fn get_disabled_keys(&self) -> Result<DisableableKeys, Hidpp20Error> {
let payload = self.endpoint.call(1, [0; 3]).await?.extend_payload();
Ok(DisableableKeys::from_bits_retain(payload[0]))
}
/// Replaces the set of disabled keys and returns the device's echo.
///
/// This replaces the whole set, so passing [`DisableableKeys::empty`]
/// re-enables every key. The device rejects keys it cannot disable.
pub async fn set_disabled_keys(
&self,
keys: DisableableKeys,
) -> Result<DisableableKeys, Hidpp20Error> {
let payload = self
.endpoint
.call(2, [keys.bits(), 0, 0])
.await?
.extend_payload();
Ok(DisableableKeys::from_bits_retain(payload[0]))
}
}