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

Network.UI.Kafka.Interpretation

Contents

Types
Event handling
Orphan instances

Description

Interpret user-interfaces events on Kafka topics.

Synopsis

data Interpretation a b = TrackInterpretation {
- kafka :: TopicConnection
- sensor :: Sensor
- device :: a
- xAxis :: AxisInterpretation b
- yAxis :: AxisInterpretation b
- zAxis :: AxisInterpretation b
- phiAxis :: AxisInterpretation b
- thetaAxis :: AxisInterpretation b
- psiAxis :: AxisInterpretation b
- location :: V3 b
- orientation :: V3 b
- flying :: Bool
- resetButton :: Maybe Int
}
data AxisInterpretation a = AxisInterpretation {
- axisNumber :: Int
- threshold :: Maybe a
- increment :: a
- lowerBound :: Maybe a
- upperBound :: Maybe a
}
type AnalogHandler a b = b -> Maybe (Int, a)
type ButtonHandler a b = b -> Maybe (Int, Bool)
interpretationLoop :: (Conjugate b, Epsilon b, Num b, Ord b, RealFloat b) => AnalogHandler b c -> ButtonHandler b c -> Interpretation a b -> IO c -> IO (ExitAction, LoopAction)

Types

data Interpretation a b Source #

Instructions for interpreting user-interface events from Kafka.

Constructors

TrackInterpretation

Fields

kafka :: TopicConnection
How to connect to Kafka.
sensor :: Sensor
The name of the sensor.
device :: a
The device.
xAxis :: AxisInterpretation b
Interpretation for the x-axis.
yAxis :: AxisInterpretation b
Interpretation for the y-axis.
zAxis :: AxisInterpretation b
Interpretation for the z-axis.
phiAxis :: AxisInterpretation b
Interpretation for the Euler angle about the x-axis.
thetaAxis :: AxisInterpretation b
Interpretation for the Euler angle about the y-axis.
psiAxis :: AxisInterpretation b
Interpretation for the Euler angle about the z-axis.
location :: V3 b
The initial location, (x, y, z).
orientation :: V3 b
The initial orientation, (phi, theta, psi).
flying :: Bool
Whether to interpret displacements as being relative to the current orientation.
resetButton :: Maybe Int
The button number for resetting the location and orientation to their initial values.

Instances

(Eq a, Eq b) => Eq (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods (==) :: Interpretation a b -> Interpretation a b -> Bool # (/=) :: Interpretation a b -> Interpretation a b -> Bool #
(Read a, Read b) => Read (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods readsPrec :: Int -> ReadS (Interpretation a b) # readList :: ReadS [Interpretation a b] # readPrec :: ReadPrec (Interpretation a b) # readListPrec :: ReadPrec [Interpretation a b] #
(Show a, Show b) => Show (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods showsPrec :: Int -> Interpretation a b -> ShowS # show :: Interpretation a b -> String # showList :: [Interpretation a b] -> ShowS #
Generic (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Associated Types type Rep (Interpretation a b) :: Type -> Type # Methods from :: Interpretation a b -> Rep (Interpretation a b) x # to :: Rep (Interpretation a b) x -> Interpretation a b #
(ToJSON a, ToJSON b) => ToJSON (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods toJSON :: Interpretation a b -> Value # toEncoding :: Interpretation a b -> Encoding # toJSONList :: [Interpretation a b] -> Value # toEncodingList :: [Interpretation a b] -> Encoding #
(FromJSON a, FromJSON b) => FromJSON (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods parseJSON :: Value -> Parser (Interpretation a b) # parseJSONList :: Value -> Parser [Interpretation a b] #
type Rep (Interpretation a b) Source #
Instance details Defined in Network.UI.Kafka.Interpretation type Rep (Interpretation a b) = D1 (MetaData "Interpretation" "Network.UI.Kafka.Interpretation" "kafka-device-1.0.0.0-EqsHhyPPoUkHjkzPUXhYxI" False) (C1 (MetaCons "TrackInterpretation" PrefixI True) (((S1 (MetaSel (Just "kafka") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TopicConnection) :: (S1 (MetaSel (Just "sensor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Sensor) :: S1 (MetaSel (Just "device") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) :: (S1 (MetaSel (Just "xAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b)) :: (S1 (MetaSel (Just "yAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b)) :: S1 (MetaSel (Just "zAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b))))) :: ((S1 (MetaSel (Just "phiAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b)) :: (S1 (MetaSel (Just "thetaAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b)) :: S1 (MetaSel (Just "psiAxis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AxisInterpretation b)))) :: ((S1 (MetaSel (Just "location") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (V3 b)) :: S1 (MetaSel (Just "orientation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (V3 b))) :: (S1 (MetaSel (Just "flying") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "resetButton") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))))))

data AxisInterpretation a Source #

Instructions for interpreting an axis.

Constructors

AxisInterpretation
Fields axisNumber :: Int The axis number. threshold :: Maybe a The threshold for forwarding events. increment :: a How much to increment the axis per unit of change. lowerBound :: Maybe a The minimum value for the axis position. upperBound :: Maybe a The maximum value for the axis position.

Instances

Eq a => Eq (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods (==) :: AxisInterpretation a -> AxisInterpretation a -> Bool # (/=) :: AxisInterpretation a -> AxisInterpretation a -> Bool #
Read a => Read (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods readsPrec :: Int -> ReadS (AxisInterpretation a) # readList :: ReadS [AxisInterpretation a] # readPrec :: ReadPrec (AxisInterpretation a) # readListPrec :: ReadPrec [AxisInterpretation a] #
Show a => Show (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods showsPrec :: Int -> AxisInterpretation a -> ShowS # show :: AxisInterpretation a -> String # showList :: [AxisInterpretation a] -> ShowS #
Generic (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Associated Types type Rep (AxisInterpretation a) :: Type -> Type # Methods from :: AxisInterpretation a -> Rep (AxisInterpretation a) x # to :: Rep (AxisInterpretation a) x -> AxisInterpretation a #
ToJSON a => ToJSON (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods toJSON :: AxisInterpretation a -> Value # toEncoding :: AxisInterpretation a -> Encoding # toJSONList :: [AxisInterpretation a] -> Value # toEncodingList :: [AxisInterpretation a] -> Encoding #
FromJSON a => FromJSON (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation Methods parseJSON :: Value -> Parser (AxisInterpretation a) # parseJSONList :: Value -> Parser [AxisInterpretation a] #
type Rep (AxisInterpretation a) Source #
Instance details Defined in Network.UI.Kafka.Interpretation type Rep (AxisInterpretation a) = D1 (MetaData "AxisInterpretation" "Network.UI.Kafka.Interpretation" "kafka-device-1.0.0.0-EqsHhyPPoUkHjkzPUXhYxI" False) (C1 (MetaCons "AxisInterpretation" PrefixI True) ((S1 (MetaSel (Just "axisNumber") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "threshold") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))) :: (S1 (MetaSel (Just "increment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :: (S1 (MetaSel (Just "lowerBound") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a)) :: S1 (MetaSel (Just "upperBound") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))))))

type AnalogHandler a b Source #

Arguments

= b	The raw event.
-> Maybe (Int, a)	The axis number and value.

How to handle raw analog events.

type ButtonHandler a b Source #

Arguments

= b	The raw event.
-> Maybe (Int, Bool)	The button number and whether the button is depressed.

How to handle raw button events.

Event handling

interpretationLoop Source #

Arguments

:: (Conjugate b, Epsilon b, Num b, Ord b, RealFloat b)
=> AnalogHandler b c	How to handle raw analog events.
-> ButtonHandler b c	How to handle raw button events.
-> Interpretation a b	The interpretation.
-> IO c	Action for getting the next raw event.
-> IO (ExitAction, LoopAction)	Action to create the exit and loop actions.

Repeatedly interpret events.

Orphan instances

ToJSON a => ToJSON (Quaternion a) Source #
Instance details Methods toJSON :: Quaternion a -> Value # toEncoding :: Quaternion a -> Encoding # toJSONList :: [Quaternion a] -> Value # toEncodingList :: [Quaternion a] -> Encoding #
ToJSON a => ToJSON (V3 a) Source #
Instance details Methods toJSON :: V3 a -> Value # toEncoding :: V3 a -> Encoding # toJSONList :: [V3 a] -> Value # toEncodingList :: [V3 a] -> Encoding #
FromJSON a => FromJSON (Quaternion a) Source #
Instance details Methods parseJSON :: Value -> Parser (Quaternion a) # parseJSONList :: Value -> Parser [Quaternion a] #
FromJSON a => FromJSON (V3 a) Source #
Instance details Methods parseJSON :: Value -> Parser (V3 a) # parseJSONList :: Value -> Parser [V3 a] #