From 8f8764232ea7a1936aa8cbd9e771032a4acf557c Mon Sep 17 00:00:00 2001 From: Chris Date: Thu, 16 Jun 2022 14:44:13 +1000 Subject: [PATCH] Adding Legend to Suported Devices + Adding :robot: symbol for Automatic saving + Changing :warning: to :rotating_light: for better visibility + Adding :tools: symbol to mean `partial support` + Adding :o: symbol to mean not currently implemented by OpenRGB --- .../RGBController_AMDWraithPrism.cpp | 4 +- .../RGBController_ASRockPolychromeSMBus.cpp | 2 +- .../RGBController_ASRockPolychromeUSB.cpp | 2 +- .../RGBController_AsusAuraCore.cpp | 2 +- .../RGBController_CMARGBController.cpp | 2 +- .../RGBController_CMMKController.cpp | 2 +- .../RGBController_CMMM711Controller.cpp | 2 +- .../RGBController_CMMP750Controller.cpp | 2 +- .../RGBController_CMRGBController.cpp | 2 +- .../RGBController_CMSmallARGBController.cpp | 2 +- .../RGBController_CorsairLightingNode.cpp | 2 +- .../RGBController_CorsairVengeance.cpp | 2 +- .../RGBController_CorsairVengeancePro.cpp | 2 +- .../RGBController_EKController.cpp | 2 +- .../RGBController_EVisionKeyboard.cpp | 2 +- .../RGBController_LianLiUniHub.cpp | 2 +- .../RGBController_LogitechG203L.cpp | 2 +- .../RGBController_LogitechG213.cpp | 2 +- .../RGBController_LogitechG810.cpp | 2 +- .../RGBController_LogitechG815.cpp | 2 +- .../RGBController_LogitechG910.cpp | 2 +- .../RGBController_LogitechG915.cpp | 2 +- .../RGBController_LogitechGLightsync.cpp | 2 +- .../RGBController_LogitechGLightsync1zone.cpp | 2 +- .../RGBController_LogitechGProKeyboard.cpp | 2 +- .../RGBController_MSIMysticLight162.cpp | 2 +- .../RGBController_MSIMysticLight185.cpp | 2 +- .../RGBController_MSIVigorGK30.cpp | 2 +- .../RGBController_NZXTHue2.cpp | 2 +- .../RGBController_NZXTHuePlus.cpp | 2 +- .../RazerController/RGBController_Razer.cpp | 2 +- .../RGBController_RazerAddressable.cpp | 2 +- .../RGBController_RazerKraken.cpp | 2 +- .../RGBController_RedragonM711.cpp | 2 +- .../RGBController_RoccatBurst.cpp | 2 +- .../RGBController_Sinowealth.cpp | 2 +- .../RGBController_Yeelight.cpp | 2 +- RGBController/RGBController_Dummy.cpp | 17 ++++++-- scripts/build-supported-devices-md.sh | 41 +++++++++++++++---- 39 files changed, 84 insertions(+), 50 deletions(-) diff --git a/Controllers/AMDWraithPrismController/RGBController_AMDWraithPrism.cpp b/Controllers/AMDWraithPrismController/RGBController_AMDWraithPrism.cpp index dc57f6e25..3b7a7ac63 100644 --- 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` diff --git a/Controllers/ASRockPolychromeSMBusController/RGBController_ASRockPolychromeSMBus.cpp b/Controllers/ASRockPolychromeSMBusController/RGBController_ASRockPolychromeSMBus.cpp index d5b3e7235..79bc83eb5 100644 --- 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 diff --git a/Controllers/ASRockPolychromeUSBController/RGBController_ASRockPolychromeUSB.cpp b/Controllers/ASRockPolychromeUSBController/RGBController_ASRockPolychromeUSB.cpp index 7f2a48ba8..5c8f9de5e 100755 --- 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 diff --git a/Controllers/AsusAuraCoreController/RGBController_AsusAuraCore.cpp b/Controllers/AsusAuraCoreController/RGBController_AsusAuraCore.cpp index 5a3e12d3d..ab6907937 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMARGBController.cpp b/Controllers/CoolerMasterController/RGBController_CMARGBController.cpp index d20dd3cd2..84e6850b7 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMMKController.cpp b/Controllers/CoolerMasterController/RGBController_CMMKController.cpp index 7f4708a0c..dce60a1f9 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMMM711Controller.cpp b/Controllers/CoolerMasterController/RGBController_CMMM711Controller.cpp index 99d78804c..73090798b 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMMP750Controller.cpp b/Controllers/CoolerMasterController/RGBController_CMMP750Controller.cpp index f8b3d4b1e..d9187412b 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMRGBController.cpp b/Controllers/CoolerMasterController/RGBController_CMRGBController.cpp index 7e174dd8b..c7a64081a 100644 --- 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 diff --git a/Controllers/CoolerMasterController/RGBController_CMSmallARGBController.cpp b/Controllers/CoolerMasterController/RGBController_CMSmallARGBController.cpp index 9f9efce16..994c08f7f 100644 --- 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 diff --git a/Controllers/CorsairLightingNodeController/RGBController_CorsairLightingNode.cpp b/Controllers/CorsairLightingNodeController/RGBController_CorsairLightingNode.cpp index 697610187..c110ffe67 100644 --- 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 diff --git a/Controllers/CorsairVengeanceController/RGBController_CorsairVengeance.cpp b/Controllers/CorsairVengeanceController/RGBController_CorsairVengeance.cpp index 84846e7d9..031dd0bc7 100644 --- 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 diff --git a/Controllers/CorsairVengeanceProController/RGBController_CorsairVengeancePro.cpp b/Controllers/CorsairVengeanceProController/RGBController_CorsairVengeancePro.cpp index a040ad6fd..6d871f343 100644 --- 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 diff --git a/Controllers/EKController/RGBController_EKController.cpp b/Controllers/EKController/RGBController_EKController.cpp index 83c5e9fb4..a88c60547 100644 --- 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 diff --git a/Controllers/EVisionKeyboardController/RGBController_EVisionKeyboard.cpp b/Controllers/EVisionKeyboardController/RGBController_EVisionKeyboard.cpp index e82062aa2..570605e6c 100644 --- 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 diff --git a/Controllers/LianLiController/RGBController_LianLiUniHub.cpp b/Controllers/LianLiController/RGBController_LianLiUniHub.cpp index ed6e01ee7..509afc13a 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG203L.cpp b/Controllers/LogitechController/RGBController_LogitechG203L.cpp index cc6ec28a2..844f24c62 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG213.cpp b/Controllers/LogitechController/RGBController_LogitechG213.cpp index 18d1c9b5b..ebd659ed2 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG810.cpp b/Controllers/LogitechController/RGBController_LogitechG810.cpp index e45b47a65..7d6fcbe44 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG815.cpp b/Controllers/LogitechController/RGBController_LogitechG815.cpp index bfe730e67..e8810ec70 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG910.cpp b/Controllers/LogitechController/RGBController_LogitechG910.cpp index 5fc11e322..27fba80af 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechG915.cpp b/Controllers/LogitechController/RGBController_LogitechG915.cpp index ab0ca798f..e85fd5a0b 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechGLightsync.cpp b/Controllers/LogitechController/RGBController_LogitechGLightsync.cpp index 92e7b6481..cb39a4146 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechGLightsync1zone.cpp b/Controllers/LogitechController/RGBController_LogitechGLightsync1zone.cpp index d732a6242..9e23bb0d3 100644 --- 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 diff --git a/Controllers/LogitechController/RGBController_LogitechGProKeyboard.cpp b/Controllers/LogitechController/RGBController_LogitechGProKeyboard.cpp index a78d08620..e3380761e 100644 --- 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 diff --git a/Controllers/MSIMysticLightController/RGBController_MSIMysticLight162.cpp b/Controllers/MSIMysticLightController/RGBController_MSIMysticLight162.cpp index 2e555683f..af0179dc0 100644 --- 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 diff --git a/Controllers/MSIMysticLightController/RGBController_MSIMysticLight185.cpp b/Controllers/MSIMysticLightController/RGBController_MSIMysticLight185.cpp index 2c6dc9dbf..442040fc5 100644 --- 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 diff --git a/Controllers/MSIVigorController/RGBController_MSIVigorGK30.cpp b/Controllers/MSIVigorController/RGBController_MSIVigorGK30.cpp index 5d77a4563..324f98798 100644 --- 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 diff --git a/Controllers/NZXTHue2Controller/RGBController_NZXTHue2.cpp b/Controllers/NZXTHue2Controller/RGBController_NZXTHue2.cpp index cc75f99d8..3c9d4002f 100644 --- 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 diff --git a/Controllers/NZXTHuePlusController/RGBController_NZXTHuePlus.cpp b/Controllers/NZXTHuePlusController/RGBController_NZXTHuePlus.cpp index c8e64e330..c86620f0c 100644 --- 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 diff --git a/Controllers/RazerController/RGBController_Razer.cpp b/Controllers/RazerController/RGBController_Razer.cpp index fec4f4105..012f9b44c 100644 --- 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 diff --git a/Controllers/RazerController/RGBController_RazerAddressable.cpp b/Controllers/RazerController/RGBController_RazerAddressable.cpp index e23202152..f2e32c696 100644 --- 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 diff --git a/Controllers/RazerController/RGBController_RazerKraken.cpp b/Controllers/RazerController/RGBController_RazerKraken.cpp index 6b4e91d56..bed14eecc 100644 --- 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 diff --git a/Controllers/RedragonController/RGBController_RedragonM711.cpp b/Controllers/RedragonController/RGBController_RedragonM711.cpp index cd3a1680f..63e6868d6 100644 --- 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 diff --git a/Controllers/RoccatController/RGBController_RoccatBurst.cpp b/Controllers/RoccatController/RGBController_RoccatBurst.cpp index 8d653c77e..3c259b161 100644 --- 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 diff --git a/Controllers/SinowealthController/RGBController_Sinowealth.cpp b/Controllers/SinowealthController/RGBController_Sinowealth.cpp index f0437d175..9c62a1393 100644 --- 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 diff --git a/Controllers/YeelightController/RGBController_Yeelight.cpp b/Controllers/YeelightController/RGBController_Yeelight.cpp index 95e79ee0a..0d927c2cd 100644 --- 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 diff --git a/RGBController/RGBController_Dummy.cpp b/RGBController/RGBController_Dummy.cpp index 23af9d1e1..c3cbb323e 100644 --- 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() diff --git a/scripts/build-supported-devices-md.sh b/scripts/build-supported-devices-md.sh index 833bec948..419a4789d 100755 --- 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
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
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}") ;;