Commit Graph

22 Commits

Author SHA1 Message Date
Adam Honse
38f54de044 SDK Version 6 Updates
* SDK Protocol
    * Server sends its name to client
    * ProfileManager
      * Rename existing profile commands
      * Add Upload Profile, Download Profile, and Get Active Profile commands
    * SettingsManager
      * Add Get, Set, and Save Settings commands
    * Add zone::active_mode, zone::mode fields for zone-specific modes
    * Add NET_PACKET_ID_RGBCONTROLLER_UPDATEZONEMODE packet for updating zone modes
    * Add segment::matrix_map to segment packet
    * Add NET_PACKET_ID_RGBCONTROLLER_SIGNALUPDATE packet for passing SignalUpdate signal from server to clients
  * NetworkServer
    * Formatting cleanup
    * Use per-controller threads for handling NetworkServer controller-specific packets to avoid delays from controller mutexes
  * NetworkClient
    * Formatting cleanup
  * RGBController
    * Clean up and modularize descriptor functions
2026-01-11 13:11:08 -06:00
Adam Honse
a3b023d86c RGBController API Overhaul
* Reorganize and clean up RGBController API functions
    * Add functions to get protected RGBController member values
    * Make NetworkClient, ProfileManager, and ResourceManager friend classes so they can access protected members
    * Protected previously-public RGBController members
        * Information strings (name, vendor, description, version, serial location)
        * Device type
        * Active mode
        * Flags
        * LEDs vector
        * LED alternate names vector
        * Modes vector
        * Colors vector
        * Zones vector
    * Add CONTROLLER_FLAG_HIDDEN to allow plugins to hide controllers from control GUI
    * Add update reason codes to RGBController update callback and signal updates on more RGBController events
    * Add loop zone types and segmented zone type
    * Add matrix map field to segments
    * Rework matrix_map_type from using pointers to vector to prevent memory leaks
    * Rework KeyboardLayoutManager to return new matrix_map_type
    * Add access mutex to RGBController API
    * Add per-zone modes ot RGBController API
    * Add JSON description functions to RGBController API
2026-01-11 13:10:40 -06:00
Clément Villemur
b0a08c7d10 Added instructions to install udev rules for immutable systems 2025-11-29 17:02:03 -06:00
Adam Honse
c60cf5d2de Update SMBus documentation for PawnIO 2025-09-14 14:31:33 -05:00
Adam Honse
b113fd8cbc Update RGBController documentation 2025-08-26 20:16:28 -05:00
Adam Honse
1836b5e417 Update Detector documentation 2025-08-26 17:07:02 -05:00
Anshi Mehta
0eb082f21b docs: improve wording and clarity in mode description 2025-08-16 12:03:36 -05:00
Daniel Schaefer
0255b09e0e Compiling.md: Update MSVC runtime download URL 2025-08-02 14:23:13 -05:00
Arthur de Groot
3a508e71aa Update SDK docs 2025-07-24 10:16:57 -05:00
Adam Honse
5ea65eda5a Update Compiling.md Windows section to reference the OpenRGB-Qt-Packages and build-windows.bat method of building OpenRGB from source, which is the official build procedure used by the pipeline builds 2025-07-22 19:54:02 -05:00
Adam Honse
0cfe5ae0bb Add SDK command to rescan devices 2025-07-04 04:24:37 -05:00
Adam Honse
2e26a7f82d Update Nuvoton SMBus documentation for Linux 2025-06-26 02:56:44 -05:00
Adam Honse
313fda32c0 Add Common Modes documentation from the wiki repo 2025-06-26 01:40:02 -05:00
RedBlackAka
1f6be26489 Update device types in RGBControllerAPI documentation [authored by Nathan] 2025-04-09 08:07:35 -05:00
Adam Honse
85625a37b2 SDK cleanup, update SDK documentation 2025-02-06 20:00:27 -06:00
Андрей Белов
0b685dbc86 fix link 2025-01-23 01:12:58 -06:00
Peter Berendi
219b8909ed notice to install PowerShell 2025-01-18 02:43:47 +00:00
Adam Honse
d424b1f2b4 More protocol documentation updates 2025-01-10 21:53:21 -06:00
Adam Honse
ff2188ba45 Update SDK Documentation, fix plugin protocol version type in NetworkServer 2025-01-10 11:59:53 -06:00
Filip Krakowski
a3ca22e6a1 spd5118 kernel driver conflicts with Kingston Fury DRAM 2024-10-26 19:13:34 +00:00
Adam Honse
38f8fcc3f3 Update screenshot in README 2024-08-04 16:19:05 -05:00
Adam Honse
a5f1372537 Update documentation before 1.0 release 2024-08-03 02:16:09 -05:00