Skip to content

Class pyspacemouse::device::SpaceMouseDevice

ClassList > pyspacemouse > device > SpaceMouseDevice

More...

Public Functions

Type Name
SpaceMouseDevice __enter__ (self self)
None __exit__ (self self, exc_type exc_type, exc_val exc_val, exc_tb exc_tb)
None __init__ (self self, DeviceInfo info, Optional hid_info=None, bool nonblocking=True)
None clear_callbacks (self self)
None close (self self)
None configure (self self, Optional callback, None]] callback=None, Optional dof_callbacks, None]] dof_callback=None, Optional] dof_callbacks=None, Optional], None]] button_callback=None, Optional] button_callbacks=None)
bool connected (self self)
str describe_connection (self self)
str get_button_name (self self, int index)
DeviceInfo info (self self)
str name (self self)
None open (self self)
str product_name (self self)
SpaceMouseState read (self self)
str serial_number (self self)
None set_config (self self, Config config)
None set_led (self self, bool state)
SpaceMouseState state (self self)
str vendor_name (self self)
str version_number (self self)

Protected Attributes

Type Name
_button_callback
_button_callbacks
_callback
_device
_dof_callback
_dof_callbacks
_hid_info
_info
_last_axis_time
_nonblocking
_product_name
_serial_number
_state
_vendor_name
_version_number

Protected Functions

Type Name
None _invoke_callbacks (self self, bool dof_changed, bool button_changed)
None _process (self self, bytes data)

Detailed Description

Public Functions Documentation

function __enter__

SpaceMouseDevice pyspacemouse::device::SpaceMouseDevice::__enter__ (
    self self
)

function __exit__

None pyspacemouse::device::SpaceMouseDevice::__exit__ (
    self self,
    exc_type exc_type,
    exc_val exc_val,
    exc_tb exc_tb
)

function __init__

None pyspacemouse::device::SpaceMouseDevice::__init__ (
    self self,
    DeviceInfo info,
    Optional hid_info=None,
    bool nonblocking=True
)

function clear_callbacks

None pyspacemouse::device::SpaceMouseDevice::clear_callbacks (
    self self
)

function close

None pyspacemouse::device::SpaceMouseDevice::close (
    self self
)

function configure

None pyspacemouse::device::SpaceMouseDevice::configure (
    self self,
    Optional callback,
    None]] callback=None,
    Optional dof_callbacks,
    None]] dof_callback=None,
    Optional] dof_callbacks=None,
    Optional],
    None]] button_callback=None,
    Optional] button_callbacks=None
)

function connected

bool pyspacemouse::device::SpaceMouseDevice::connected (
    self self
)

function describe_connection

str pyspacemouse::device::SpaceMouseDevice::describe_connection (
    self self
)

function get_button_name

str pyspacemouse::device::SpaceMouseDevice::get_button_name (
    self self,
    int index
)

function info

DeviceInfo pyspacemouse::device::SpaceMouseDevice::info (
    self self
)

function name

str pyspacemouse::device::SpaceMouseDevice::name (
    self self
)

function open

None pyspacemouse::device::SpaceMouseDevice::open (
    self self
)

function product_name

str pyspacemouse::device::SpaceMouseDevice::product_name (
    self self
)

function read

SpaceMouseState pyspacemouse::device::SpaceMouseDevice::read (
    self self
)

function serial_number

str pyspacemouse::device::SpaceMouseDevice::serial_number (
    self self
)

function set_config

None pyspacemouse::device::SpaceMouseDevice::set_config (
    self self,
    Config config
)

function set_led

None pyspacemouse::device::SpaceMouseDevice::set_led (
    self self,
    bool state
)

function state

SpaceMouseState pyspacemouse::device::SpaceMouseDevice::state (
    self self
)

function vendor_name

str pyspacemouse::device::SpaceMouseDevice::vendor_name (
    self self
)

function version_number

str pyspacemouse::device::SpaceMouseDevice::version_number (
    self self
)

Protected Attributes Documentation

variable _button_callback

pyspacemouse.device.SpaceMouseDevice::_button_callback;

variable _button_callbacks

pyspacemouse.device.SpaceMouseDevice::_button_callbacks;

variable _callback

pyspacemouse.device.SpaceMouseDevice::_callback;

variable _device

pyspacemouse.device.SpaceMouseDevice::_device;

variable _dof_callback

pyspacemouse.device.SpaceMouseDevice::_dof_callback;

variable _dof_callbacks

pyspacemouse.device.SpaceMouseDevice::_dof_callbacks;

variable _hid_info

pyspacemouse.device.SpaceMouseDevice::_hid_info;

variable _info

pyspacemouse.device.SpaceMouseDevice::_info;

variable _last_axis_time

pyspacemouse.device.SpaceMouseDevice::_last_axis_time;

variable _nonblocking

pyspacemouse.device.SpaceMouseDevice::_nonblocking;

variable _product_name

pyspacemouse.device.SpaceMouseDevice::_product_name;

variable _serial_number

pyspacemouse.device.SpaceMouseDevice::_serial_number;

variable _state

pyspacemouse.device.SpaceMouseDevice::_state;

variable _vendor_name

pyspacemouse.device.SpaceMouseDevice::_vendor_name;

variable _version_number

pyspacemouse.device.SpaceMouseDevice::_version_number;

Protected Functions Documentation

function _invoke_callbacks

None pyspacemouse::device::SpaceMouseDevice::_invoke_callbacks (
    self self,
    bool dof_changed,
    bool button_changed
)

function _process

None pyspacemouse::device::SpaceMouseDevice::_process (
    self self,
    bytes data
)

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