Techwizz/mouse_m908
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
mouse_m908/documentation
History
dokutan c7a0957ca3 Add M913 (M686) documentation
2021-12-31 20:11:33 +01:00
..
default-annotated_m908.pdf Update makefile, rename files in documentation 2020-07-12 21:08:05 +02:00
default_m908.txt Update makefile, rename files in documentation 2020-07-12 21:08:05 +02:00
how-to-add-a-new-device.md Add backend for the M686 2021-10-17 17:41:44 +02:00
lsusb-output_m908.txt Update makefile, rename files in documentation 2020-07-12 21:08:05 +02:00
m913-key-press.txt Add M913 (M686) documentation 2021-12-31 20:11:33 +01:00
M913.md Add M913 backend 2021-02-28 17:15:47 +01:00
README.md Add support for more LED modes 2021-01-21 17:54:58 +01:00

README.md

Documentation

Source documentation

Doxygen is used in places for source code documentation. To build the documentation install doxygen and run

doxygen Doxyfile

A directory named doxygen will be created, containing html and latex files.

USB Protocol description

This directory contains captured usb data (when sending the default settings). For further details look at the write functions in the source code.

default_m908.txt and default-annotated_m908.pdf contain the extracted usb data when sending the default settings. This was obtained by exporting packet dissections as plain text from wireshark (select only bytes) and running grep "00[4-9]0" on the exported files.

Button mapping

The function of each button is described by 4 bytes. In case of the fire button all 4 bytes are used, in all other cases the last byte is 0x00. Look at set_key_mapping() (include/setters.cpp) and include/data.cpp for the full meaning of these bytes.

A few are listed below:

  • Keyboard key: 0. = 0x90 if without modifiers, = 0x8f if with modifiers
    1. modifier value (sum of individual modifer values)
    2. keycode
    3. = 0x00
  • Media keys: 0. = 0x8e
    1. = 0x01
    2. keycode
    3. = 0x00
  • Fire button: 0. = 0x99
    1. keycode
    2. repeats
    3. delay
  • Macro: 0. = 0x91
    1. macro number (0x0-0xe)
    2. number of repeats
    3. 0x00
  • Macro (repeat until button is pressed again): 0. = 0x91
    1. macro number (0x0-0xe) + 0x3f
    2. 0xff
    3. 0xff
  • Macro (repeat while button is pressed): 0. = 0x91
    1. macro number (0x0-0xe) + 0x7f
    2. 0xff
    3. 0xff
  • Snipe (Changes DPI while pressed) 0. = 0x9a
    1. 1
    2. DPI 200-1100 (100 increment): 4 6 9 b d f 12 14 16 18
    3. = 2.
  • No function (none) all bytes = 0x00

Reading settings from the mouse

The settings are read in 3 parts:

  1. led settings
  2. macros
  3. button mappping

LED modes

The LED mode is specified by two bytes.

byte1 % 8: - 0: off - 1: decode byte2 - 2: wave (multicolor) - 3: reactive_button (static color, new color on button press, not in the official software) - 4: random (random flashing with random colors, scrollwheel and logo separately, not in the official software) - 5: wave (same as 2) - 6: alternating (flashing of scrollwheel and logo separately, multicolor) - 7: reactive

byte2 (only relevant when byte1 == 1): - 0: breathing (single color) - 1: breathing_rainbow (not in the official software) - 2: static - 8: rainbow - 16: flashing