Skip to content

Commit

Permalink
doc: Added documentation for the Prime Mini device
Browse files Browse the repository at this point in the history
  • Loading branch information
flozz committed Jan 13, 2024
1 parent 1d6417c commit 6636dac
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Supported Devices
./kanav2.rst
./kinzuv2.rst
./prime.rst
./prime_mini.rst
./prime_wireless.rst
./rival3.rst
./rival3_wireless.rst
Expand Down
81 changes: 81 additions & 0 deletions doc/devices/prime_mini.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
SteelSeries Prime Mini
======================


.. NOTE::

* For Prime Mini Wireless, see :doc:`./prime_wireless`.


Supported Models
----------------

.. rivalcfg_device_family:: prime_mini


Command-Line Usage
------------------

.. rivalcfg_device_cli:: prime_mini


Sensitivity (DPI)
-----------------

This mouse supports up to 5 sensitivity presets. You can define them like this:

::

rivalcfg --sensitivity 800 # one preset
rivalcfg --sensitivity 800,1600 # two presets

You can switch preset using the button under the mouse wheel.

.. NOTE::

When you set the sensitivity through the CLI, the selected preset always
back to the first one.


.. NOTE:: From Python API, you can pass an ``int``, a ``tuple`` or a ``list``
as parameter. You are also able to change the currently selected preset::

mouse.sensitivity(800)
mouse.sensitivity("800, 1600")
mouse.sensitivity([800, 1600])
# select the second preset (1600 dpi)
mouse.sensitivity([800, 1600, 2000, 4000], selected_preset=2)


Colors
------

This mouse supports colors. Various formats are supported.

.. include:: ./_colors.rst

.. IMPORTANT::

On newer SteelSeries mice, the color settings are not saved in the onboard
memory anymore (see Default Lighting bellow).


Default Lighting
----------------

.. include:: ./_default_lighting.rst


Buttons
-------

.. figure:: ./images/prime_buttons.svg
:alt: Prime buttons schema

.. include:: ./_buttons.rst


Python API
----------

TODO
4 changes: 4 additions & 0 deletions doc/devices/prime_wireless.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
SteelSeries Prime Wireless
==========================

.. NOTE::

* For Prime Mini (non-wireless version), see :doc:`./prime_mini`.


Supported Models
----------------
Expand Down

0 comments on commit 6636dac

Please sign in to comment.