openlogi.org

mx

route3.mx.cloudflare.net

route2.mx.cloudflare.net

route1.mx.cloudflare.net

ns

lou.ns.cloudflare.com

jule.ns.cloudflare.com

caa

txt

v=spf1 include:_spf.mx.cloudflare.net ~all

dmarc

v=DMARC1; p=none; rua=mailto:df0d07b97c3f4af2bae38585524f495c@dmarc-reports.cloudflare.net

User-Agent: *
Allow: /

Sitemap: https://openlogi.org/sitemap.xml

# Docs

- Documentation

  - **Quick Start**
  - [Introduction](/docs): A native, local-first alternative to Logitech Options+, written in Rust. No account, no telemetry.
  - [Installation](/docs/installation): How to install OpenLogi on macOS, Linux, or Windows via Homebrew, package manager, or direct download.
  - [Supported devices](/docs/supported-devices): The Logitech mice, keyboards, trackballs, lights, and webcams OpenLogi drives.

  - **Guides**
  - [Connect a device](/docs/connect-device): How to connect a Logitech device via receiver, Bluetooth, or USB and verify it appears in OpenLogi.
  - [Features](/docs/features): An overview of OpenLogi's features with links to each user-guide section.
  - [Actions Ring](/docs/features/actions-ring): Open an eight-slot radial launcher at the cursor, with per-app layouts, custom icons and labels, and device haptics.
  - [Per-app profiles](/docs/features/profiles): Switch mouse bindings with the pointer or focus, and use complete Actions Ring layouts for each focused app.

  - **Mouse**
  - [DPI presets](/docs/features/mouse/dpi): Set pointer resolution and manage an ordered DPI preset list that cycles from a hardware button.
  - [Scrolling](/docs/features/mouse/scrolling): Tune physical-wheel smoothing and sensitivity, per-device wheel behavior, and native thumb-wheel directions.
  - [SmartShift](/docs/features/mouse/smartshift): Control scroll-wheel mode between ratchet and free-spin, set the auto-release threshold, and bind the toggle to a button.
  - [Remap buttons](/docs/features/mouse/remap-buttons): Reassign mouse buttons, edit per-app overrides, and configure supported gestures from the interactive diagram or config file.

  - **Other devices**
  - Keyboards
    - [Keyboards](/docs/features/keyboard): Remap a Logitech keyboard's F-row over HID++, remap any keyboard's function keys through the OS hook, and control Fn-lock and host switching.
    - [Keyboard lighting](/docs/features/keyboard/lighting): Set a static RGB colour on a Logitech keyboard, and switch the white MX Keys backlight on or off.
  - [Litra lights](/docs/features/lights): Control a Litra light's power, brightness, colour temperature, and camera-linked auto-power.
  - [Webcams](/docs/features/webcams): Preview a Logitech webcam and adjust its device-level UVC image controls and profiles.

  - **Reference**
  - [Command line](/docs/cli): Inspect devices and use OpenLogi's JSON API to control DPI, SmartShift, and Fn lock from scripts.
  - [Configuration](/docs/configurations): Reference for the TOML config file: location, schema, all keys, actions, and gesture bindings.
  - Devices
    - [MX Master 4](/docs/devices/mx-master-4): Every control OpenLogi drives on the MX Master 4, the HID++ feature behind each one, and the config.toml that binds them.

  - **Project**
  - [Roadmap](/docs/project/roadmap): A feature-by-feature status table showing what OpenLogi supports today and what is still in progress.
  - [Architecture](/docs/project/architecture): How OpenLogi's desktop, agent, overlay, CLI, shared crates, and hardware boundaries fit together.
  - [Contributing](/docs/project/contributing): How to get the source, build from it, and contribute testing or code to OpenLogi.
  - [Changelog](/docs/changelog): Every OpenLogi release, pulled from the project's GitHub Releases.
- HID++ Reference
  - [HID++ Reference](/hidpp): Logitech's vendor protocol for configuring mice, keyboards, and receivers over USB HID. The same protocol Options+ uses, spoken directly by OpenLogi.
  - [Receivers](/hidpp/receivers): The USB dongles that wireless Logitech devices pair to, driven through HID++ 1.0 registers and identified by USB vendor/product ID.
  - [Model IDs](/hidpp/model-ids): Model IDs in Logitech's asset registry and the products they identify
  - Features
    - [Index](/hidpp/features): The catalogue of HID++ 2.0 features, each identified by a 16-bit ID, with per-feature support status in OpenLogi.
    - [0x0000 · root](/hidpp/features/x0000-root): The HID++ 2.0 entry point — map a feature ID to its session index and verify the link with a ping.
    - [0x0001 · featureSet](/hidpp/features/x0001-featureset): Enumerate all features a device implements — read the count and look up each feature's ID, type flags, and version by index.
    - [0x0003 · deviceInformation](/hidpp/features/x0003-device-information): Read static device metadata — firmware entity count and version per entity, unit ID, model ID, transport flags, and optional serial number.
    - [0x0005 · deviceTypeAndName](/hidpp/features/x0005-device-type-and-name): Read a device's marketing category (mouse, keyboard, trackball, …) and its full marketing name, retrieved in chunks.
    - [0x0007 · deviceFriendlyName](/hidpp/features/x0007-device-friendly-name): Read or write the user-assigned friendly name of a device, and reset it to the factory default.
    - [0x00c2 · dfuControlSigned](/hidpp/features/x00c2-dfu-control-signed): Gate entry into DFU mode with a cryptographic signature check before a firmware image transfer can begin.
    - [0x00d0 · dfu](/hidpp/features/x00d0-dfu): Stream a signed firmware image to a device already in DFU mode — write chunks, track progress, and trigger verification and restart.
    - [0x1000 · batteryStatus](/hidpp/features/x1000-battery-status): The legacy battery feature — a coarse discharge level plus charging status, used by older mice that never expose 0x1004 unifiedBattery.
    - [0x1001 · batteryVoltage](/hidpp/features/x1001-battery-voltage): Battery state as a measured millivolt reading plus charging flags — the only battery source on many G-series wireless devices.
    - [0x1004 · unifiedBattery](/hidpp/features/x1004-unified-battery): Modern unified battery feature — query charge percentage, coarse level, and charging status, with live push events.
    - [0x1010 · chargingControl](/hidpp/features/x1010-charging-control): Read and configure a rechargeable device's charging behaviour — including charge-limit modes that cap the maximum charge level for battery health.
    - [0x1802 · deviceReset](/hidpp/features/x1802-device-reset): Trigger a firmware soft reset on a HID++ 2.0 peripheral — equivalent to a power cycle, used in firmware-update and recovery workflows.
    - [0x1805 · oobState](/hidpp/features/x1805-oob-state): Query or restore a device's out-of-box (factory-default) state — useful for detecting first-run devices or resetting provisioning state.
    - [0x1814 · changeHost](/hidpp/features/x1814-change-host): Query the number of host slots on a multi-host device and switch the active connection — with per-slot cookie management for enhanced fallback behaviour.
    - [0x1815 · hostsInfo](/hidpp/features/x1815-hosts-info): Rich multi-host management for Bolt/BLE/eQuad devices — enumerate host slots, query pairing status and bus type, and read raw transport descriptors.
    - [0x1981 · backlight](/hidpp/features/x1981-backlight1): First-generation keyboard backlight control — query and set the on/off state, brightness level, and ambient-light sensor mode.
    - [0x1982 · backlight](/hidpp/features/x1982-backlight): Full keyboard backlight control — read or write persistent config (mode, brightness, effects, fade-out timers) and subscribe to hardware change events.
    - [0x1990 · illumination](/hidpp/features/x1990-illumination): Device illumination control — toggle the light on or off and independently read or write brightness (Lumens) and color temperature (Kelvin).
    - [0x19b0 · hapticFeedback](/hidpp/features/x19b0-haptic-feedback): Device haptic actuator control — capabilities, enable state and intensity, and playing a typed waveform, as used by the MX Master 4's Actions Ring.
    - [0x1a00 · presenterControl](/hidpp/features/x1a00-presenter-control): Presenter remote control interface — enumerate slide-navigation buttons and divert their events to host software instead of default HID reports.
    - [0x1b00 · reprogControls](/hidpp/features/x1b00-reprog-controls): Early-generation control enumeration and diversion — query the device's programmable button table and redirect individual controls to HID++ events.
    - [0x1B04 · specialKeysMSEButtons](/hidpp/features/x1b04-special-keys-mse-buttons): Full control enumeration and diversion — enumerate every button and key, then divert, persistently remap, or stream raw pointer and wheel events per control.
    - [0x1C00 · persistentRemappableAction](/hidpp/features/x1c00-persistent-remappable-action): Non-volatile control remapping — read or write per-control, per-host action assignments (keys, mouse buttons, consumer codes, internal functions) stored in device memory.
    - [0x1D4B · wirelessDeviceStatus](/hidpp/features/x1d4b-wireless-device-status): Event-only feature that fires a status broadcast when the wireless link changes — signalling reconnection and optionally requesting a host software reconfiguration.
    - [0x2001 · swapLeftRightButton](/hidpp/features/x2001-swap-left-right-button): Swap the primary and secondary mouse buttons at the firmware level — making the device behave as a left-handed mouse without any OS-level remapping.
    - [0x2100 · verticalScrolling](/hidpp/features/x2100-vertical-scrolling): Read the physical characteristics of the vertical scroll wheel — roller type, ratchets per turn, and the device's preferred scroll quantum.
    - [0x2110 · smartShift](/hidpp/features/x2110-smartshift): Read or write the scroll wheel mode (free-spin or ratchet) and the speed threshold at which the wheel automatically disengages into free-spin.
    - [0x2111 · smartShiftEnhanced](/hidpp/features/x2111-smartshift-enhanced): Enhanced SmartShift — read or write the wheel mode, auto-disengage speed threshold, and tunable ratchet torque on current MX-line mice.
    - [0x2120 · highResolutionScrolling](/hidpp/features/x2120-high-resolution-scrolling): Older feature for querying and enabling fine-grained high-resolution wheel reporting — a predecessor to 0x2121 hiResWheel without ratchet-mode switching.
    - [0x2121 · hiResWheel](/hidpp/features/x2121-hires-wheel): High-resolution scroll wheel — read capabilities, get or set the wheel mode (resolution, ratchet vs. free-spin, event routing), and listen for diverted scroll and ratchet-switch events.
    - [0x2150 · thumbwheel](/hidpp/features/x2150-thumbwheel): Horizontal thumb-wheel control — query capabilities, divert rotation events from HID to HID++, and read touch and tap status.
    - [0x2200 · mousePointer](/hidpp/features/x2200-mouse-pointer): Read optical-sensor resolution and pointer-tuning hints — acceleration curve, OS-ballistics preference, and vertical-tuning suggestion.
    - [0x2201 · adjustableDpi](/hidpp/features/x2201-adjustable-dpi): Per-sensor pointer resolution — read the sensor count, enumerate supported DPI values, and read or write the active DPI.
    - [0x2202 · extendedAdjustableDpi](/hidpp/features/x2202-extended-adjustable-dpi): Extended per-sensor DPI control — independent X/Y resolution, lift-off distance, DPI-status LED, and firmware or host-side calibration.
    - [0x40a0 · fnInversion](/hidpp/features/x40a0-fn-inversion): Earliest Fn-lock feature — read or write whether F-row keys act as function keys or secondary media/action keys by default.
    - [0x40A2 · fnInversionWithDefaultState](/hidpp/features/x40a2-fn-inversion): Single-host Fn-lock toggle — read or write the global function-key inversion state alongside the device's factory default.
    - [0x40A3 · fnInversionMultiHost](/hidpp/features/x40a3-fn-inversion-multi-host): Per-host-slot Fn-lock control — read or write the function-key inversion state independently for each paired host slot.
    - [0x4301 · solarKeyboardDashboard](/hidpp/features/x4301-solar-keyboard-dashboard): Battery and ambient-light monitoring for solar keyboards — schedule periodic light-measure reports, override the CheckLight LED color, and receive battery and lux broadcast events.
    - [0x4520 · keyboardLayout](/hidpp/features/x4520-keyboard-layout): Query or override the physical keyboard locale — identifies the regional key-cap arrangement (QWERTY, AZERTY, QWERTZ, etc.) stored in the device.
    - [0x4521 · disableKeys](/hidpp/features/x4521-disable-keys): Selectively disable a fixed set of lock and system keys — query device capabilities, read the active disabled-key mask, and atomically replace it.
    - [0x4522 · disableKeysByUsage](/hidpp/features/x4522-disable-keys-by-usage): Disable or re-enable arbitrary keyboard keys by HID usage code — cumulatively add or remove usages from the disabled set, or clear all at once.
    - [0x4530 · dualPlatform](/hidpp/features/x4530-dual-platform): Persist and switch a device's HID key-code table between two OS families (iOS/macOS vs. Android/Windows) — read or write the selection and receive hardware-button change events.
    - [0x4531 · multiPlatform](/hidpp/features/x4531-multi-platform): Associate each host slot with an OS platform on a multi-host device — query feature capabilities and platform descriptors, and read the platform assigned to any host slot.
    - [0x4600 · crown](/hidpp/features/x4600-crown): Control the MX Master rotary crown — query hardware capabilities, read or write reporting and ratchet mode, and receive diverted rotation, touch, gesture, and button events.
    - [0x6020 · tapEnable](/hidpp/features/x6020-tap-enable): Read or write the tap-to-click enabled state of an integrated or standalone touchpad.
    - [0x6100 · touchpadRawXY](/hidpp/features/x6100-touchpad-raw-xy): Stream raw multi-touch finger coordinates from an integrated touchpad — query pad dimensions and DPI, configure report flags, and receive per-frame touch events.
    - [0x6110 · touchMouseRawTouchPoints](/hidpp/features/x6110-touch-mouse-raw): Access raw touch-point data from a touch mouse — query pad geometry, select a raw reporting mode, and receive up to four simultaneous finger contacts per event.
    - [0x6500 · gestures](/hidpp/features/x6500-gestures1): First-generation touch-gesture API — enumerate supported gesture types, enable or disable gesture delivery, and receive classified gesture events from a touch surface.
    - [0x6501 · gestures2](/hidpp/features/x6501-gestures2): The legacy gesture-descriptor table — how OpenLogi finds and diverts the MX Master 2S thumb wheel, which predates the dedicated 0x2150 feature.
    - [0x8010 · gamingGKeys](/hidpp/features/x8010-gaming-g-keys): Query and configure the programmable G-keys on a Logitech gaming keyboard — read the key count, read or write per-key assignments, and receive G-key press events.
    - [0x8020 · gamingMKeys](/hidpp/features/x8020-gaming-m-keys): Control the M-key macro-bank buttons on a Logitech gaming keyboard — query or set the active profile bank and receive bank-change events from the device.
    - [0x8030 · macroRecord](/hidpp/features/x8030-macro-record): On-the-fly macro recording for gaming keyboards — start and stop capture sessions, target a G-key slot, and store timed keystroke sequences in onboard memory.
    - [0x8040 · brightnessControl](/hidpp/features/x8040-brightness-control): Device backlight brightness control — read the supported range and step count, get or set the brightness level, and independently toggle illumination on or off.
    - [0x8060 · adjustableReportRate](/hidpp/features/x8060-report-rate): Legacy HID report rate control — enumerate supported polling intervals from 1 ms to 8 ms, then read or write the active interval.
    - [0x8061 · extendedAdjustableReportRate](/hidpp/features/x8061-extended-report-rate): High-frequency polling control — query supported rates up to 8000 Hz per connection type (wired or gaming wireless), then read or set the active rate.
    - [0x8070 · colorLedEffects](/hidpp/features/x8070-color-led-effects): Per-zone RGB effect engine — enumerate LED zones and their supported effects, apply effects with configurable persistence, and synchronize timing with the host.
    - [0x8071 · rgbEffects](/hidpp/features/x8071-rgb-effects): Modern per-cluster RGB effect engine — claim software control, apply effects with volatile or persistent storage per cluster, and manage power modes and sync events.
    - [0x8080 · perKeyLighting](/hidpp/features/x8080-per-key-lighting): Legacy per-key RGB lighting control — query populated zone IDs, stage per-zone colours, and commit a frame to the display with optional non-volatile persistence.
    - [0x8081 · perKeyLighting](/hidpp/features/x8081-per-key-lighting): Per-key (per-zone) RGB lighting control — stage colours across up to 256 individually addressed zones and commit them with frame timing and optional EEPROM persistence.
    - [0x8090 · modeStatus](/hidpp/features/x8090-mode-status): Read or write a device's operating mode — toggling between performance and endurance via a bitmask-controlled status register, with hardware and software switch capability discovery.
    - [0x8100 · onboardProfiles](/hidpp/features/x8100-onboard-profiles): Full host access to onboard flash profiles — enumerate, activate, read, write, and factory-reset named slots storing DPI levels, button remappings, and lighting preferences.
    - [0x8110 · mouseButtonFilter](/hidpp/features/x8110-mouse-button-filter): Control which physical mouse buttons are forwarded to the OS as HID reports — selectively suppress individual buttons at the firmware level so host software can handle them instead.
    - [0x8111 · latencyMonitoring](/hidpp/features/x8111-latency-monitoring): On-device end-to-end input latency measurement — trigger or read firmware-recorded round-trip timing from physical input event to USB or wireless report delivery.
    - [0x8123 · forceFeedback](/hidpp/features/x8123-force-feedback): Host-side control over force-feedback actuators in gaming peripherals — discover supported effect types, create and manage effects, and control playback gain and autocenter strength.
    - [0x8300 · sidetone](/hidpp/features/x8300-sidetone): Headset sidetone control — read or write the microphone-to-ear playback level (0–100) and per-channel mute state so wearers can hear their own voice while speaking.
    - [0x8310 · equalizer](/hidpp/features/x8310-equalizer): Per-band audio equalizer and microphone noise reduction for HID++ headsets — query band count and gain limits, read or write per-band gains with configurable persistence, and toggle noise reduction.