Adding Legend to Suported Devices

+ Adding 🤖 symbol for Automatic saving + Changing ⚠️ to 🚨 for better visibility + Adding :tools: symbol to mean `partial support` + Adding ⭕ symbol to mean not currently implemented by OpenRGB
4 years ago · 8f8764232e
parent f870ad20f2
commit 8f8764232e
39 changed files with 84 additions and 50 deletions
--- a/Controllers/AMDWraithPrismController/RGBController_AMDWraithPrism.cpp
+++ b/Controllers/AMDWraithPrismController/RGBController_AMDWraithPrism.cpp
@ -13,9 +13,9 @@
    @name AMD Wraith Prism
    @category Cooler
    @type USB
-    @save :x:
+    @save :o:
    @direct :white_check_mark:
-    @effects :warning:
+    @effects :tools:
    @detectors DetectAMDWraithPrismControllers
    @comment The Wraith Prism comes with 2 cables but is only detectable
        and controlable when using the USB cable. `Morse Code` and `Mirage`
--- a/Controllers/ASRockPolychromeSMBusController/RGBController_ASRockPolychromeSMBus.cpp
+++ b/Controllers/ASRockPolychromeSMBusController/RGBController_ASRockPolychromeSMBus.cpp
@ -36,7 +36,7 @@ static const char* polychrome_v2_zone_names[] =
    @name ASRock Polychrome SMBus
    @category Motherboard
    @type SMBus
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectPolychromeSMBusControllers
--- a/Controllers/ASRockPolychromeUSBController/RGBController_ASRockPolychromeUSB.cpp
+++ b/Controllers/ASRockPolychromeUSBController/RGBController_ASRockPolychromeUSB.cpp
@ -17,7 +17,7 @@
    @name ASrock Polychrome USB
    @category Motherboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectPolychromeUSBControllers
--- a/Controllers/AsusAuraCoreController/RGBController_AsusAuraCore.cpp
+++ b/Controllers/AsusAuraCoreController/RGBController_AsusAuraCore.cpp
@ -13,7 +13,7 @@
    @category Keyboard,LEDStrip
    @type USB
    @save :x:
-    @direct :warning:
+    @direct :rotating_light:
    @effects :white_check_mark:
    @detectors DetectAsusAuraCoreControllers
    @comment
--- a/Controllers/CoolerMasterController/RGBController_CMARGBController.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMARGBController.cpp
@ -13,7 +13,7 @@
    @name Coolermaster ARGB
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterARGB
--- a/Controllers/CoolerMasterController/RGBController_CMMKController.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMMKController.cpp
@ -24,7 +24,7 @@ using namespace std::chrono_literals;
    @name Coolermaster Masterkeys Keyboards
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterKeyboards
--- a/Controllers/CoolerMasterController/RGBController_CMMM711Controller.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMMM711Controller.cpp
@ -15,7 +15,7 @@
    @name Coolermaster Master Mouse
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterMouse
--- a/Controllers/CoolerMasterController/RGBController_CMMP750Controller.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMMP750Controller.cpp
@ -13,7 +13,7 @@
    @name Coolermaster Mouse Pad
    @category Mousemat
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterMousemats
--- a/Controllers/CoolerMasterController/RGBController_CMRGBController.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMRGBController.cpp
@ -47,7 +47,7 @@
    @name Coolermaster RGB
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterRGB
--- a/Controllers/CoolerMasterController/RGBController_CMSmallARGBController.cpp
+++ b/Controllers/CoolerMasterController/RGBController_CMSmallARGBController.cpp
@ -13,7 +13,7 @@
    @name Coolermaster Small ARGB
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCoolerMasterSmallARGB
--- a/Controllers/CorsairLightingNodeController/RGBController_CorsairLightingNode.cpp
+++ b/Controllers/CorsairLightingNodeController/RGBController_CorsairLightingNode.cpp
@ -13,7 +13,7 @@
    @name Corsair Lighting Node
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCorsairLightingNodeControllers
--- a/Controllers/CorsairVengeanceController/RGBController_CorsairVengeance.cpp
+++ b/Controllers/CorsairVengeanceController/RGBController_CorsairVengeance.cpp
@ -13,7 +13,7 @@
    @name Corsair Vengeance
    @category RAM
    @type SMBus
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectCorsairVengeanceControllers
--- a/Controllers/CorsairVengeanceProController/RGBController_CorsairVengeancePro.cpp
+++ b/Controllers/CorsairVengeanceProController/RGBController_CorsairVengeancePro.cpp
@ -13,7 +13,7 @@
    @name Corsair Vengeance Pro
    @category RAM
    @type SMBus
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectCorsairVengeanceProControllers
--- a/Controllers/EKController/RGBController_EKController.cpp
+++ b/Controllers/EKController/RGBController_EKController.cpp
@ -13,7 +13,7 @@
    @name EK Loop Connect
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectEKControllers
--- a/Controllers/EVisionKeyboardController/RGBController_EVisionKeyboard.cpp
+++ b/Controllers/EVisionKeyboardController/RGBController_EVisionKeyboard.cpp
@ -24,7 +24,7 @@ static unsigned int matrix_map[6][23] =
    @name EVision Keyboard
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectEVisionKeyboards
--- a/Controllers/LianLiController/RGBController_LianLiUniHub.cpp
+++ b/Controllers/LianLiController/RGBController_LianLiUniHub.cpp
@ -33,7 +33,7 @@ mode makeMode()
    @category Cooler
    @type USB
    @save :x:
-    @direct :warning:
+    @direct :rotating_light:
    @effects :white_check_mark:
    @detectors DetectLianLiUniHub
    @comment
--- a/Controllers/LogitechController/RGBController_LogitechG203L.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG203L.cpp
@ -4,7 +4,7 @@
    @name Logitech G203L
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechMouseG203L
--- a/Controllers/LogitechController/RGBController_LogitechG213.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG213.cpp
@ -32,7 +32,7 @@ static const unsigned char led_values[] =
    @name Logitech G213
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardG213
--- a/Controllers/LogitechController/RGBController_LogitechG810.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG810.cpp
@ -170,7 +170,7 @@ static const led_type led_names[] =
    @name Logitech G810
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardG810
--- a/Controllers/LogitechController/RGBController_LogitechG815.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG815.cpp
@ -174,7 +174,7 @@ static const led_type led_names[] =
    @name Logitech G815
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardG815
--- a/Controllers/LogitechController/RGBController_LogitechG910.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG910.cpp
@ -171,7 +171,7 @@ static const led_type led_names[] =
    @name Logitech G910
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardG910
--- a/Controllers/LogitechController/RGBController_LogitechG915.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechG915.cpp
@ -186,7 +186,7 @@ static const led_type led_names[] =
    @name Logitech G915
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardG915,DetectLogitechKeyboardG915Wired
--- a/Controllers/LogitechController/RGBController_LogitechGLightsync.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechGLightsync.cpp
@ -13,7 +13,7 @@
    @name Logitech Lightsync Mouse
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechMouseG303, DetectLogitechMouseG403
--- a/Controllers/LogitechController/RGBController_LogitechGLightsync1zone.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechGLightsync1zone.cpp
@ -13,7 +13,7 @@
    @name Logitech Lightsync Mouse (1 Zone)
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechMouseG203, DetectLogitechMouseGPRO
--- a/Controllers/LogitechController/RGBController_LogitechGProKeyboard.cpp
+++ b/Controllers/LogitechController/RGBController_LogitechGProKeyboard.cpp
@ -147,7 +147,7 @@ static const led_type led_names[] =
    @name Logitech G Pro
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectLogitechKeyboardGPro
--- a/Controllers/MSIMysticLightController/RGBController_MSIMysticLight162.cpp
+++ b/Controllers/MSIMysticLightController/RGBController_MSIMysticLight162.cpp
@ -77,7 +77,7 @@ static const ZoneDescription led_zones[] =
    @name MSI Mystic Light (162 Byte)
    @category Motherboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectMSIMysticLight162Controllers
--- a/Controllers/MSIMysticLightController/RGBController_MSIMysticLight185.cpp
+++ b/Controllers/MSIMysticLightController/RGBController_MSIMysticLight185.cpp
@ -85,7 +85,7 @@ static const ZoneDescription led_zones[] =
    @name MSI Mystic Light (185 Byte)
    @category Motherboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectMSIMysticLight185Controllers
--- a/Controllers/MSIVigorController/RGBController_MSIVigorGK30.cpp
+++ b/Controllers/MSIVigorController/RGBController_MSIVigorGK30.cpp
@ -16,7 +16,7 @@
    @name MSI Vigor GK30
    @category Keyboard
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectMSIVigorGK30Controllers
--- a/Controllers/NZXTHue2Controller/RGBController_NZXTHue2.cpp
+++ b/Controllers/NZXTHue2Controller/RGBController_NZXTHue2.cpp
@ -12,7 +12,7 @@
    @name NZXT Hue2
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectNZXTHue2,DetectNZXTHue2Ambient,DetectNZXTHue2Motherboard,DetectNZXTSmartDeviceV2,DetectNZXTKrakenX3,DetectNZXTFanController
--- a/Controllers/NZXTHuePlusController/RGBController_NZXTHuePlus.cpp
+++ b/Controllers/NZXTHuePlusController/RGBController_NZXTHuePlus.cpp
@ -12,7 +12,7 @@
    @name NZXT Hue+
    @category LEDStrip
    @type Serial
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectNZXTHuePlusControllers
--- a/Controllers/RazerController/RGBController_Razer.cpp
+++ b/Controllers/RazerController/RGBController_Razer.cpp
@ -5,7 +5,7 @@
    @name Razer
    @category Keyboard,Microphone,Mouse,Mousemat,HeadsetStand,Case
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectRazerControllers
--- a/Controllers/RazerController/RGBController_RazerAddressable.cpp
+++ b/Controllers/RazerController/RGBController_RazerAddressable.cpp
@ -7,7 +7,7 @@
    @name Razer ARGB
    @category LEDStrip
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectRazerARGBControllers
--- a/Controllers/RazerController/RGBController_RazerKraken.cpp
+++ b/Controllers/RazerController/RGBController_RazerKraken.cpp
@ -5,7 +5,7 @@
    @name Razer Kraken
    @category Headset
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectRazerKrakenControllers
--- a/Controllers/RedragonController/RGBController_RedragonM711.cpp
+++ b/Controllers/RedragonController/RGBController_RedragonM711.cpp
@ -13,7 +13,7 @@
    @name Redragon Mice
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectRedragonMice
--- a/Controllers/RoccatController/RGBController_RoccatBurst.cpp
+++ b/Controllers/RoccatController/RGBController_RoccatBurst.cpp
@ -13,7 +13,7 @@
    @name Roccat Burst Mouse
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :white_check_mark:
    @effects :white_check_mark:
    @detectors DetectRoccatBurstCoreControllers,DetectRoccatBurstProControllers
--- a/Controllers/SinowealthController/RGBController_Sinowealth.cpp
+++ b/Controllers/SinowealthController/RGBController_Sinowealth.cpp
@ -13,7 +13,7 @@
    @name Sinowealth Mice
    @category Mouse
    @type USB
-    @save :warning:
+    @save :robot:
    @direct :x:
    @effects :white_check_mark:
    @detectors DetectSinowealthMouse
--- a/Controllers/YeelightController/RGBController_Yeelight.cpp
+++ b/Controllers/YeelightController/RGBController_Yeelight.cpp
@ -13,7 +13,7 @@
    @category Light
    @type Network
    @save :x:
-    @direct :warning:
+    @direct :rotating_light:
    @effects :white_check_mark:
    @detectors DetectYeelightControllers
    @comment
--- a/RGBController/RGBController_Dummy.cpp
+++ b/RGBController/RGBController_Dummy.cpp
@ -10,13 +10,22 @@

 /**------------------------------------------------------------------*\
    @name Dummy
-    @category Unknown
+    @category Dummy
    @type I2C or Serial or WMI or USB
-    @save :white_check_mark: or :warning: or :x:
-    @direct :white_check_mark: or :warning: or :x:
-    @effects :white_check_mark: or :warning: or :x:
+    @save :white_check_mark: or :robot: or :o: or :x:
+    @direct :white_check_mark: or :rotating_light: or :o: or :x:
+    @effects :white_check_mark: or :rotating_light: or :tools: or :o: or :x:
    @detectors DetectDummy,DetectDummy2
    @comment Insert multiline dummy comment here
+
+        | Symbol | Meaning |
+        | :---: | :--- |
+        | :white_check_mark: | Fully supported by OpenRGB |
+        | :rotating_light: | Support is problematic |
+        | :robot: | Feature is automatic and can not be turned off |
+        | :tools: | Partially supported by OpenRGB |
+        | :o: | Not currently supported by OpenRGB |
+        | :x: | Not applicable for this device |
 */

 RGBController_Dummy::RGBController_Dummy()
--- a/scripts/build-supported-devices-md.sh
+++ b/scripts/build-supported-devices-md.sh
@ -57,6 +57,16 @@ echo -e "- [Storage](#storage)" >> "$MAIN_FILE"
 echo -e "- [Cases](#cases)" >> "$MAIN_FILE"
 echo -e "- [Other Devices](#other-devices)" >> "$MAIN_FILE"

+echo -e "\n## Legend\n\n" >> "$MAIN_FILE"
+echo -e "| Symbol | Meaning |" >> "$MAIN_FILE"
+echo -e "| :---: | :--- |" >> "$MAIN_FILE"
+echo -e "| :white_check_mark: | Fully supported by OpenRGB |" >> "$MAIN_FILE"
+echo -e "| :rotating_light: | Support is problematic<br/>See device page for details |" >> "$MAIN_FILE"
+echo -e "| :robot: | Feature is automatic and can not be turned off |" >> "$MAIN_FILE"
+echo -e "| :tools: | Partially supported by OpenRGB<br/>See device page for details |" >> "$MAIN_FILE"
+echo -e "| :o: | Not currently supported by OpenRGB |" >> "$MAIN_FILE"
+echo -e "| :x: | Not applicable for this device |" >> "$MAIN_FILE"
+
 while read -r controller
 do
    ## 's/\r$//' - Convert DOS text to Unix text
@ -78,8 +88,11 @@ do
            :x:)
                save_title="Not supported by controller"
                ;;
-            :warning:)
-                save_title="Controller saves on every update"
+            :o:)
+                save_title="Not currently supported by OpenRGB"
+                ;;
+            :robot:)
+                save_title="Controller saves automatically on every update"
                ;;
            :white_check_mark:)
                save_title="Saving is supported by this controller"
@ -90,8 +103,11 @@ do
            :x:)
                direct_title="Not supported by controller"
                ;;
-            :warning:)
-                direct_title="Direct control is problematic"
+            :o:)
+                direct_title="Not currently supported by OpenRGB"
+                ;;
+            :rotating_light:)
+                direct_title="Direct control is problematic (See device page for details)"
                ;;
            :white_check_mark:)
                direct_title="Direct control is supported for Software Effects"
@ -102,8 +118,14 @@ do
            :x:)
                effects_title="Hardware effects are not supported by controller"
                ;;
-            :warning:)
-                effects_title="Hardware effects are not fully implemented by controller"
+            :o:)
+                effects_title="Not currently supported by OpenRGB"
+                ;;
+            :rotating_light:)
+                effects_title="Hardware effects implementation is problematic"
+                ;;
+            :tools:)
+                effects_title="Hardware effects are not fully implemented by controller (See device page for details)"
                ;;
            :white_check_mark:)
                effects_title="Hardware effects are supported"
@ -169,6 +191,9 @@ do
                Case)
                    case+=$current_controller
                    ;;
+                Dummy)
+                    ## Do nothing for the Dummy controller
+                    ;;
                *)
                    unknown+=$current_controller
                    ;;
@ -211,7 +236,7 @@ do
                        #Remove leading hex signifier from $vid and $pid
                        vid=${vid/0x/}
                        pid=${pid/0x/}
-                        device_name=${device_name//[^[:alnum:][:blank:]]/}
+                        device_name=${device_name//[^[:alnum:][:punct:][:blank:]]/}

                        table_row=$(printf '| `%s` | `%s` | %s |' "${vid/ /}" "${pid/ /}" "${device_name}")
                        ;;
@ -222,7 +247,7 @@ do
                        pid=${pid/0x/}
                        svid=${svid/0x/}
                        spid=${spid/0x/}
-                        device_name=${device_name//[^[:alnum:][:blank:]]/}
+                        device_name=${device_name//[^[:alnum:][:punct:][:blank:]]/}

                        table_row=$(printf '| `%s:%s` | `%s:%s` | %s |' "${vid/ /}" "${pid/ /}" "${svid/ /}" "${spid/ /}" "${device_name}")
                        ;;