mouse_m908/documentation/README.md

# Documentation

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

## 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.txt and default-annotated.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()`` (setters.cpp) and constructor.cpp for the meaning of these bytes.
Clean up code, improve documentation 2020-05-08 15:17:44 -06:00			`# Documentation`

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

			`## USB Protocol description`
Add captured usb data 2020-04-29 07:33:03 -06:00			`This directory contains captured usb data (when sending the default settings). For further details look at the write functions in the source code.`

Add media controls to button mapping 2020-05-02 08:01:29 -06:00			default.txt and default-annotated.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.


Clean up code, improve documentation 2020-05-08 15:17:44 -06:00			`### Button mapping`
Add media controls to button mapping 2020-05-02 08:01:29 -06:00			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()`` (setters.cpp) and constructor.cpp for the meaning of these bytes.