Automatic generation of markdown pages for supported devices

+ Added build-supported-devices.sh script
+ Added new target in CI/CD to build at compile time
This commit is contained in:
Chris 2022-05-25 17:58:59 +10:00
parent a7adfe251b
commit 524675108d
163 changed files with 699 additions and 265 deletions

View file

@ -27,6 +27,31 @@ before_script:
- export QT_SELECT=qt5
- export APPIMAGE_EXTRACT_AND_RUN=1
#-----------------------------------------------------------------------#
# Supported Devices Build Target #
#-----------------------------------------------------------------------#
"Supported Devices":
<<: *ccache_init
image: registry.gitlab.com/openrgbdevelopers/openrgb-linux-ci-deb-builder:bullseye-64
stage: build
script:
- qmake
- make -j$(nproc)
- ./scripts/build-supported-devices-md.sh $CI_PROJECT_DIR $CI_COMMIT_SHORT_SHA
artifacts:
name: "${CI_PROJECT_NAME}_Supported_Devices_${CI_COMMIT_SHORT_SHA}"
paths:
- ./*.md
exclude:
- README.md
- CONTRIBUTING.md
expire_in: 30 days
rules:
- if: '$CI_PROJECT_PATH == "CalcProgrammer1/OpenRGB"'
when: on_success
#-----------------------------------------------------------------------#
# Linux (AppImage) 32-bit Build Target #
#-----------------------------------------------------------------------#

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name AMD Wraith Prism
@category Cooler
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -34,6 +34,7 @@ static const char* polychrome_v2_zone_names[] =
/**------------------------------------------------------------------*\
@name ASRock Polychrome SMBus
@category Motherboard
@type SMBus
@save :warning:
@direct :x:

View file

@ -15,6 +15,7 @@
/**------------------------------------------------------------------*\
@name ASrock Polychrome USB
@category Motherboard
@type USB
@save :warning:
@direct :x:

View file

@ -14,6 +14,7 @@
/**------------------------------------------------------------------*\
@name Alienware
@category Keyboard
@type USB
@save :x:
@direct :x:

View file

@ -160,6 +160,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Alienware AW510 Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -110,6 +110,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Anne Pro 2
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Asus AURA Core
@category Keyboard,LEDStrip
@type USB
@save :x:
@direct :warning:

View file

@ -43,10 +43,11 @@ int RGBController_AuraGPU::GetDeviceMode()
/**------------------------------------------------------------------*\
@name Asus Aura GPU
@type I2C
@category GPU
@type SMBus
@save :x:
@direct :white_check_mark:
@effects :white_check_mark::
@effects :white_check_mark:
@detectors DetectAsusAuraGPUControllers
@comment
\*-------------------------------------------------------------------*/

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Asus Aura Headset Stand
@category HeadsetStand
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -345,6 +345,7 @@ static const std::vector<led_type> default_65pct_led_names =
/**------------------------------------------------------------------*\
@name Asus Aura Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Asus Aura Monitor
@category LEDStrip
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -18,6 +18,7 @@ static std::string aura_mouse_zone_names[3]
/**------------------------------------------------------------------*\
@name Asus Aura Mouse
@category Mouse
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Asus Aura Mousemat
@category Mousemat
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Asus Aura Strix Evolve
@category Mouse
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@
/**------------------------------------------------------------------*\
@name Asus Aura TUF Keyboard
@category Keyboard
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -11,12 +11,13 @@
/**------------------------------------------------------------------*\
@name Asus Aura USB
@category Motherboard
@type USB
@save :x:
@direct :white_check_mark:
@effects :white_check_mark:
@detectors DetectAsusAuraUSBTerminal,DetectAsusAuraUSBAddressable,DetectAsusAuraUSBMotherboards
@comment The Asus AUra USB controller applies to most AMD and
@comment The Asus Aura USB controller applies to most AMD and
Intel mainboards from the x470 and z390 chipsets onwards.
\*-------------------------------------------------------------------*/

View file

@ -13,6 +13,7 @@
/**------------------------------------------------------------------*\
@name Asus ROG Strix Liquid Cooler
@category Cooler
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -12,6 +12,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name Asus TUF Laptop
@category Keyboard
@type WMI
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Blinky Tape
@category LEDStrip
@type Serial
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster ARGB
@category LEDStrip
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -22,6 +22,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name Coolermaster Masterkeys Keyboards
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster Master Mouse
@category Mouse
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -14,6 +14,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster Master Mouse
@category Mouse
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster Mouse Pad
@category Mousemat
@type USB
@save :warning:
@direct :x:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name AMD Radeon 6000
@category GPU
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -45,6 +45,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster RGB
@category LEDStrip
@type USB
@save :warning:
@direct :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Coolermaster Small ARGB
@category LEDStrip
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Corsair Commander Core
@category Cooler
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Corsair Dominator Platinum
@category RAM
@type SMBus
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Corsair Hydro
@category Cooler
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -21,6 +21,7 @@ static unsigned int matrix_map[5][5] =
/**------------------------------------------------------------------*\
@name Corsair Hydro Platinum
@category Cooler
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Corsair Lighting Node
@category LEDStrip
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -221,6 +221,7 @@ typedef struct
/**------------------------------------------------------------------*\
@name Corsair K100 Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name Corsair K55 RGB Pro
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -122,6 +122,7 @@ std::vector<std::tuple<unsigned int, std::string>> keys =
/**------------------------------------------------------------------*\
@name Corsair K65 Mini
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -756,8 +756,9 @@ static const char* corsair_harpoon_pro_leds[] =
/**------------------------------------------------------------------*\
@name Corsair Peripheral
@category Keyboard,Mouse,Mousemat,HeadsetStand
@type USB
@save :white_check_mark: or :warning: or :x:
@save :x:
@direct :white_check_mark:
@effects :x:
@detectors DetectCorsairPeripheralControllers

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Corsair Vengeance
@category RAM
@type SMBus
@save :warning:
@direct :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Corsair Vengeance Pro
@category RAM
@type SMBus
@save :warning:
@direct :white_check_mark:

View file

@ -182,6 +182,7 @@ static const char* led_names[] =
/**------------------------------------------------------------------*\
@name Corsair Wireless Peripheral
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -14,6 +14,7 @@
/**------------------------------------------------------------------*\
@name Cougar Revenger ST
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -2,6 +2,7 @@
/**------------------------------------------------------------------*\
@name Creative Sound BlasterX G6
@category Headset
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Crucial RAM
@category RAM
@type SMBus
@save :x:
@direct :white_check_mark:

View file

@ -116,8 +116,9 @@ static const char *led_names[] =
KEY_EN_RIGHT_ARROW
};
/**
/**------------------------------------------------------------------*\
@name Dark Project Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:
@ -125,7 +126,7 @@ static const char *led_names[] =
@detectors DetectDarkProjectKeyboardControllers
@comment The Dark Project keyboard controller currently supports
the full size KD3B Version 2 (ANSI layout).
*/
\*-------------------------------------------------------------------*/
RGBController_DarkProjectKeyboard::RGBController_DarkProjectKeyboard(DarkProjectKeyboardController *controller_ptr)
{

View file

@ -192,6 +192,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name Das Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -5,6 +5,7 @@
/**------------------------------------------------------------------*\
@name Debug
@category Unknown
@type I2C
@save :x:
@direct :x:

View file

@ -188,9 +188,10 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name Ducky Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark
@direct :white_check_mark:
@effects :x:
@detectors DetectDuckyKeyboardControllers
@comment

View file

@ -131,6 +131,7 @@ static const char* led_names[] =
/**------------------------------------------------------------------*\
@name Dygma Raise Keyboard
@category Keyboard
@type Serial
@save :x:
@direct :white_check_mark:

View file

@ -15,6 +15,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name E1.31 Devices
@category LEDStrip
@type E1.31
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name EK Loop Connect
@category LEDStrip
@type USB
@save :warning:
@direct :x:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name ENE SMBus Device
@category RAM,Motherboard,GPU,Storage
@type SMBus
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -20,6 +20,7 @@ static const char* evga_v3_zone_names[] =
/**------------------------------------------------------------------*\
@name EVGA RGB v3 GPU
@category GPU
@type I2C
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -12,6 +12,7 @@
/**------------------------------------------------------------------*\
@name EVGA GP102 GPU
@category GPU
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name EVGA RGB v1 GPU
@category GPU
@type I2C
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name EVGA RGB v2 GPU
@category GPU
@type I2C
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -184,6 +184,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name EVGA USB Keyboard
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -22,6 +22,7 @@ static unsigned int matrix_map[6][23] =
/**------------------------------------------------------------------*\
@name EVision Keyboard
@category Keyboard
@type USB
@save :warning:
@direct :x:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Espurna
@category Light
@type TCP
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name FanBus
@category Cooler
@type Serial
@save :x:
@direct :white_check_mark:

View file

@ -5,6 +5,7 @@
/**------------------------------------------------------------------*\
@name ASUS TUF Keyboard (Faustus)
@category Keyboard
@type File Stream
@save :x:
@direct :x:

View file

@ -16,6 +16,7 @@ int RGBController_GainwardGPUv1::GetDeviceMode()
/**------------------------------------------------------------------*\
@name Gainward GPU v1
@category GPU
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Gainward GPU v2
@category GPU
@type I2C
@save :x:
@direct :x:

View file

@ -42,6 +42,7 @@ int RGBController_GalaxGPU::GetDeviceMode()
/**------------------------------------------------------------------*\
@name Galax GPU
@category GPU
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Aorus ATC800
@category Cooler
@type USB
@save :x:
@direct :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Gigabyte Fusion2 DRAM
@category RAM
@type I2C
@save :x:
@direct :x:

View file

@ -20,6 +20,7 @@ static const char* gigabyte_fusion2_gpu_zone[] =
/**------------------------------------------------------------------*\
@name Gigabyte Fusion 2 GPU
@category GPU
@type I2C
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -39,6 +39,7 @@ static const char* rgb_fusion_zone_names[] =
/**------------------------------------------------------------------*\
@name Gigabyte Fusion2 SMBus
@category Motherboard
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -190,6 +190,7 @@ static KnownLayout knownLayoutsLookup
/**------------------------------------------------------------------*\
@name Gigabyte RGB Fusion 2 USB
@category Motherboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -17,6 +17,7 @@ static const char* rgb_fusion_zone_names[] =
/**------------------------------------------------------------------*\
@name Gigabyte Fusion SMBus
@category Motherboard
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Gigabyte Fusion GPU
@category GPU
@type I2C
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -8,6 +8,7 @@
/**------------------------------------------------------------------*\
@name HP Omen 30L
@category Motherboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Holtek A070
@category Mouse
@type USB
@save :x:
@direct :x:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Holtek A1FA
@category Mouse
@type USB
@save :x:
@direct :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name HyperX DRAM
@category RAM
@type I2C
@save :x:
@direct :white_check_mark:

View file

@ -178,6 +178,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name HyperX Alloy Elite
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -195,6 +195,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name HyperX Alloy Elite 2
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -150,6 +150,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name HyperX Alloy FPS
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -170,6 +170,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name HyperX Alloy Origins
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -148,6 +148,7 @@ static const char *led_names[] =
/**------------------------------------------------------------------*\
@name HyperX Alloy Origins Core
@category Keyboard
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name HyoerX Pulsefire Dart
@category Mouse
@type USB
@save :white_check_mark:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name HyperX Pulsefire FPS
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name HyperX Pulsefire Haste
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name HyperX Pulsefire Surge
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@ using namespace std::chrono_literals;
/**------------------------------------------------------------------*\
@name HyperX Mousemat
@category Mousemat
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -416,6 +416,7 @@ typedef struct
/**------------------------------------------------------------------*\
@name Keychron Keyboard
@category Keyboard
@type USB
@save :x:
@direct :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Serial LED Strip
@category LEDStrip
@type Serial
@save :x:
@direct :white_check_mark:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name LIFX Globes
@category Light
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -14,6 +14,7 @@
/**------------------------------------------------------------------*\
@name Lexip Mouse
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -30,6 +30,7 @@ mode makeMode()
/**------------------------------------------------------------------*\
@name Lian Li Uni Hub
@category Cooler
@type USB
@save :x:
@direct :warning:

View file

@ -10,6 +10,7 @@
/**------------------------------------------------------------------*\
@name Dummy
@category LEDStrip
@type File Stream
@save :x:
@direct :white_check_mark:

View file

@ -2,6 +2,7 @@
/**------------------------------------------------------------------*\
@name Logitech G203L
@category Mouse
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -30,6 +30,7 @@ static const unsigned char led_values[] =
/**------------------------------------------------------------------*\
@name Logitech G213
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -13,6 +13,7 @@
/**------------------------------------------------------------------*\
@name Logitech G560
@category Speaker
@type USB
@save :x:
@direct :white_check_mark:

View file

@ -168,6 +168,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Logitech G810
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -172,6 +172,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Logitech G815
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -169,6 +169,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Logitech G910
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -184,6 +184,7 @@ static const led_type led_names[] =
/**------------------------------------------------------------------*\
@name Logitech G915
@category Keyboard
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -12,8 +12,9 @@
#include "RGBController_LogitechG933.h"
/**------------------------------------------------------------------*\
@name Dummy
@type I2C or Serial or WMI or USB
@name Logitech G933
@category Headset
@type USB
@save :x:
@direct :white_check_mark:
@effects :x:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Logitech Lightsync Mouse
@category Mouse
@type USB
@save :warning:
@direct :white_check_mark:

View file

@ -11,6 +11,7 @@
/**------------------------------------------------------------------*\
@name Logitech Lightsync Mouse (1 Zone)
@category Mouse
@type USB
@save :warning:
@direct :white_check_mark:

Some files were not shown because too many files have changed in this diff Show more