This Python script allows you to control the Redragon M601-RGB gaming mouse from your terminal!

Disclaimer: This software is not supported by the manufacturer of the hardware in any way, and relies completely on information from reverse-engineering. There is no warranty, especially in case of damage to the hardware

• Compatibility
• First steps
• Compiling
• Usage
• Macros
• Some hardware info

Compatibility

First of all, make sure that the VID and PID of your mouse match these: "258a:1007" You can check it by executing the following command in your terminal:

lsusb

You'll get similar output:

Bus 001 Device 008: ID 258a:1007 SINOWEALTH Wired Gaming Mouse

If your VID:PID didn't match 258a:1007, or you have a different mouse from Redragon, you can check mouse_m908 repository from dokutan.

After you ensured that VID:PID of your mouse is correct, you can try to change mouse mode (see "First steps" section):

python cli.py -m 1
python cli.py -m 2

If the mouse did respond, congratulations! It means your mouse is likely supported by this software!

First steps

First of all, you need to clone this repository to your machine, make virtual environment, activate it, and install main requirement - python library PyUSB

git clone https://github.com/so1der/m601
cd m601
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Now you can use it!

python cli.py -h

But before that, you may need to add VID and PID into udev rules. To do so, go to /etc/udev/rules.d/ and create the file "99-m601.rules", and add there via nano following line:

SUBSYSTEM=="usb", ATTRS{idVendor}=="258a", ATTRS{idProduct}=="1007", MODE="0666"

cd /etc/udev/rules.d/
touch 99-m601.rules
nano 99-m601.rules

Compiling

But once you close your terminal, the environment will be deactivated. In order not to activate the virtual environment every time you need to change something in your mouse, you can simply compile the executable binary file and put it in your /usr/local/bin directory. To do so, you need to install PyInstaller:

pip install pyinstaller

And now you can compile executable file from cli.py file, in this case, pyinstaller will collect all requirements by itself:

pyinstaller --onefile cli.py

Now you have an executable file in your dist/ directory. Move to this directory:

cd dist

And rename the executable file to your liking:

mv cli m601

You can ensure that everything went well by executing this file:

./m601 -h

It should output a help message. Now you can copy it in your /usr/local/bin/ directory:

sudo cp m601 /usr/local/bin/

After that, you can deactivate the virtual environment and execute this file in any directory!

m601 -h

Usage

First of all, you need to read the current settings from your mouse:

m601 -r settings
# or
python cli.py -r settings 

This will generate a "settings.ini" file. This .ini file contains very detailed info about all parameters of the mouse that you can change. Please, read it carefully, because if some parameters will contain values that they should not contain, the mouse can stop responding. So please, read "Possible values" for each parameter before changing it. There is possibility of hard resetting the mouse, but I can not guarantee that this option will work in all cases. Please note, that to change even the smallest settings, the mouse receives a big package with all settings, so if you need to change, for example, lighting mode, the programm still needs to send DPI values, USB polling rate, and all other parameters, so don't delete anything from .ini file, just modify it in within the given limits.

After you modify .ini file to your liking, you need to write it to the mouse:

m601 -w settings.ini
# or
python cli.py -w settings.ini

Thats it! Your new settings should be already in the mouse. Note: In my case, after binding key combinations, I need to reconnect mouse, otherwise key combinations won't work. I dont know if this is software related problem, or Linux related.

There is also a file called 'default_settings.ini' in this repository, you can reset your mouse settings by writing this file into your mouse:

m601 -w default_settings.ini
# or
python cli.py -w default_settings.ini

But if your mouse misbehaves, or isn't responding at all, you can try to hard reset it:

m601 --hard_reset
# or
python cli.py --hard_reset

In addition, you can also change the mouse mode:

m601 -m 1
m601 -m 2
# or
python cli.py -m 1
python cli.py -m 2

And damp raw data from the mouse for debugging purposes:

m601 -d dump
# or
python cli.py -d dump

Macros

Disclaimer: The macros feature was not properly tested, since I'm not using macros, I only tested a few of them.

To make macros, You need to create a text file with actions. There must be no empty lines in the file. Each line contains an action and a parameter separated by a spacebar. Supported actions are:

• down ⟨key⟩
• up ⟨key⟩
• delay ⟨ms⟩

You can see possible keys in 'values.py' file (hid_mod_buttons and hid_buttons , there are not all keys, I will add more eventually) So, for example:

down 1
up 1
down 2
up 2
down 3
up 3

So after You save file for example as 'macros_file', You can upload it into the mouse:

python cli.py -um 1 macros_file

Where '1' is the number of a macro memory cell. For now, only 5 are available (since in the original software you can bind only 5 macros because at least one mouse button needs to be LMB) And of course, You need to set one of the mouse buttons as a macro button in .ini file:
button_6 = macro_1
button_6 = macro_2
etc
After that, upload .ini file reconnect (in my case) the mouse, and You're good to go! If You find any errors, please let me know.

There are default 5 ms delay between macros actions. You can decrease it down to 1 ms, but in my case, with 1 ms delay often the order of actions of the macros did not match the file, so I increase it up to 5 ms. You can change it in the file 'cli.py', lines 214 and 219. raw_macro.append(0x05), 0x05 in this case determines delay in the hex format.

Some hardware info

There is a 32-bit microcontroller inside this mouse - "Bayi BY8832". I didn't find any info about this microcontroller, but while searching "BY8832" on the internet, you can find articles about many other mice (e.g. Marvo, Imperion, Hiper, Dream Machines, etc.) this microcontroller unites them all. They also have very similar UI in the official software. Maybe all those mice also can be controlled via this software, but I'm not sure since this is a microcontroller, they could just implement a different protocol or something (of course if the software communicates with the microcontroller not just reflashing it). If you have a mouse with BY8832 and can capture some packages from the original software, please, send them to me, I would be very happy to analyze them.