Internal Python API

Rivalcfg internal API contains documentation for every functions and classes implemented in this package. It is only useful to you if you want to hack into rivalcfg itself, or if you want to know how it works… If you only want to interact with SteelSeries mice from your own scripts, read the High Level Python API documentation instead.

Contents:

• color_helpers
  • is_color()
  • parse_color_gradient_string()
  • parse_color_string()
• cli
  • PrintDebugAction
  • PrintSupportedDevicesAction
  • PrintUdevRulesAction
  • UpdateUdevRulesAction
  • add_main_cli()
  • add_mouse_cli()
  • normalize_cli_option_name()
• devices
  • Profile spec
  • Module API
  • UnsupportedDevice
  • get_profile()
  • list_plugged_devices()
• handlers
  • none
  • choice
  • range
  • multidpi_range
  • rgbcolor
  • reactive_rgbcolor
  • rgbgradient
  • rgbgradientv2
  • buttons
• helpers
  • REGEXP_PARAM_STRING
  • bytes_to_high_low_nibbles()
  • merge_bytes()
  • module_ls()
  • nibbles_to_byte()
  • parse_param_string()
  • uint_to_little_endian_bytearray()
• mouse
  • Factory Function
  • Mouse Class
• mouse_settings
  • Factory Function
  • MouseSettings Class
  • Helper functions
• udev
  • RULES_FILE_PATH
  • are_rules_up_to_date()
  • generate_rules()
  • is_rules_file_up_to_date()
  • reload_rules()
  • trigger()
  • write_rules_file()
• usbhid
  • Constants
  • Functions
  • Exceptions
  • Fake HID device