pydualsense/searchindex.js

Search.setIndex({"alltitles": {"API": [[0, null]], "Contents": [[5, "contents"]], "Examples": [[4, null], [8, "examples"]], "Installation": [[8, "installation"]], "Linux based": [[8, "linux-based"]], "Module contents": [[7, "module-contents"]], "Submodules": [[7, "submodules"]], "TODOs": [[5, "todos"]], "Usage": [[8, null]], "Welcome to pydualsense\u2019s documentation!": [[5, null]], "Windows": [[8, "windows"]], "pydualsense": [[6, null]], "pydualsense enums classes": [[1, null]], "pydualsense event system classes": [[2, null]], "pydualsense main class": [[3, null]], "pydualsense package": [[7, null]], "pydualsense.enums module": [[7, "module-pydualsense.enums"]], "pydualsense.event_system module": [[7, "module-pydualsense.event_system"]], "pydualsense.hidguardian module": [[7, "pydualsense-hidguardian-module"]], "pydualsense.pydualsense module": [[7, "pydualsense-pydualsense-module"]]}, "docnames": ["api", "ds_enum", "ds_eventsystem", "ds_main", "examples", "index", "modules", "pydualsense", "usage"], "envversion": {"sphinx": 64, "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.ext.todo": 2}, "filenames": ["api.rst", "ds_enum.rst", "ds_eventsystem.rst", "ds_main.rst", "examples.rst", "index.rst", "modules.rst", "pydualsense.rst", "usage.rst"], "indexentries": {"__init__() (pydualsense.event_system.event method)": [[7, "pydualsense.event_system.Event.__init__", false]], "all (pydualsense.enums.playerid attribute)": [[7, "pydualsense.enums.PlayerID.ALL", false]], "batterystate (class in pydualsense.enums)": [[7, "pydualsense.enums.BatteryState", false]], "both (pydualsense.enums.ledoptions attribute)": [[7, "pydualsense.enums.LedOptions.Both", false]], "brightness (class in pydualsense.enums)": [[7, "pydualsense.enums.Brightness", false]], "bt (pydualsense.enums.connectiontype attribute)": [[7, "pydualsense.enums.ConnectionType.BT", false]], "calibration (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Calibration", false]], "connectiontype (class in pydualsense.enums)": [[7, "pydualsense.enums.ConnectionType", false]], "error (pydualsense.enums.connectiontype attribute)": [[7, "pydualsense.enums.ConnectionType.ERROR", false]], "event (class in pydualsense.event_system)": [[7, "pydualsense.event_system.Event", false]], "fadeblue (pydualsense.enums.pulseoptions attribute)": [[7, "pydualsense.enums.PulseOptions.FadeBlue", false]], "fadeout (pydualsense.enums.pulseoptions attribute)": [[7, "pydualsense.enums.PulseOptions.FadeOut", false]], "high (pydualsense.enums.brightness attribute)": [[7, "pydualsense.enums.Brightness.high", false]], "ledoptions (class in pydualsense.enums)": [[7, "pydualsense.enums.LedOptions", false]], "low (pydualsense.enums.brightness attribute)": [[7, "pydualsense.enums.Brightness.low", false]], "medium (pydualsense.enums.brightness attribute)": [[7, "pydualsense.enums.Brightness.medium", false]], "module": [[7, "module-pydualsense.enums", false], [7, "module-pydualsense.event_system", false]], "off (pydualsense.enums.ledoptions attribute)": [[7, "pydualsense.enums.LedOptions.Off", false]], "off (pydualsense.enums.pulseoptions attribute)": [[7, "pydualsense.enums.PulseOptions.Off", false]], "off (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Off", false]], "player_1 (pydualsense.enums.playerid attribute)": [[7, "pydualsense.enums.PlayerID.PLAYER_1", false]], "player_2 (pydualsense.enums.playerid attribute)": [[7, "pydualsense.enums.PlayerID.PLAYER_2", false]], "player_3 (pydualsense.enums.playerid attribute)": [[7, "pydualsense.enums.PlayerID.PLAYER_3", false]], "player_4 (pydualsense.enums.playerid attribute)": [[7, "pydualsense.enums.PlayerID.PLAYER_4", false]], "playerid (class in pydualsense.enums)": [[7, "pydualsense.enums.PlayerID", false]], "playerledbrightness (pydualsense.enums.ledoptions attribute)": [[7, "pydualsense.enums.LedOptions.PlayerLedBrightness", false]], "power_supply_status_charging (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_CHARGING", false]], "power_supply_status_discharging (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_DISCHARGING", false]], "power_supply_status_error (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_ERROR", false]], "power_supply_status_full (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_FULL", false]], "power_supply_status_not_charging (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_NOT_CHARGING", false]], "power_supply_status_unknown (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_STATUS_UNKNOWN", false]], "power_supply_temp_or_voltage_out_of_range (pydualsense.enums.batterystate attribute)": [[7, "pydualsense.enums.BatteryState.POWER_SUPPLY_TEMP_OR_VOLTAGE_OUT_OF_RANGE", false]], "pulse (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Pulse", false]], "pulse_a (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Pulse_A", false]], "pulse_ab (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Pulse_AB", false]], "pulse_b (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Pulse_B", false]], "pulseoptions (class in pydualsense.enums)": [[7, "pydualsense.enums.PulseOptions", false]], "pydualsense.enums": [[7, "module-pydualsense.enums", false]], "pydualsense.event_system": [[7, "module-pydualsense.event_system", false]], "rigid (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Rigid", false]], "rigid_a (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Rigid_A", false]], "rigid_ab (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Rigid_AB", false]], "rigid_b (pydualsense.enums.triggermodes attribute)": [[7, "pydualsense.enums.TriggerModes.Rigid_B", false]], "subscribe() (pydualsense.event_system.event method)": [[7, "pydualsense.event_system.Event.subscribe", false]], "triggermodes (class in pydualsense.enums)": [[7, "pydualsense.enums.TriggerModes", false]], "uninterrumpableled (pydualsense.enums.ledoptions attribute)": [[7, "pydualsense.enums.LedOptions.UninterrumpableLed", false]], "unsubscribe() (pydualsense.event_system.event method)": [[7, "pydualsense.event_system.Event.unsubscribe", false]], "usb (pydualsense.enums.connectiontype attribute)": [[7, "pydualsense.enums.ConnectionType.USB", false]]}, "objects": {"pydualsense": [[7, 0, 0, "-", "enums"], [7, 0, 0, "-", "event_system"]], "pydualsense.enums": [[7, 1, 1, "", "BatteryState"], [7, 1, 1, "", "Brightness"], [7, 1, 1, "", "ConnectionType"], [7, 1, 1, "", "LedOptions"], [7, 1, 1, "", "PlayerID"], [7, 1, 1, "", "PulseOptions"], [7, 1, 1, "", "TriggerModes"]], "pydualsense.enums.BatteryState": [[7, 2, 1, "", "POWER_SUPPLY_STATUS_CHARGING"], [7, 2, 1, "", "POWER_SUPPLY_STATUS_DISCHARGING"], [7, 2, 1, "", "POWER_SUPPLY_STATUS_ERROR"], [7, 2, 1, "", "POWER_SUPPLY_STATUS_FULL"], [7, 2, 1, "", "POWER_SUPPLY_STATUS_NOT_CHARGING"], [7, 2, 1, "", "POWER_SUPPLY_STATUS_UNKNOWN"], [7, 2, 1, "", "POWER_SUPPLY_TEMP_OR_VOLTAGE_OUT_OF_RANGE"]], "pydualsense.enums.Brightness": [[7, 2, 1, "", "high"], [7, 2, 1, "", "low"], [7, 2, 1, "", "medium"]], "pydualsense.enums.ConnectionType": [[7, 2, 1, "", "BT"], [7, 2, 1, "", "ERROR"], [7, 2, 1, "", "USB"]], "pydualsense.enums.LedOptions": [[7, 2, 1, "", "Both"], [7, 2, 1, "", "Off"], [7, 2, 1, "", "PlayerLedBrightness"], [7, 2, 1, "", "UninterrumpableLed"]], "pydualsense.enums.PlayerID": [[7, 2, 1, "", "ALL"], [7, 2, 1, "", "PLAYER_1"], [7, 2, 1, "", "PLAYER_2"], [7, 2, 1, "", "PLAYER_3"], [7, 2, 1, "", "PLAYER_4"]], "pydualsense.enums.PulseOptions": [[7, 2, 1, "", "FadeBlue"], [7, 2, 1, "", "FadeOut"], [7, 2, 1, "", "Off"]], "pydualsense.enums.TriggerModes": [[7, 2, 1, "", "Calibration"], [7, 2, 1, "", "Off"], [7, 2, 1, "", "Pulse"], [7, 2, 1, "", "Pulse_A"], [7, 2, 1, "", "Pulse_AB"], [7, 2, 1, "", "Pulse_B"], [7, 2, 1, "", "Rigid"], [7, 2, 1, "", "Rigid_A"], [7, 2, 1, "", "Rigid_AB"], [7, 2, 1, "", "Rigid_B"]], "pydualsense.event_system": [[7, 1, 1, "", "Event"]], "pydualsense.event_system.Event": [[7, 3, 1, "", "__init__"], [7, 3, 1, "", "subscribe"], [7, 3, 1, "", "unsubscribe"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method"}, "terms": {"0": [4, 7], "1": [4, 7], "10": 7, "100": 4, "11": 7, "15": 7, "175": 4, "2": [4, 7], "200": 4, "21": 7, "252": 7, "255": [4, 7], "27": 7, "3": 7, "31": 7, "33": 7, "34": 7, "37": 7, "38": 7, "4": 7, "5": [5, 7], "6": 7, "For": 8, "If": 8, "It": [3, 5], "On": 8, "The": [1, 2, 4, 8], "These": 1, "To": [5, 8], "__init__": [2, 5, 6, 7], "_description_": [2, 7], "abov": 4, "access": 3, "activ": 5, "ad": 4, "add": [2, 4, 7], "all": [4, 5, 6, 7], "allow": 5, "also": [4, 5], "an": 4, "ani": [2, 7], "api": 5, "apt": 8, "ar": [1, 8], "base": [2, 5, 7], "batteryst": [5, 6, 7], "both": [5, 6, 7], "boundari": 7, "bright": [5, 6, 7], "bt": [5, 6, 7], "button": 2, "c": 4, "calibr": [5, 6, 7], "call": 1, "callabl": [2, 7], "callback": 2, "can": 4, "check": 5, "circl": 4, "circle_down": 4, "circle_press": 4, "class": [0, 5, 7], "close": 4, "code": 8, "connect": 4, "connectiontyp": [5, 6, 7], "content": 6, "control": [1, 3, 4, 5], "creat": 4, "cross": 4, "cross_down": 4, "cross_press": 4, "current": 5, "debian": 8, "def": 4, "delet": [2, 7], "demo": 4, "demonstr": 4, "depend": 8, "dev": 8, "develop": 5, "devic": 4, "displai": 4, "dll": 8, "document": 0, "down": 4, "download": 8, "dpad": 4, "dpad_down": 4, "driven": [2, 7], "dsstate": 3, "dualsens": [4, 5], "e": 8, "effect": 4, "enum": [0, 5, 6], "environ": 8, "error": [5, 6, 7], "event": [0, 4, 5, 6, 7], "event_system": [2, 5, 6], "examl": 8, "exampl": 5, "f": 4, "fadeblu": [5, 6, 7], "fadeout": [5, 6, 7], "feel": 4, "file": 8, "find": 4, "first": 8, "fn": [2, 7], "folder": 4, "forc": 4, "found": 4, "from": [4, 8], "front": 0, "function": [1, 2, 4, 7], "g": 8, "get": [4, 5], "github": 4, "given": 7, "gyro_chang": 4, "handler": 4, "help": 5, "here": 8, "hidapi": 8, "hidguardian": [5, 6], "high": [5, 6, 7], "how": [4, 5], "i": [0, 3, 4, 5, 8], "implement": 2, "import": 4, "index": 4, "inform": 5, "init": 4, "initi": 4, "initialis": [2, 7], "input": 4, "insid": 4, "instal": 5, "instanc": 4, "interact": 5, "intflag": 7, "itself": 8, "joystick": 4, "l2": 4, "ledopt": [5, 6, 7], "left": 4, "left_joystick_chang": 4, "libhidapi": 8, "librari": [0, 3, 4, 5, 8], "like": 4, "linux": 5, "loop": 4, "low": [5, 6, 7], "main": [0, 5], "make": 4, "manag": 8, "manual": 3, "medium": [5, 6, 7], "messag": 4, "modul": [1, 5, 6], "more": 5, "motor": 4, "name": [3, 7], "need": 8, "newli": 4, "none": [2, 7], "object": [2, 7], "off": [5, 6, 7], "option": 5, "other": 5, "out": 5, "packag": [5, 6, 8], "page": [0, 4], "paramet": [1, 2, 7], "path": 8, "pip": 8, "pitch": 4, "place": 8, "player_1": [5, 6, 7], "player_2": [5, 6, 7], "player_3": [5, 6, 7], "player_4": [5, 6, 7], "playerid": [5, 6, 7], "playerledbright": [5, 6, 7], "playstat": 5, "possibl": 4, "power_supply_status_charg": [5, 6, 7], "power_supply_status_discharg": [5, 6, 7], "power_supply_status_error": [5, 6, 7], "power_supply_status_ful": [5, 6, 7], "power_supply_status_not_charg": [5, 6, 7], "power_supply_status_unknown": [5, 6, 7], "power_supply_temp_or_voltage_out_of_rang": [5, 6, 7], "press": 4, "print": 4, "project": 5, "provid": [1, 3], "puls": [5, 6, 7], "pulse_a": [4, 5, 6, 7], "pulse_ab": [5, 6, 7], "pulse_b": [5, 6, 7], "pulseopt": [5, 6, 7], "pydualsens": [0, 4, 8], "python": 5, "qualnam": 7, "r1": 4, "r2": 4, "read": [3, 4, 5], "repositori": 4, "requir": 8, "right": 4, "rigid": [4, 5, 6, 7], "rigid_a": [5, 6, 7], "rigid_ab": [5, 6, 7], "rigid_b": [5, 6, 7], "roll": 4, "rumbl": 4, "same": 3, "section": 5, "see": 8, "set": 4, "setforc": 4, "setleftmotor": 4, "setmod": 4, "setrightmotor": 4, "some": 4, "start": [4, 5, 7], "state": [1, 3, 4, 5], "statei": 4, "statex": 4, "submodul": [5, 6], "subscrib": [2, 5, 6, 7], "subscript": [2, 7], "sudo": 8, "system": [0, 4, 5, 7, 8], "termin": 4, "thi": [0, 4, 5, 8], "thread": 4, "through": [3, 8], "trigger": [4, 5], "triggerl": 4, "triggermod": [4, 5, 6, 7], "triggerr": 4, "type": 7, "ubuntu": 8, "under": 5, "uninterrumpablel": [5, 6, 7], "unsubscrib": [2, 5, 6, 7], "until": 4, "updat": [1, 5], "upgrad": 8, "us": [1, 2, 4, 8], "usag": 5, "usb": [5, 6, 7], "valu": 7, "variabl": 8, "venv": 8, "while": 4, "window": 5, "yaw": 4, "you": [5, 8], "your": [5, 8]}, "titles": ["API", "pydualsense enums classes", "pydualsense event system classes", "pydualsense main class", "Examples", "Welcome to pydualsense\u2019s documentation!", "pydualsense", "pydualsense package", "Usage"], "titleterms": {"": 5, "api": 0, "base": 8, "class": [1, 2, 3], "content": [5, 7], "document": 5, "enum": [1, 7], "event": 2, "event_system": 7, "exampl": [4, 8], "hidguardian": 7, "instal": 8, "linux": 8, "main": 3, "modul": 7, "packag": 7, "pydualsens": [1, 2, 3, 5, 6, 7], "submodul": 7, "system": 2, "todo": 5, "usag": 8, "welcom": 5, "window": 8}})