0x0007 · deviceFriendlyName
Read or change a device-specific friendly name through 15-byte name chunks.
deviceFriendlyName stores a user-assigned label. It is separate from the fixed marketing name in 0x0005 deviceTypeAndName. The feature reads current and default names in 15-byte chunks and can write or reset the current name.
Spec: No public Logitech specification. Layout reverse-engineered from Logi Options+ 2.8 (static analysis). Used by: Not used by OpenLogi.
Function reference
The registered DeviceFriendlyNameFeature wrapper implements feature version 0.
Methods
| Function | HID++ fn | Signature | Returns |
|---|---|---|---|
get_friendly_name_length | 0 | () | DeviceFriendlyNameLength |
get_friendly_name | 1 | (index: u8) | [u8; 15] |
get_whole_friendly_name | convenience | () | String |
get_default_friendly_name | 2 | (index: u8) | [u8; 15] |
get_whole_default_friendly_name | convenience | () | String |
set_friendly_name | 3 | (index: u8, chunk: [u8; 15]) | u8 |
set_whole_device_name | convenience | (name: String) | u8 |
reset_friendly_name | 4 | () | u8 |
All methods are asynchronous and return Result<…, Hidpp20Error>. Convenience methods make several HID++ calls and have no single function index.
set_friendly_name returns the response's echoed charIndex. It does not return a name length. set_whole_device_name returns the number of input name bytes it sent after truncation.
Types
DeviceFriendlyNameLength
| Field | Type | Description |
|---|---|---|
name_length | u8 | Current name length reported by the device. |
name_max_length | u8 | Maximum writable name length reported by the device. |
default_name_length | u8 | Default-name length reported by the device. |
Events
No event layout is documented by the available evidence. OpenLogi does not register an event handler for this feature.
Wire format
Functions 0, 1, 2, and 4 use 3-byte short requests. Function 3 uses a 16-byte long request. Byte offsets below start after the HID++ feature header.
get_friendly_name_length (fn 0)
Request: [0x00, 0x00, 0x00]
| Byte | Field | Notes |
|---|---|---|
| 0 | name_length | Current friendly-name length. |
| 1 | name_max_length | Maximum writable friendly-name length. |
| 2 | default_name_length | Default friendly-name length. |
| 3–15 | trailing payload | OpenLogi ignores these bytes after extend_payload(). |
get_friendly_name (fn 1)
Request: [char_index, 0x00, 0x00]
| Byte | Field | Notes |
|---|---|---|
| 0 | char_index | Name offset at which the requested chunk starts. |
| 1–2 | reserved | OpenLogi writes 0x00. |
| Byte | Field | Notes |
|---|---|---|
| 0 | echoed char_index | OpenLogi logs a warning when this differs from the request. It keeps the chunk, as Options+ 2.8 does. |
| 1–15 | name chunk | Fifteen name bytes. OpenLogi copies these bytes into [u8; 15]. |
get_default_friendly_name (fn 2)
Request: [char_index, 0x00, 0x00]
| Byte | Field | Notes |
|---|---|---|
| 0 | char_index | Default-name offset at which the requested chunk starts. |
| 1–2 | reserved | OpenLogi writes 0x00. |
| Byte | Field | Notes |
|---|---|---|
| 0 | echoed char_index | OpenLogi logs a warning when this differs from the request. It keeps the chunk. Options+ 2.8. |
| 1–15 | default-name chunk | Fifteen default-name bytes. OpenLogi copies these bytes into [u8; 15]. |
OpenLogi uses extend_payload() for both read functions. A short reply is zero-extended before the wrapper copies bytes 1–15. The wrapper does not reject a short reply.
set_friendly_name (fn 3)
Request: [char_index, chunk[0], …, chunk[14]]
| Byte | Field | Notes |
|---|---|---|
| 0 | char_index | Name offset at which this chunk is written. |
| 1–15 | chunk | Exactly 15 name bytes. The whole-name helper zero-pads its final partial chunk. |
| Byte | Field | Notes |
|---|---|---|
| 0 | echoed char_index | set_friendly_name returns this raw byte. It is not a length. Options+ 2.8. |
| 1–15 | trailing payload | OpenLogi ignores these bytes. |
reset_friendly_name (fn 4)
Request: [0x00, 0x00, 0x00]
| Byte | Field | Notes |
|---|---|---|
| 0 | reported length | reset_friendly_name returns this byte. |
| 1–15 | trailing payload | OpenLogi ignores these bytes after extend_payload(). |
How OpenLogi uses it
The feature is registered when a device feature table advertises 0x0007. OpenLogi v0.8.15 has no device-layer, agent, IPC, CLI, or UI caller for this wrapper. It does not use the friendly name in inventory or cache identity.
The public whole-name reader obtains a length, reads chunks at its own offsets, and trims trailing NUL characters. A mismatched read echo creates a warning but does not fail the read.
The public whole-name writer reads name_max_length, trims the input at a UTF-8 character boundary, and sends padded chunks at offsets 0, 15, 30, and so on. It uses local offsets, not response bytes. A mismatched write echo creates a warning and does not stop later chunks. The writer does not read back the stored name.
Open questions
No public Logitech specification covers this feature. The known function numbers and echo fields come from static analysis of Options+ 2.8. Hardware capture has not verified all layouts.
The available evidence does not establish a feature-version gate or a rename notification event. It also does not establish device behavior for an empty name or a name that is exactly 15 bytes. OpenLogi writes no chunk for an empty input and recommends reset_friendly_name to restore the default.
Usage (Rust)
use hidpp::{
device::Device,
feature::device_friendly_name::DeviceFriendlyNameFeature,
protocol::v20::Hidpp20Error,
};
async fn inspect_or_rename(device: &mut Device) -> Result<(), Hidpp20Error> {
device.enumerate_features().await?;
let Some(feature) = device.get_feature::<DeviceFriendlyNameFeature>() else {
return Ok(());
};
println!("current name: {}", feature.get_whole_friendly_name().await?);
let bytes_written = feature.set_whole_device_name("Desk mouse".to_owned()).await?;
println!("sent {bytes_written} name bytes");
Ok(())
}