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

System.Hardware.Linux.Joystick

Contents

Types and values
Event handling

Description

Interpret events from a Linux joystick, which must conform to the Linux Joystick API <https://www.kernel.org/doc/Documentation/input/joystick-api.txt>.

Synopsis

data Joystick = Joystick {
- timestamp :: Int
- value :: Int
- number :: Int
- button :: Bool
- axis :: Bool
- initial :: Bool
}
minValue :: Int
maxValue :: Int
byteLength :: Integral a => a
interpretJoystick :: ByteString -> Joystick
readJoystick :: FilePath -> IO [Joystick]

Types and values

data Joystick Source #

Joystick data. See <https://www.kernel.org/doc/Documentation/input/joystick-api.txt> for details.

Constructors

Joystick
Fields timestamp :: Int The event timestamp in milliseconds. value :: Int The data value. number :: Int The button or axis number. button :: Bool Whether the button is being reported. axis :: Bool Whether the axis is being reported. initial :: Bool Whether the initial value is being reported.

Instances

Eq Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods (==) :: Joystick -> Joystick -> Bool # (/=) :: Joystick -> Joystick -> Bool #
Ord Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods compare :: Joystick -> Joystick -> Ordering # (<) :: Joystick -> Joystick -> Bool # (<=) :: Joystick -> Joystick -> Bool # (>) :: Joystick -> Joystick -> Bool # (>=) :: Joystick -> Joystick -> Bool # max :: Joystick -> Joystick -> Joystick # min :: Joystick -> Joystick -> Joystick #
Read Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods readsPrec :: Int -> ReadS Joystick # readList :: ReadS [Joystick] # readPrec :: ReadPrec Joystick # readListPrec :: ReadPrec [Joystick] #
Show Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods showsPrec :: Int -> Joystick -> ShowS # show :: Joystick -> String # showList :: [Joystick] -> ShowS #
Generic Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Associated Types type Rep Joystick :: Type -> Type # Methods from :: Joystick -> Rep Joystick x # to :: Rep Joystick x -> Joystick #
ToJSON Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods toJSON :: Joystick -> Value # toEncoding :: Joystick -> Encoding # toJSONList :: [Joystick] -> Value # toEncodingList :: [Joystick] -> Encoding #
FromJSON Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods parseJSON :: Value -> Parser Joystick # parseJSONList :: Value -> Parser [Joystick] #
Binary Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods put :: Joystick -> Put # get :: Get Joystick # putList :: [Joystick] -> Put #
Serialize Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick Methods put :: Putter Joystick # get :: Get Joystick #
type Rep Joystick Source #
Instance details Defined in System.Hardware.Linux.Joystick type Rep Joystick = D1 (MetaData "Joystick" "System.Hardware.Linux.Joystick" "kafka-device-joystick-1.0.2.1-2LWdfhNoKX43OfVatFy20z" False) (C1 (MetaCons "Joystick" PrefixI True) ((S1 (MetaSel (Just "timestamp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: (S1 (MetaSel (Just "value") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "number") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :: (S1 (MetaSel (Just "button") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "axis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "initial") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

minValue :: Int Source #

The minimum for value.

maxValue :: Int Source #

The maximum for value.

byteLength :: Integral a => a Source #

The number of bytes in a joystick event.

Event handling

interpretJoystick Source #

Arguments

:: ByteString	The eight bytes.
-> Joystick	The corresponding joystick data.

Interpret Linux Joystick bytes accoding to <https://www.kernel.org/doc/Documentation/input/joystick-api.txt>.

readJoystick Source #

Arguments

:: FilePath	The joystick device, e.g., "/dev/input/js0".
-> IO [Joystick]	Action to read the joystick data.

Read a stream of joystick data.