From 6636dac4a98419b9bc1a06da87b2efb0379dea16 Mon Sep 17 00:00:00 2001
From: Fabien LOISON <flo@flogisoft.com>
Date: Sat, 13 Jan 2024 14:18:09 +0100
Subject: [PATCH] doc: Added documentation for the Prime Mini device

---
 doc/devices/index.rst          |  1 +
 doc/devices/prime_mini.rst     | 81 ++++++++++++++++++++++++++++++++++
 doc/devices/prime_wireless.rst |  4 ++
 3 files changed, 86 insertions(+)
 create mode 100644 doc/devices/prime_mini.rst

diff --git a/doc/devices/index.rst b/doc/devices/index.rst
index 838c604..0703e49 100644
--- a/doc/devices/index.rst
+++ b/doc/devices/index.rst
@@ -14,6 +14,7 @@ Supported Devices
    ./kanav2.rst
    ./kinzuv2.rst
    ./prime.rst
+   ./prime_mini.rst
    ./prime_wireless.rst
    ./rival3.rst
    ./rival3_wireless.rst
diff --git a/doc/devices/prime_mini.rst b/doc/devices/prime_mini.rst
new file mode 100644
index 0000000..a380a59
--- /dev/null
+++ b/doc/devices/prime_mini.rst
@@ -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
diff --git a/doc/devices/prime_wireless.rst b/doc/devices/prime_wireless.rst
index d4f62d7..833f411 100644
--- a/doc/devices/prime_wireless.rst
+++ b/doc/devices/prime_wireless.rst
@@ -1,6 +1,10 @@
 SteelSeries Prime Wireless
 ==========================
 
+.. NOTE::
+
+   * For Prime Mini (non-wireless version), see :doc:`./prime_mini`.
+
 
 Supported Models
 ----------------