libratbag/searchindex.js

Search.setIndex({"docnames": ["dbus", "index"], "filenames": ["dbus.rst", "index.rst"], "titles": ["DBus API", "The libratbag DBus API"], "terms": {"interfac": [0, 1], "i": [0, 1], "subject": [0, 1], "chang": [0, 1], "set": 0, "three": 0, "step": 0, "process": 0, "variou": 0, "properti": 0, "desir": 0, "valu": 0, "invok": 0, "commit": 0, "option": 0, "an": 0, "error": 0, "occur": 0, "write": 0, "new": 0, "data": 0, "resync": 0, "signal": 0, "emit": 0, "all": 0, "ar": 0, "updat": 0, "accordingli": 0, "The": 0, "time": 0, "take": 0, "vari": 0, "greatli": 0, "ani": 0, "caller": 0, "must": 0, "prepar": 0, "receiv": 0, "sever": 0, "second": 0, "after": 0, "For": 0, "easier": 0, "debug": 0, "object": 0, "path": 0, "construct": 0, "from": 0, "e": 0, "g": 0, "ratbag": 0, "event5": 0, "p0": 0, "b10": 0, "10": 0, "0": 0, "name": 0, "do": 0, "reli": 0, "your": 0, "applic": 0, "us": 0, "descript": 0, "b": 0, "bool": 0, "o": 0, "": 0, "string": 0, "u": 0, "unsign": 0, "32": 0, "bit": 0, "integ": 0, "uuu": 0, "A": 0, "triplet": 0, "ao": 0, "arrai": 0, "au": 0, "uu": 0, "2": 0, "tupl": 0, "detail": 0, "each": 0, "see": 0, "specif": 0, "mark": 0, "constant": 0, "lifetim": 0, "mutabl": 0, "mai": 0, "propertychang": 0, "sent": 0, "those": 0, "unless": 0, "otherwis": 0, "specifi": 0, "entri": 0, "point": 0, "interact": 0, "ratbagd": 0, "apivers": 0, "read": 0, "onli": 0, "version": 0, "thi": [0, 1], "stopgap": 0, "featur": 0, "while": 0, "still": 0, "flux": 0, "ha": 0, "backward": 0, "forward": 0, "compat": 0, "guarante": 0, "client": 0, "understand": 0, "exactli": 0, "same": 0, "enough": 0, "support": 0, "older": 0, "newer": 0, "remov": 0, "onc": 0, "declar": 0, "stabl": 0, "referenc": 0, "avail": 0, "implement": 0, "describ": [0, 1], "singl": 0, "known": 0, "model": 0, "id": 0, "identifi": 0, "physic": 0, "uniqu": 0, "alwai": 0, "ident": 0, "one": 0, "follow": 0, "format": 0, "usb": 0, "1234": 0, "abcd": 0, "bluetooth": 0, "5678": 0, "ef01": 0, "unknown": 0, "In": 0, "futur": 0, "other": 0, "get": 0, "ad": 0, "ignor": 0, "start": 0, "bu": 0, "4": 0, "digit": 0, "lowercas": 0, "hex": 0, "vendor": 0, "product": 0, "decim": 0, "number": 0, "unspecifi": 0, "length": 0, "These": 0, "four": 0, "element": 0, "separ": 0, "colon": 0, "cannot": 0, "determin": 0, "usual": 0, "bug": 0, "libratbag": 0, "reserv": 0, "differ": 0, "consid": 0, "exampl": 0, "increas": 0, "when": 0, "manufactur": 0, "re": 0, "valid": 0, "test": 0, "suitabl": 0, "present": 0, "user": 0, "firmwarevers": 0, "firmwar": 0, "empti": 0, "major": 0, "minor": 0, "pure": 0, "numer": 0, "convers": 0, "defin": 0, "provid": 0, "list": 0, "call": 0, "succe": 0, "written": 0, "asynchron": 0, "where": 0, "current": 0, "state": 0, "intern": 0, "upon": 0, "expect": 0, "index": 0, "zero": 0, "base": 0, "If": 0, "disabl": 0, "true": 0, "fals": 0, "might": 0, "have": 0, "correct": 0, "bind": 0, "so": 0, "good": 0, "thing": 0, "rebind": 0, "everyth": 0, "befor": 0, "isact": 0, "activ": 0, "can": 0, "never": 0, "least": 0, "setact": 0, "method": 0, "isdirti": 0, "dirti": 0, "need": 0, "being": 0, "configur": 0, "becom": 0, "whenev": 0, "anglesnap": 0, "sensor": 0, "angl": 0, "snap": 0, "boolean": 0, "int": 0, "1": 0, "indic": 0, "doesn": 0, "t": 0, "debounc": 0, "millisecond": 0, "assign": 0, "allow": 0, "permit": 0, "sort": 0, "ascend": 0, "lowest": 0, "first": 0, "item": 0, "doe": 0, "reportr": 0, "uint": 0, "report": 0, "rate": 0, "hz": 0, "capabl": 0, "mask": 0, "definit": 0, "x": 0, "y": 0, "ax": 0, "enabl": 0, "gener": 0, "fail": 0, "sourc": 0, "ratbag_resolution_cap": 0, "h": 0, "extra": 0, "isdefault": 0, "default": 0, "setdefault": 0, "isdis": 0, "v": 0, "dpi": 0, "variant": 0, "both": 0, "axi": 0, "leav": 0, "intact": 0, "previous": 0, "export": 0, "invalid": 0, "equal": 0, "map": 0, "uv": 0, "actiontyp": 0, "denot": 0, "macro": 0, "keycod": 0, "kei": 0, "releas": 0, "event": 0, "press": 0, "none": 0, "No": 0, "logic": 0, "3": 0, "simpl": 0, "action": 0, "sequenc": 0, "1000": 0, "unread": 0, "them": 0, "mode": 0, "enum": 0, "off": 0, "bright": 0, "cycl": 0, "through": 0, "color": 0, "breath": 0, "style": 0, "anim": 0, "rgb": 0, "signific": 0, "colordepth": 0, "outsid": 0, "depth": 0, "per": 0, "monochrom": 0, "8": 0, "manipul": 0, "effectdur": 0, "effect": 0, "durat": 0, "m": 0, "possibl": 0, "rang": 0, "10000": 0, "normal": 0, "255": 0, "inclus": 0, "less": 0, "than": 0, "manner": 0, "0x40000000": 0, "30": 0, "offset": 0, "0x40000001": 0, "doublelick": 0, "0x40000002": 0, "wheel": 0, "left": 0, "0x40000003": 0, "right": 0, "0x40000004": 0, "up": 0, "5": 0, "0x40000005": 0, "down": 0, "6": 0, "0x40000006": 0, "ratchet": 0, "switch": 0, "7": 0, "0x40000007": 0, "0x40000008": 0, "9": 0, "0x40000009": 0, "0x4000000a": 0, "11": 0, "0x4000000b": 0, "altern": 0, "12": 0, "0x4000000c": 0, "13": 0, "0x4000000d": 0, "14": 0, "0x4000000e": 0, "15": 0, "0x4000000f": 0, "16": 0, "0x40000010": 0, "17": 0, "0x40000011": 0, "18": 0, "0x40000012": 0, "batteri": 0, "level": 0, "note": 1, "org": 1, "freedesktop": 1, "ratbag1": 1, "manag": 1, "devic": 1, "profil": 1, "resolut": 1, "button": 1, "led": 1, "special": 1, "function": 1, "document": 1, "public": 1}, "objects": {"": [[0, 0, 1, "", "APIVersion"], [0, 0, 1, "", "ActionTypes"], [0, 0, 1, "", "AngleSnapping"], [0, 0, 1, "", "Brightness"], [0, 0, 1, "", "Buttons"], [0, 0, 1, "", "Capabilities"], [0, 0, 1, "", "Color"], [0, 0, 1, "", "ColorDepth"], [0, 1, 1, "", "Commit"], [0, 0, 1, "", "Debounce"], [0, 0, 1, "", "Debounces"], [0, 0, 1, "", "Devices"], [0, 0, 1, "", "Disabled"], [0, 0, 1, "", "EffectDuration"], [0, 0, 1, "", "FirmwareVersion"], [0, 0, 1, "id6", "Index"], [0, 0, 1, "id2", "IsActive"], [0, 0, 1, "", "IsDefault"], [0, 0, 1, "", "IsDirty"], [0, 0, 1, "", "IsDisabled"], [0, 0, 1, "", "Leds"], [0, 0, 1, "", "Mapping"], [0, 0, 1, "", "Mode"], [0, 0, 1, "", "Model"], [0, 0, 1, "", "Modes"], [0, 0, 1, "id0", "Name"], [0, 0, 1, "", "Profiles"], [0, 0, 1, "", "ReportRate"], [0, 0, 1, "", "ReportRates"], [0, 0, 1, "", "Resolution"], [0, 0, 1, "id3", "Resolutions"], [0, 1, 1, "", "Resync"], [0, 1, 1, "id4", "SetActive"], [0, 1, 1, "", "SetDefault"]]}, "objtypes": {"0": "py:attribute", "1": "py:function"}, "objnames": {"0": ["py", "attribute", "Python attribute"], "1": ["py", "function", "Python function"]}, "titleterms": {"dbu": [0, 1], "api": [0, 1], "note": 0, "type": 0, "flag": 0, "org": 0, "freedesktop": 0, "ratbag1": 0, "manag": 0, "devic": 0, "profil": 0, "resolut": 0, "button": 0, "led": 0, "special": 0, "function": 0, "The": 1, "libratbag": 1, "content": 1}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"DBus API": [[0, "dbus-api"]], "Notes on the DBus API": [[0, "notes-on-the-dbus-api"]], "Types": [[0, "types"]], "Flags": [[0, "flags"]], "org.freedesktop.ratbag1.Manager": [[0, "org-freedesktop-ratbag1-manager"]], "org.freedesktop.ratbag1.Device": [[0, "org-freedesktop-ratbag1-device"]], "org.freedesktop.ratbag1.Profile": [[0, "org-freedesktop-ratbag1-profile"]], "org.freedesktop.ratbag1.Resolution": [[0, "org-freedesktop-ratbag1-resolution"]], "org.freedesktop.ratbag1.Button": [[0, "org-freedesktop-ratbag1-button"]], "org.freedesktop.ratbag1.Led": [[0, "org-freedesktop-ratbag1-led"]], "Special button functions": [[0, "special-button-functions"]], "The libratbag DBus API": [[1, "the-libratbag-dbus-api"]], "Contents:": [[1, null]]}, "indexentries": {"apiversion": [[0, "APIVersion"]], "actiontypes": [[0, "ActionTypes"]], "anglesnapping": [[0, "AngleSnapping"]], "brightness": [[0, "Brightness"]], "buttons": [[0, "Buttons"]], "capabilities": [[0, "Capabilities"]], "color": [[0, "Color"]], "colordepth": [[0, "ColorDepth"]], "commit()": [[0, "Commit"]], "debounce": [[0, "Debounce"]], "debounces": [[0, "Debounces"]], "devices": [[0, "Devices"]], "disabled": [[0, "Disabled"]], "effectduration": [[0, "EffectDuration"]], "firmwareversion": [[0, "FirmwareVersion"]], "index": [[0, "Index"], [0, "id1"], [0, "id5"], [0, "id6"]], "isactive": [[0, "IsActive"], [0, "id2"]], "isdefault": [[0, "IsDefault"]], "isdirty": [[0, "IsDirty"]], "isdisabled": [[0, "IsDisabled"]], "leds": [[0, "Leds"]], "mapping": [[0, "Mapping"]], "mode": [[0, "Mode"]], "model": [[0, "Model"]], "modes": [[0, "Modes"]], "name": [[0, "Name"], [0, "id0"]], "profiles": [[0, "Profiles"]], "reportrate": [[0, "ReportRate"]], "reportrates": [[0, "ReportRates"]], "resolution": [[0, "Resolution"]], "resolutions": [[0, "Resolutions"], [0, "id3"]], "resync()": [[0, "Resync"]], "setactive()": [[0, "SetActive"], [0, "id4"]], "setdefault()": [[0, "SetDefault"]], "built-in function": [[0, "Commit"], [0, "Resync"], [0, "SetActive"], [0, "SetDefault"], [0, "id4"]]}})