0x1C00 · persistentRemappableAction

Persistently remaps a device control to a different HID action, writing the mapping to the device's non-volatile memory. Controls are identified by the same ControlIds as 0x1B04 (reprogControls); when both features are present, a live divert from 0x1B04 takes precedence over a persistent remap here.

get_feature_info reports which HID output categories the device supports; get_count returns the number of remappable controls and host slots. get_cid_info enumerates the control table; get_persistent_action / set_persistent_action read and write a per-control, per-host mapping. reset_persistent_action restores one mapping to its factory default; reset_to_factory_settings clears all mappings for a selected set of host slots.

• ActionId — the action type a control produces: SendKeyboard, SendMouseButton, SendXDisplacement, SendYDisplacement, SendVerticalRoller, SendHorizontalRoller, SendConsumerControl, ExecuteInternalFunction, SendPowerKey.
• RemappableCapabilities — bitflags advertising which ActionId types the device can produce; returned by get_feature_info.
• ModifierMask — keyboard modifier flags (left/right Ctrl, Shift, Alt, GUI); applicable to SendKeyboard actions only.
• HostMask — selects one or more host slots (HOST_1–HOST_3) for reset_to_factory_settings.

Spec: Logitech HID++ 2.0 — persistentRemappableAction. Used by: Typed wrapper in openlogi-hidpp.

Function reference

The PersistentRemappableActionFeature wrapper (0x1c00) exposes:

Methods

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

Types

RemappableCapabilities

Bitflags advertising which HID output categories the device's persistent remapping can produce; returned by get_feature_info.

RemappableInfo

Control-table sizing returned by get_count.

PersistentAction

The action mapped to a control, returned by get_persistent_action.

PersistentActionConfig

The action to assign via set_persistent_action.

ActionId

The action a control performs when triggered.

ModifierMask

Standard keyboard modifier keys for a remapped keyboard action. Modifiers only apply to keyboard reports.

HostMask

A set of host slots for reset_to_factory_settings.

Wire format

Short getter requests carry a 3-byte zero payload; set_persistent_action uses a 16-byte long-payload request. All responses are read from the 16-byte long payload returned by .extend_payload().

get_feature_info (fn 0)

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

Response (byte → field):

get_count (fn 1)

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

Response (byte → field):

get_cid_info (fn 2)

Request: [index, host, 0x00]

Response (byte → field):

get_persistent_action (fn 3)

Request: [cid_hi, cid_lo, host] — ControlId split into two bytes big-endian, followed by the HostIndex byte.

Response (byte → field):

set_persistent_action (fn 4)

Uses call_long: a 16-byte request payload; bytes 7–15 are zero-padded.

No meaningful response body.

reset_persistent_action (fn 5)

Request: [cid_hi, cid_lo, host] — same layout as get_persistent_action request.

No meaningful response body.

reset_to_factory_settings (fn 6)

Request: [hosts_bits, 0x00, 0x00] — HostMask bitfield in byte 0; bits 0/1/2 select HOST_1/HOST_2/HOST_3.

No meaningful response body.

Usage (Rust)

use hidpp::{
    device::Device,
    feature::{
        hosts_info::HostIndex,
        persistent_remappable_action::{
            ActionId, ModifierMask, PersistentActionConfig, PersistentRemappableActionFeature,
        },
        reprog_controls::ControlId,
    },
};

// device: &mut Device, already created via Device::new(channel, device_index)
device.enumerate_features().await?;
if let Some(feat) = device.get_feature::<PersistentRemappableActionFeature>() {
    // Query device capabilities and table size.
    let caps = feat.get_feature_info().await?;
    let info = feat.get_count().await?;
    println!("caps={caps:?}, controls={}, hosts={}", info.count, info.host_count);

    // Read the current mapping for control 0x00c4 on host 0.
    let host = HostIndex::from(0u8);
    let cid = ControlId::from(0x00c4u16);
    let action = feat.get_persistent_action(cid, host).await?;
    println!("current action: {:?}", action.action_id);

    // Remap the control to send Ctrl+C (usage 0x06 = HID keycode for 'c').
    let config = PersistentActionConfig {
        action_id: ActionId::SendKeyboard,
        value: 0x0006,
        modifier_mask: ModifierMask::LEFT_CTRL,
    };
    feat.set_persistent_action(cid, host, config).await?;
}