leap

leap#

Description#

Integration to handle events from a Leap Motion device to track hands and gestures.

Note that the default SDK is not compatible with Python 3. Follow the instructions on BlackLight/leap-sdk-python3 to build the Python 3 module.

Also, you’ll need the Leap driver and utils installed on your OS (follow instructions at https://www.leapmotion.com/setup/) and the leapd daemon running to recognize your controller.

Requires:

Configuration#

leap:
  # [Optional]
  # It specifies how wide the hand space (x, y and
  # z axes) should be in millimiters.
  #
  # Default::
  #
  #     [
  #         [-300.0, 300.0],  # x axis
  #         [25.0, 600.0],    # y axis
  #         [-300.0, 300.0],  # z axis
  #     ]
  # position_ranges:   # type=Optional[Iterable[Iterable[float]]]

  # [Optional]
  # % of change between a frame and the next to
  # really consider the next frame as a new one (default: 0).
  # position_tolerance: 0.0  # type=float

  # [Optional]
  # How often the plugin should generate and push
  # events (default: at most one event each 0.1 seconds). Note that a
  # Leap Motion generates events with a very high throughput, so you
  # may want to set a higher value if you want to throttle the events
  # and avoid flooding the bus.
  # poll_interval: 0.1  # type=Optional[float]

  # [Optional]
  # How long we should wait for any running
  # threads/processes to stop before exiting (default: 5 seconds).
  # stop_timeout: 5  # type=Optional[float]

  # [Optional]
  # If set to True then the plugin will not monitor
  # for new events. This is useful if you want to run a plugin in
  # stateless mode and only leverage its actions, without triggering any
  # events. Defaults to False.
  # disable_monitor: False  # type=bool

Triggered events#

Module reference#

class platypush.plugins.leap.LeapFuture(seconds, listener, event)[source]#

Bases: Timer

__init__(seconds, listener, event)[source]#

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is a list or tuple of arguments for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

cancel()#

Stop the timer if it hasn’t finished yet.

property daemon#

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

getName()#

Return a string used for identification purposes only.

This method is deprecated, use the name attribute instead.

property ident#

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

isDaemon()#

Return whether this thread is a daemon.

This method is deprecated, use the daemon attribute instead.

is_alive()#

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate().

join(timeout=None)#

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating-point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

property name#

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property native_id#

Native integral thread ID of this thread, or None if it has not been started.

This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel.

run()#

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

setDaemon(daemonic)#

Set whether this thread is a daemon.

This method is deprecated, use the .daemon property instead.

setName(name)#

Set the name string for this thread.

This method is deprecated, use the name attribute instead.

start()#

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.

class platypush.plugins.leap.LeapListener(*args: Any, **_)[source]#

Bases: Listener

__init__(position_ranges, position_tolerance, logger, frames_throttle_secs=None)[source]#
class platypush.plugins.leap.LeapPlugin(position_ranges: Iterable[Iterable[float]] | None = None, position_tolerance: float = 0.0, poll_interval: float | None = 0.1, **kwargs)[source]#

Bases: RunnablePlugin

Integration to handle events from a Leap Motion device to track hands and gestures.

Note that the default SDK is not compatible with Python 3. Follow the instructions on BlackLight/leap-sdk-python3 to build the Python 3 module.

Also, you’ll need the Leap driver and utils installed on your OS (follow instructions at https://www.leapmotion.com/setup/) and the leapd daemon running to recognize your controller.

Requires:

__init__(position_ranges: Iterable[Iterable[float]] | None = None, position_tolerance: float = 0.0, poll_interval: float | None = 0.1, **kwargs)[source]#
Parameters:

  • position_ranges –

    It specifies how wide the hand space (x, y and z axes) should be in millimiters.

    Default:

    [
    [-300.0, 300.0],  # x axis
    [25.0, 600.0],    # y axis
    [-300.0, 300.0],  # z axis
]

  • position_tolerance – % of change between a frame and the next to really consider the next frame as a new one (default: 0).

  • poll_interval – How often the plugin should generate and push events (default: at most one event each 0.1 seconds). Note that a Leap Motion generates events with a very high throughput, so you may want to set a higher value if you want to throttle the events and avoid flooding the bus.

main()[source]#

Implementation of the main loop of the plugin.

start()#

Start the plugin.

stop()#

Stop the plugin.

wait_stop(timeout=None)#

Wait until a stop event is received.