Copyright	(c) 2016-19 Brian W Bush
License	MIT
Maintainer	Brian W Bush <code@functionally.io>
Stability	Stable
Portability	Portable
Safe Haskell	None
Language	Haskell2010

System.Hardware.Leap

Contents

Configuration
Applications

Description

Interaction with Leap Motion <https://www.leapmotion.com/product/desktop>, based on the Web Socket API <https://developer.leapmotion.com/documentation/javascript/supplements/Leap_JSON.html>.

Here is a simple example applicaton that prints all events:

main :: IO ()
main =
  runWithHandler def [setFocused True, setGestures True] $ event ->
    print (event :: Event Float)

Synopsis

data Configuration = Configuration {
- host :: String
- port :: Int
}
data Version = Version {
- serviceVersion :: String
- version :: Int
}
setBackground :: Bool -> ConnectionModifier
setFocused :: Bool -> ConnectionModifier
setGestures :: Bool -> ConnectionModifier
setOptimizedHMD :: Bool -> ConnectionModifier
type ClientApp a = Connection -> IO a
type Handler a = Event a -> IO ()
run :: Configuration -> ClientApp a -> IO a
runWithHandler :: FromJSON a => Configuration -> [ConnectionModifier] -> Handler a -> IO ()

Configuration

data Configuration Source #

Configuration for a connection to a Leap Motion controller via Web Sockets.

Constructors

Configuration
Fields host :: String Host name. port :: Int Port number.

Instances

Eq Configuration Source #
Instance details Defined in System.Hardware.Leap Methods (==) :: Configuration -> Configuration -> Bool # (/=) :: Configuration -> Configuration -> Bool #
Ord Configuration Source #
Instance details Defined in System.Hardware.Leap Methods compare :: Configuration -> Configuration -> Ordering # (<) :: Configuration -> Configuration -> Bool # (<=) :: Configuration -> Configuration -> Bool # (>) :: Configuration -> Configuration -> Bool # (>=) :: Configuration -> Configuration -> Bool # max :: Configuration -> Configuration -> Configuration # min :: Configuration -> Configuration -> Configuration #
Read Configuration Source #
Instance details Defined in System.Hardware.Leap Methods readsPrec :: Int -> ReadS Configuration # readList :: ReadS [Configuration] # readPrec :: ReadPrec Configuration # readListPrec :: ReadPrec [Configuration] #
Show Configuration Source #
Instance details Defined in System.Hardware.Leap Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #
Default Configuration Source #
Instance details Defined in System.Hardware.Leap Methods def :: Configuration #

data Version Source #

Version information for Leap Motion.

Constructors

Version
Fields serviceVersion :: String version :: Int

Instances

Eq Version Source #
Instance details Defined in System.Hardware.Leap Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in System.Hardware.Leap Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
Read Version Source #
Instance details Defined in System.Hardware.Leap Methods readsPrec :: Int -> ReadS Version # readList :: ReadS [Version] # readPrec :: ReadPrec Version # readListPrec :: ReadPrec [Version] #
Show Version Source #
Instance details Defined in System.Hardware.Leap Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
FromJSON Version Source #
Instance details Defined in System.Hardware.Leap Methods parseJSON :: Value -> Parser Version # parseJSONList :: Value -> Parser [Version] #

setBackground Source #

Arguments

:: Bool	Whether to enable background events.
-> ConnectionModifier	Function for making the modification.

Enable or disable background events. See <https://developer.leapmotion.com/documentation/javascript/supplements/Leap_JSON.html> for details.

setFocused Source #

Arguments

:: Bool	Whether to enable focus.
-> ConnectionModifier	Function for making the modification.

Enable or disable focus. See <https://developer.leapmotion.com/documentation/javascript/supplements/Leap_JSON.html> for details.

setGestures Source #

Arguments

:: Bool	Whether to enable gestiure events.
-> ConnectionModifier	Function for making the modification.

Enable or disable gestures. See <https://developer.leapmotion.com/documentation/javascript/supplements/Leap_JSON.html> for details.

setOptimizedHMD Source #

Arguments

:: Bool	Whether to enable HMD optimization.
-> ConnectionModifier	Function for making the modification.

Enable or disable head-mounted-display optimization. See <https://developer.leapmotion.com/documentation/javascript/supplements/Leap_JSON.html> for details.

Applications

type ClientApp a Source #

Arguments

= Connection	The Web Socet connection.
-> IO a	Action for the client application.

A client application for Leap Motion using Web Sockets.

type Handler a Source #

Arguments

= Event a	The event.
-> IO ()	The action for handling the event.

A handler for Leap Motion events.

run Source #

Arguments

:: Configuration	The Web Socket configuration.
-> ClientApp a	The client application.
-> IO a	Action for running the client.

Run a Leap Motion application using Web Sockets.

runWithHandler Source #

Arguments

:: FromJSON a
=> Configuration	The Web Socket configuration.
-> [ConnectionModifier]	Modifications to be made to the connection.
-> Handler a	The event handler.
-> IO ()	Action for running with event handling.

Run and process events from Leap Motion using Web Sockets.