Enum DeviceRoute 

pub enum DeviceRoute {
    Bolt {
        receiver_uid: String,
        slot: u8,
    },
    Unifying {
        receiver_uid: String,
        slot: u8,
    },
    Direct {
        vendor_id: u16,
        product_id: u16,
    },
    RawHid {
        vendor_id: u16,
        product_id: u16,
        usage_page: u16,
        usage_id: u16,
        identity: String,
    },
}

How to reach a controllable HID++ device.

Crosses the agent↔GUI IPC (every per-device RPC takes one), so variant and field order are wire format — changes require a PROTOCOL_VERSION bump (guarded by openlogi-ipc/tests/wire_format.rs).

Variants

Bolt

Paired to a Logi Bolt receiver. receiver_uid disambiguates multiple plugged-in receivers; slot is the device’s pairing slot (1..=6).

Fields

receiver_uid: String

Receiver unique ID used to select the physical Bolt receiver.

slot: u8

Pairing slot of the target device on that receiver.

Unifying

Paired to a Logi Unifying receiver. Same addressing structure as Bolt (receiver channel + pairing slot) but the receiver speaks HID++ 1.0.

Fields

receiver_uid: String

Receiver unique ID used to select the physical Unifying receiver.

slot: u8

Pairing slot of the target device on that receiver.

Direct

Attached straight to the host over USB cable or Bluetooth, addressed at the HID++ self-index. Re-found by matching the HID node’s vendor/product id — two identical mice on one host are indistinguishable here, so the first match wins (acceptable for v0).

Fields

vendor_id: u16

USB/HID vendor ID of the direct device.

product_id: u16

USB/HID product ID of the direct device.

RawHid

Standalone raw-HID device, such as a Litra light. The identity is an opaque transport-generated value used to disambiguate duplicate HID nodes; this route must never be passed to HID++ channel code.

Fields

vendor_id: u16

HID vendor ID.

product_id: u16

HID product ID.

usage_page: u16

HID usage page.

usage_id: u16

HID usage ID.

identity: String

Stable/opaque device identity selected during enumeration.

Implementations

impl DeviceRoute

pub fn shares_transport(&self, other: &DeviceRoute) -> bool

Whether two receiver routes use the same physical HID transport. Direct routes cannot prove identity because they carry only VID/PID.

pub fn device_index(&self) -> u8

The HID++ device index features are addressed at for this route: the pairing slot for a Bolt device, the self-index for a direct one.

pub fn device_route_for(inv: &DeviceInventory, slot: u8) -> Option<DeviceRoute>

Build the route that reaches a paired device from a receiver inventory.

Picks DeviceRoute::Unifying or DeviceRoute::Bolt based on the receiver’s product ID via speaks_unifying_protocol (Unifying proper plus protocol-compatible Lightspeed receivers). Any receiver that does not speak the Unifying protocol — including future Bolt variants whose PID isn’t yet in BOLT_PIDS — defaults to DeviceRoute::Bolt so writes keep working rather than silently dropping. DeviceRoute::Direct is used for directly-attached devices (slot == DIRECT_DEVICE_INDEX with no receiver UID). Returns None when the receiver UID is unknown (writes are skipped, not mis-routed).

Trait Implementations

impl Clone for DeviceRoute

fn clone(&self) -> DeviceRoute

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceRoute

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceRoute

fn deserialize<__D>( __deserializer: __D, ) -> Result<DeviceRoute, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DeviceRoute

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for DeviceRoute

impl PartialEq for DeviceRoute

fn eq(&self, other: &DeviceRoute) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for DeviceRoute

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeviceRoute