Update documentation of devices with the default-lighting option

flozz · Dec 28, 2022 · aeb8143 · aeb8143
1 parent 0832110
commit aeb8143
Show file tree

Hide file tree

Showing 9 changed files with 101 additions and 2 deletions.
diff --git a/doc/devices/_default_lighting.rst b/doc/devices/_default_lighting.rst
@@ -0,0 +1,13 @@
+The color setting **is not saved** in the onboard memory on this device. You
+can only define if the light goes blank or rainbow at startup.
+
+Supported values are:
+
+* ``off``: All LEDs are off when the mouse wakeup.
+
+* ``rainbow``: LEDs displays an animated raibow effet when the mouse wakeup.
+
+Examples::
+
+    rivalcfg --default-lighting off
+    rivalcfg --default-lighting rainbow
diff --git a/doc/devices/_default_lighting_reactive.rst b/doc/devices/_default_lighting_reactive.rst
@@ -0,0 +1,20 @@
+The color setting **is not saved** in the onboard memory on this device. You
+can only define if the light goes blank or rainbow at startup.
+
+Supported values are:
+
+* ``off``: All LEDs are off when the mouse wakeup. Clinking on mouse buttons do
+  not trigger light reaction.
+
+* ``reactive``: All LEDs are off when the mouse wakeup. Clinking on mouse buttons trigger a light reacion.
+
+* ``rainbow``: LEDs displays an animated raibow effet when the mouse wakeup.
+  Clinking on mouse buttons do not trigger light reaction.
+
+* ``reactive-rainbow``: LEDs displays an animated raibow effet when the mouse
+  wakeup. Clinking on mouse buttons trigger a light reacion.
+
+Examples::
+
+    rivalcfg --default-lighting off
+    rivalcfg --default-lighting reactive-rainbow
diff --git a/doc/devices/aerox3.rst b/doc/devices/aerox3.rst
@@ -49,6 +49,17 @@ 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_reactive.rst
+
 
 Rainbow Effect
 --------------

diff --git a/doc/devices/aerox3_wireless.rst b/doc/devices/aerox3_wireless.rst
@@ -58,6 +58,11 @@ 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).
+
 
 Rainbow Effect
 --------------
@@ -66,6 +71,12 @@ The Aerox 3 offers an onboard rainbow light effect. Please note that the effect
 is reset if you change colors.
 
 
+Default Lighting
+----------------
+
+.. include:: ./_default_lighting_reactive.rst
+
+
 Buttons
 -------
 

diff --git a/doc/devices/aerox5_wireless.rst b/doc/devices/aerox5_wireless.rst
@@ -58,6 +58,11 @@ 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).
+
 
 Rainbow Effect
 --------------
@@ -66,6 +71,12 @@ The Aerox 5 offers an onboard rainbow light effect. Please note that the effect
 is reset if you change colors.
 
 
+Default Lighting
+----------------
+
+.. include:: ./_default_lighting_reactive.rst
+
+
 Buttons
 -------
 

diff --git a/doc/devices/aerox9_wireless.rst b/doc/devices/aerox9_wireless.rst
@@ -59,14 +59,25 @@ 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).
+
 
 Rainbow Effect
 --------------
 
-The Aerox 3 offers an onboard rainbow light effect. Please note that the effect
+The Aerox 9 offers an onboard rainbow light effect. Please note that the effect
 is reset if you change colors.
 
 
+Default Lighting
+----------------
+
+.. include:: ./_default_lighting_reactive.rst
+
+
 Python API
 ----------
 

diff --git a/doc/devices/prime.rst b/doc/devices/prime.rst
@@ -58,6 +58,17 @@ 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
+
 
 Python API
 ----------

diff --git a/doc/devices/prime_wireless.rst b/doc/devices/prime_wireless.rst
@@ -58,6 +58,17 @@ 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
 -------

diff --git a/doc/index.rst b/doc/index.rst
@@ -52,7 +52,7 @@ Indices and tables
 .. |PYPI Version| image:: https://img.shields.io/pypi/v/rivalcfg?logo=python&logoColor=f1f1f1
    :target: https://pypi.org/project/rivalcfg/
 
-.. |Github Actions| image:: https://img.shields.io/github/workflow/status/flozz/rivalcfg/Lint%20and%20Tests/master
+.. |Github Actions| image:: https://github.com/flozz/rivalcfg/actions/workflows/python-ci.yml/badge.svg
    :target: https://github.com/flozz/rivalcfg/actions
 
 .. |License| image:: https://img.shields.io/github/license/flozz/rivalcfg