openlogi_device/
write.rs

1//! HID++ reads and writes per feature — DPI, SmartShift, wheel modes,
2//! lighting, backlight, and diagnostics.
3//!
4//! Each entry point takes a [`DeviceRoute`] and resolves it to an open channel
5//! through `open_route_channel`, so the same call works whether the device is
6//! behind a Bolt receiver or attached directly (USB cable / Bluetooth). Each
7//! route-addressed call re-enumerates and re-opens, while the corresponding
8//! `_on` entry points reuse a [`crate::SharedChannel`] already owned by
9//! inventory or a standalone capture session.
10
11use std::sync::Arc;
12
13use hidpp::{channel::HidppChannel, device::Device, feature::CreatableFeature};
14
15use crate::backend::HidBackend;
16use crate::channel::route::{DeviceRoute, open_route_channel};
17
18mod backlight;
19mod diagnostics;
20mod dpi;
21mod error;
22mod fn_lock;
23mod haptic;
24mod hires_wheel;
25mod lighting;
26mod litra;
27mod smartshift;
28
29pub use backlight::{get_backlight, set_backlight_enabled};
30pub use diagnostics::{
31    FeatureEntry, FirmwareEntity, FirmwareEntityInfo, ReprogControlEntry, dump_features,
32    dump_firmware_entities, dump_reprog_controls, read_battery_raw,
33};
34pub use dpi::{
35    Dpi, DpiCapabilities, DpiInfo, get_dpi, get_dpi_info, get_dpi_info_on, set_dpi, set_dpi_on,
36};
37pub use error::{HidppFeatureErrorKind, HidppOperation, WriteError};
38pub use fn_lock::{set_fn_lock, set_fn_lock_on};
39pub(crate) use haptic::clear_haptic_feature_cache_for;
40pub use haptic::{
41    clear_haptic_feature_cache, ensure_haptics_armed_on, play_haptic, play_haptic_on,
42};
43pub use hidpp::feature::haptic_feedback::HapticWaveform;
44pub use hires_wheel::{
45    ScrollReportingTarget, ScrollResolution, ScrollWheelMode, get_scroll_wheel_mode,
46    get_scroll_wheel_mode_on, set_scroll_inversion, set_scroll_inversion_on, set_scroll_resolution,
47    set_scroll_resolution_on, set_scroll_wheel_mode, set_scroll_wheel_mode_on,
48};
49pub use lighting::{
50    LightingMethod, set_keyboard_color, set_keyboard_color_on, set_keyboard_color_with,
51    set_keyboard_color_with_on,
52};
53pub use litra::{
54    LITRA_BEAM_PRODUCT_ID, LITRA_GLOW_PRODUCT_ID, LightCommand, LitraModel, apply as apply_litra,
55    encode_command as encode_litra_command, matches_litra,
56};
57pub use smartshift::{
58    get_smartshift_status, get_smartshift_status_on, set_smartshift, set_smartshift_on,
59    set_smartshift_sensitivity, toggle_smartshift, toggle_smartshift_on,
60};
61
62// commands_for_light_settings operates purely on openlogi_core config/device
63// types with no HID++ I/O, so it lives in `openlogi_core::hid::light`;
64// re-exported here unchanged so this module's own API surface doesn't churn.
65pub use openlogi_core::hid::light::commands_for_light_settings;
66
67pub(crate) use error::classify_hidpp_error;
68
69/// Look up `F` on a device by HID++ feature ID, register it with
70/// [`Device::add_feature`], and return the typed wrapper.
71///
72/// The direct lookup via `root().get_feature(id)` returns the assigned index
73/// unconditionally; `add_feature` then attaches our wrapper to that index. This
74/// keeps route-based write/read paths independent from full feature-table
75/// enumeration and also works for feature wrappers that are not in the central
76/// registry yet.
77pub(crate) async fn open_feature<F: CreatableFeature + 'static>(
78    device: &mut Device,
79) -> Result<Arc<F>, WriteError> {
80    let info = device
81        .root()
82        .get_feature(F::ID)
83        .await
84        .map_err(|e| classify_hidpp_error(e, HidppOperation::ResolveFeature, F::ID))?
85        .ok_or(WriteError::FeatureUnsupported { feature_hex: F::ID })?;
86    Ok(device.add_feature::<F>(info.index))
87}
88
89/// Boilerplate-eater: open the channel that reaches `route`, then run `f` once
90/// with it. The caller addresses features at [`DeviceRoute::device_index`].
91pub(crate) async fn with_route<F, Fut, T>(
92    backend: &dyn HidBackend,
93    route: &DeviceRoute,
94    f: F,
95) -> Result<T, WriteError>
96where
97    F: FnOnce(Arc<HidppChannel>) -> Fut,
98    Fut: std::future::Future<Output = Result<T, WriteError>>,
99{
100    match open_route_channel(backend, route).await? {
101        Some(channel) => f(channel).await,
102        None => Err(WriteError::DeviceNotFound),
103    }
104}
105
106#[cfg(test)]
107mod tests;
openlogi_device/write.rs

openlogi_device/
write.rs
