High Level Python API

Rivalcfg high level API is what you want to use to interact with any supported mouse from your own scripts.


Get the first plugged mouse that can befound. As there is only one mouse plugged to a computer most of the time, it should return the right one. ;)

Return type



The mouse if one supported device is found, else returns None.

Always return None when RIVALCFG_PROFILE=0000:0000 is defined in the environment.

>>> import rivalcfg
>>> rivalcfg.get_first_mouse()  
<Mouse ...>