Welcome to OpenRGB-Python’s documentation!

Contents:

• Introduction
  • Installation
• Basic Usage
  • Initialization
  • Selecting Devices
  • Setting colors
  • Changing Modes
  • Saving Modes
  • Resizing Zones
  • Using Profiles
    • Old Profile System
• Writing Custom Effects
  • Basics
  • FastLED-like Control Flow
• Plugins
  • OpenRGBEffectsPlugin
• Advanced Usage
  • Modifying Modes
  • Optimizing for Speed
  • Controlling the SDK Connection
  • Offline Profile Editing
  • SDK Protocol Version
• Frequently Asked Questions
  • Why is my code giving weird errors and/or crashing OpenRGB?
  • What does the fast parameter do?
  • Why does my program only work when <device> isn’t connected?
  • My RGB device(s) isn’t doing what I want!
  • What is “Direct” mode?
• API
  • Module contents
    • OpenRGBClient
      • OpenRGBClient.clear()
      • OpenRGBClient.connect()
      • OpenRGBClient.delete_profile()
      • OpenRGBClient.disconnect()
      • OpenRGBClient.ee_devices
      • OpenRGBClient.get_devices_by_name()
      • OpenRGBClient.get_devices_by_type()
      • OpenRGBClient.load_profile()
      • OpenRGBClient.protocol_version
      • OpenRGBClient.save_profile()
      • OpenRGBClient.set_color()
      • OpenRGBClient.show()
      • OpenRGBClient.update()
      • OpenRGBClient.update_plugins()
      • OpenRGBClient.update_profiles()
  • Submodules
    • openrgb.network module
      • NetworkClient
    • openrgb.orgb module
      • Device
      • LED
      • OpenRGBClient
      • Segment
      • Zone
    • openrgb.utils module
      • ControllerData
      • ControllerParsingError
      • DeviceType
      • LEDData
      • LocalProfile
      • MetaData
      • ModeColors
      • ModeData
      • ModeDirections
      • ModeFlags
      • OpenRGBDisconnected
      • PacketType
      • Plugin
      • Profile
      • RGBColor
      • RGBContainer
      • RGBObject
      • SDKVersionError
      • SegmentData
      • ZoneData
      • ZoneType
      • pack_list()
      • pack_string()
      • parse_list()
      • parse_string()
      • parse_var()

Indices and tables

• Index

• Module Index

• Search Page