Namespace pyspacemouse::api

Namespace List > pyspacemouse > api

Public Functions

Type	Name
List[Tuple[str, str, int, int]]	get_all_hid_devices ()
List[str]	get_connected_devices ()
List[Tuple[str, int, int]]	get_supported_devices ()
SpaceMouseDevice	open (Optional callback, None]] callback=None, Optional dof_callbacks, None]] dof_callback=None, Optional] dof_callbacks=None, Optional] nonblocking, None]] button_callback=None, Optional] button_callbacks=None, bool nonblocking=True, Optional device=None, int device_index=0, Optional device_spec=None)
SpaceMouseDevice	open_by_path (str\|Path path, Optional callback, None]] callback=None, Optional dof_callbacks, None]] dof_callback=None, Optional] dof_callbacks=None, Optional] nonblocking, None]] button_callback=None, Optional] button_callbacks=None, bool nonblocking=True, Optional device_spec=None)
SpaceMouseDevice	open_with_config (Config config, bool nonblocking=True, Optional device=None, int device_index=0)

Protected Functions

Type	Name
SpaceMouseDevice	_create_and_open_device (DeviceInfo spec, hid_device hid_device, Optional callback, None]] callback=None, Optional dof_callbacks, None]] dof_callback=None, Optional] dof_callbacks=None, Optional] nonblocking, None]] button_callback=None, Optional] button_callbacks=None, bool nonblocking=True)

Detailed Description

Public Functions Documentation

function get_all_hid_devices

List[Tuple[str, str, int, int]] pyspacemouse::api::get_all_hid_devices ()

function get_connected_devices

List[str] pyspacemouse::api::get_connected_devices ()

function get_supported_devices

List[Tuple[str, int, int]] pyspacemouse::api::get_supported_devices ()

function open

SpaceMouseDevice pyspacemouse::api::open (
    Optional callback,
    None]] callback=None,
    Optional dof_callbacks,
    None]] dof_callback=None,
    Optional] dof_callbacks=None,
    Optional] nonblocking,
    None]] button_callback=None,
    Optional] button_callbacks=None,
    bool nonblocking=True,
    Optional device=None,
    int device_index=0,
    Optional device_spec=None
)

function open_by_path

SpaceMouseDevice pyspacemouse::api::open_by_path (
    str|Path path,
    Optional callback,
    None]] callback=None,
    Optional dof_callbacks,
    None]] dof_callback=None,
    Optional] dof_callbacks=None,
    Optional] nonblocking,
    None]] button_callback=None,
    Optional] button_callbacks=None,
    bool nonblocking=True,
    Optional device_spec=None
)

function open_with_config

SpaceMouseDevice pyspacemouse::api::open_with_config (
    Config config,
    bool nonblocking=True,
    Optional device=None,
    int device_index=0
)

Protected Functions Documentation

function _create_and_open_device

SpaceMouseDevice pyspacemouse::api::_create_and_open_device (
    DeviceInfo spec,
    hid_device hid_device,
    Optional callback,
    None]] callback=None,
    Optional dof_callbacks,
    None]] dof_callback=None,
    Optional] dof_callbacks=None,
    Optional] nonblocking,
    None]] button_callback=None,
    Optional] button_callbacks=None,
    bool nonblocking=True
)

The documentation for this class was generated from the following file pyspacemouse/api.py