OpenLogi

0x1C00 · persistentRemappableAction

Read or write non-volatile, per-control and per-host HID action assignments.

persistentRemappableAction (0x1c00) stores a control's HID action in device non-volatile memory. It supports a separate mapping for each control and host slot. Its ControlId values are shared with 0x1b04.

When both features exist, a live 0x1b04 diversion takes precedence over this persistent mapping. The feature is relevant to Keyboard, but OpenLogi has no device, agent, CLI, or GUI consumer for it in v0.8.15.

Spec: No public Logitech specification. Layout reverse-engineered from Logi Options+ 2.8 (static analysis). Cross-checked: Solaar. Used by: Not used by OpenLogi.

Function reference

PersistentRemappableActionFeature implements 0x1c00.

Methods

FunctionHID++ fnSignatureReturns
get_feature_info0()RemappableCapabilities
get_count1()RemappableInfo
get_cid_info2(index: u8, host: HostIndex)ControlId
get_persistent_action3(cid: ControlId, host: HostIndex)PersistentAction
set_persistent_action4(cid: ControlId, host: HostIndex, config: PersistentActionConfig)()
reset_persistent_action5(cid: ControlId, host: HostIndex)()
reset_to_factory_settings6(hosts: HostMask)()

All methods are async. They return Result<…, Hidpp20Error>.

Types

RemappableCapabilities

FlagBitDescription
KEYBOARD_REPORT1 << 0Keyboard or keypad output.
MOUSE_BUTTONS1 << 1Mouse-button output.
X_DISPLACEMENT1 << 2Mouse X displacement.
Y_DISPLACEMENT1 << 3Mouse Y displacement.
VERTICAL_ROLLER1 << 4Vertical-roller output.
HORIZONTAL_ROLLER1 << 5Horizontal-roller or AC-pan output.
CONSUMER_CONTROL1 << 6Consumer-control output.
INTERNAL_FUNCTION1 << 7Internal-function output.
POWER_KEY1 << 8Power-key output.

RemappableInfo and HostIndex

TypeField or variantDescription
RemappableInfocount: u8Number of control IDs.
RemappableInfohost_count: u8Number of device host slots.
HostIndexCurrentCurrent device host. Encodes as 0xff.
HostIndexSlot(u8)Zero-based host slot.

PersistentAction

FieldTypeDescription
cidControlIdControl whose action was read.
hostHostIndexHost slot for this mapping.
action_idActionIdAction type.
valueu16Usage, displacement, or internal-function index.
modifier_maskModifierMaskKeyboard modifiers for keyboard actions.
statusPersistentActionStatusComplete response status byte.

PersistentAction::is_remapped() tests status bit 0.

PersistentActionConfig

FieldTypeDescription
action_idActionIdAction to store.
valueu16Usage, displacement, or internal-function index.
modifier_maskModifierMaskKeyboard modifiers for keyboard actions.

ActionId

VariantValueDescription
Empty0x00No output. A read response reports zero value and modifiers.
SendKeyboard0x01Keyboard or keypad report, HID usage page 7.
SendMouseButton0x02Mouse-button report, HID usage page 9.
SendXDisplacement0x03Mouse X displacement, usage page 1 code 0x30.
SendYDisplacement0x04Mouse Y displacement, usage page 1 code 0x31.
SendVerticalRoller0x05Vertical roller, usage page 1 code 0x38.
SendHorizontalRoller0x06Horizontal roller or AC pan, usage page 12 code 0x0238.
SendConsumerControl0x07Consumer-control report, HID usage page 12.
ExecuteInternalFunction0x08Internal function. value is its index.
SendPowerKey0x09Power-key report, HID usage page 1.

ModifierMask

FlagBitDescription
LEFT_CTRL1 << 0Left Control.
LEFT_SHIFT1 << 1Left Shift.
LEFT_ALT1 << 2Left Alt.
LEFT_GUI1 << 3Left GUI.
RIGHT_CTRL1 << 4Right Control.
RIGHT_SHIFT1 << 5Right Shift.
RIGHT_ALT1 << 6Right Alt.
RIGHT_GUI1 << 7Right GUI.

PersistentActionStatus

FlagBitDescription
REMAPPED1 << 0Action differs from its factory default.

PersistentActionStatus retains bits 1–7. Their meanings are unknown.

HostMask

FlagBitDescription
HOST_11 << 0Host 1.
HOST_21 << 1Host 2.
HOST_31 << 2Host 3.

Events

PersistentRemappableActionFeature does not implement an event listener.

Wire format

The tables use logical HID++ payload bytes. OpenLogi sends 3-byte short requests except for fn 4, which uses a 16-byte long request. Readers use an extended 16-byte response view and ignore bytes without a modeled field.

get_feature_info (fn 0)

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

Byte(s)FieldNotes
0–1RemappableCapabilitiesBE u16 bitfield.
2–15—No field is parsed by OpenLogi.

get_count (fn 1)

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

ByteFieldNotes
0countNumber of control IDs.
1host_countNumber of host slots.
2–15—No field is parsed by OpenLogi.

get_cid_info (fn 2)

Request: [index, host, 0x00]. host is HostIndex as u8; Current is 0xff and Slot(n) is n.

Byte(s)FieldNotes
0–1cidBE ControlId.
2–15—No field is parsed by OpenLogi.

get_persistent_action (fn 3)

Request: [cid_hi, cid_lo, host], where cid_hi,cid_lo are the ControlId as BE u16.

Byte(s)FieldNotes
0–1cidBE ControlId.
2hostHostIndex byte.
3action_idActionId, including Empty = 0x00.
4–5valueBE u16.
6modifier_maskModifierMask bits.
7 bit 0REMAPPEDKnown PersistentActionStatus bit. Options+ 2.8; Solaar.
7 bits 1–7unknown statusRetained by PersistentActionStatus; meaning is unverified. Options+ 2.8; Solaar.
8–15—No field is parsed by OpenLogi.

set_persistent_action (fn 4)

OpenLogi sends a 16-byte long request. It writes zero padding in bytes 7–15.

Byte(s)FieldNotes
0–1cidBE ControlId.
2hostHostIndex byte.
3action_idActionId.
4–5valueBE u16.
6modifier_maskModifierMask bits.
7–15—OpenLogi writes fixed zero padding.

OpenLogi returns () after the request succeeds. It does not parse a response body or read the action back.

reset_persistent_action (fn 5)

Request: [cid_hi, cid_lo, host], with ControlId in BE order. OpenLogi returns () and does not parse a response body.

reset_to_factory_settings (fn 6)

Request: [hosts_bits, 0x00, 0x00]. hosts_bits is HostMask; bits 0, 1, and 2 select HOST_1, HOST_2, and HOST_3. OpenLogi returns () and does not parse a response body.

How OpenLogi uses it

OpenLogi registers a typed wrapper for 0x1c00. It does not call this wrapper from openlogi-device, the agent, the CLI, or the GUI in v0.8.15. OpenLogi therefore does not write, reset, restore, or read back persistent actions.

Direct Rust callers must choose a supported action from RemappableCapabilities. They must also select the intended HostIndex. OpenLogi does not add a capability gate, a read-modify-write layer, or a post-write read-back around the wrapper.

Open questions

Only status bit 0 has a recovered meaning. Options+ 2.8 and Solaar retain the complete status byte, but they do not establish meanings for bits 1–7. OpenLogi preserves those unknown bits in PersistentActionStatus.

The protocol evidence is static. No hardware trace verifies status-bit meanings, the 0xff current-host sentinel, or device treatment of fn 4 padding.

Usage (Rust)

use hidpp::{
    device::Device,
    feature::{
        hosts_info::HostIndex,
        persistent_remappable_action::{
            ActionId, ModifierMask, PersistentActionConfig,
            PersistentRemappableActionFeature, RemappableCapabilities,
        },
    },
    protocol::v20::Hidpp20Error,
};

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

    let caps = feature.get_feature_info().await?;
    if !caps.contains(RemappableCapabilities::KEYBOARD_REPORT) {
        return Ok(());
    }
    let info = feature.get_count().await?;
    if info.count == 0 {
        return Ok(());
    }

    let host = HostIndex::Current;
    let cid = feature.get_cid_info(0, host).await?;
    let config = PersistentActionConfig {
        action_id: ActionId::SendKeyboard,
        value: 0x0006, // HID keycode for C.
        modifier_mask: ModifierMask::LEFT_CTRL,
    };
    feature.set_persistent_action(cid, host, config).await?;
    Ok(())
}

On this page