OpenLogi

0x0003 · deviceInformation

Read firmware entities, unit and model identifiers, transport flags, and an optional serial number.

deviceInformation supplies static identity metadata and firmware records. Feature versions add the unit ID, transport PIDs, extended model ID, and optional serial-number capability. OpenLogi uses this data while it probes an online device.

Spec: Logitech HID++ 2.0 — x0003 deviceInformation (v4). Cross-checked: Logi Options+ 2.8 (static analysis), Solaar. Used by: Supported devices and openlogi diag features.

Function reference

The DeviceInformationFeature wrapper implements feature version 0 and reads fields introduced by later feature versions.

Methods

FunctionHID++ fnSignatureReturns
get_device_info0()DeviceInformation
get_fw_info1(entity_index: u8)DeviceEntityFirmwareInfo
get_serial_number2()String

All methods are asynchronous and return Result<…, Hidpp20Error>. Callers should check capabilities.serial_number before calling get_serial_number.

Types

DeviceInformation

FieldTypeDescription
entity_countu8Number of firmware entities available through get_fw_info.
unit_id[u8; 4]Per-unit identifier. It is zero before feature version 1.
transportDeviceTransportSupported transports. It is zero before feature version 1.
model_id[u16; 3]Up to three application PIDs. It is zero before feature version 1.
extended_model_idu8Production-line attribute for the model, such as colour. It is zero before feature version 2.
capabilitiesDeviceInformationCapabilitiesFeature capabilities. It is false before feature version 4.

DeviceTransport

FieldBitDescription
usb3USB transport.
e_quad2eQuad transport, used by Unifying receivers.
btle1Bluetooth Low Energy transport, used by Bolt receivers.
bluetooth0Bluetooth transport.

DeviceInformationCapabilities

FieldBitDescription
serial_number0get_serial_number is available.

DeviceEntityFirmwareInfo

FieldTypeDescription
entity_typeDeviceEntityTypeFirmware-entity type, including an unnamed raw value.
firmware_prefixStringThree-byte UTF-8 firmware prefix. Invalid UTF-8 returns UnsupportedResponse.
firmware_numberu8First two decimal digits of the decoded version field.
revisionu8Last two decimal digits of the decoded version field.
buildu16Decoded four-digit build value.
activeboolBit 0 of the active byte.
transport_pidu16OpenLogi's BE interpretation of transport-specific bytes 9–10.
extra_version[u8; 5]OpenLogi's remaining transport-specific bytes 11–15.

A version and build field first decode as packed BCD. For a non-BCD field, OpenLogi reads the BE value as binary and caps it at 9999. It splits the decoded version into firmware_number = value / 100 and revision = value % 100.

DeviceEntityType

VariantValueDescription
MainApplication0Main application firmware.
Bootloader1Bootloader firmware.
Hardware2Hardware entity.
Touchpad3Touchpad entity.
OpticalSensor4Optical-sensor entity.
Softdevice5Bluetooth SoftDevice entity.
RfCompanionMcu6RF companion MCU entity.
FactoryApplication7Factory application entity.
RgbCustomEffect8RGB custom-effect entity.
MotorDrive9Motor-drive entity.
Other(u8)other valuesRaw entity type without a named OpenLogi variant. This includes protocol values 10–15.

Events

This feature does not define events.

Wire format

Each function sends a 3-byte short payload. OpenLogi parses replies through extend_payload(), which presents a 16-byte payload.

get_device_info (fn 0)

Request: [0x00, 0x00, 0x00]

ByteFieldNotes
0entity_countFirmware entity count.
1–4unit_idFour-byte unit ID.
5reservedOpenLogi ignores this byte.
6transportBits 3–0 are USB, eQuad, BTLE, and Bluetooth.
7–8model_id[0]Application PID, BE.
9–10model_id[1]Application PID, BE.
11–12model_id[2]Application PID, BE.
13extended_model_idExtended model attribute.
14capabilitiesBit 0 is serial_number.
15trailing payloadOpenLogi ignores this byte.

The three PID slots follow enabled transport bits in Bluetooth, BTLE, eQuad, then USB order. A device can report at most three PIDs. Solaar.

get_fw_info (fn 1)

Request: [entity_index, 0x00, 0x00]

ByteFieldNotes
0entity_type0 is main application, 1 bootloader, 2 hardware, and 3–15 are Other. OpenLogi retains unnamed values as Other(u8).
1–3firmware_prefixThree UTF-8 bytes.
4–5versionFour-digit version field, BE. Packed BCD is standard. OpenLogi accepts a non-BCD binary value and caps it at 9999.
6–7buildFour-digit build field, BE. Packed BCD is standard. OpenLogi accepts a non-BCD binary value and caps it at 9999.
8activeBit 0 is the active flag. OpenLogi ignores bits 1–7.
9–15transportLayer_Specific_infoSeven transport-specific bytes. The protocol does not define a generic PID field here. Options+ 2.8 and Solaar preserve this region as raw data.

OpenLogi preserves bytes 9–15 only as split fields. It labels bytes 9–10 as transport_pid (BE) and bytes 11–15 as extra_version. It does not expose one raw seven-byte field.

get_serial_number (fn 2)

Request: [0x00, 0x00, 0x00]

ByteFieldNotes
0–11serial numberTwelve UTF-8 bytes returned as String. Invalid UTF-8 returns UnsupportedResponse.
12–15trailing payloadOpenLogi ignores these bytes.

get_serial_number was introduced with feature version 4. The wrapper does not enforce that version gate. Inventory checks capability bit 0 before it calls the method.

How OpenLogi uses it

Inventory probing reads get_device_info() after feature enumeration. It stores the unit ID, transport flags, three PIDs, and extended model ID in DeviceModelInfo. It reads the serial number only when capability bit 0 is set.

openlogi diag features reads every entity from 0..entity_count. A refused entity or one with an invalid UTF-8 prefix becomes an Unreadable diagnostic row. A channel failure stops the diagnostic operation.

A failed identity read marks the probe incomplete. If a prior complete cache entry exists, OpenLogi restores its model information or serial number. These functions do not write device state.

Open questions

The protocol calls bytes 9–15 transport-layer-specific information. It does not establish that bytes 9–10 always form a PID. Options+ 2.8 and Solaar retain the region as raw data, while OpenLogi assigns it the transport_pid and extra_version fields.

Hardware capture has not established the meaning of this region for every entity and transport. The reference therefore shows the protocol field and the current OpenLogi API view separately.

Usage (Rust)

use hidpp::{
    device::Device,
    feature::device_information::DeviceInformationFeature,
    protocol::v20::Hidpp20Error,
};

async fn read_identity(device: &mut Device) -> Result<(), Hidpp20Error> {
    device.enumerate_features().await?;
    let Some(feature) = device.get_feature::<DeviceInformationFeature>() else {
        return Ok(());
    };

    let info = feature.get_device_info().await?;
    println!("unit ID: {:02x?}", info.unit_id);

    for entity in 0..info.entity_count {
        let firmware = feature.get_fw_info(entity).await?;
        println!("{entity}: {:?}, build {}", firmware.entity_type, firmware.build);
    }

    if info.capabilities.serial_number {
        println!("serial: {}", feature.get_serial_number().await?);
    }
    Ok(())
}

On this page