Safe Haskell	None
Language	Haskell2010

Lifx.Lan

Contents

Responses
Low-level

Synopsis

sendMessage :: MonadLifx m => HostAddress -> Message a -> m a
data Message a where
- GetPower :: Message StatePower
- SetPower :: Bool -> Message ()
- GetColor :: Message LightState
- SetColor :: HSBK -> Duration -> Message ()
- SetLightPower :: Bool -> Duration -> Message ()
data HSBK = HSBK {
- hue :: Word16
- saturation :: Word16
- brightness :: Word16
- kelvin :: Word16
}
newtype Duration = Duration Word32
type Lifx = LifxT IO
runLifx :: Lifx a -> IO a
newtype LifxT m a = LifxT {
- unLifxT :: StateT Word8 (ReaderT (Socket, Word32, Int) (ExceptT LifxError m)) a
}
runLifxT :: MonadIO m => Int -> LifxT m a -> m (Either LifxError a)
data LifxError
class MonadIO m => MonadLifx m where
- getSocket :: m Socket
- getSource :: m Word32
- getTimeout :: m Int
- incrementCounter :: m ()
- getCounter :: m Word8
- lifxThrow :: LifxError -> m a
data LightState = LightState {
- hsbk :: HSBK
- power :: Word16
- label :: ByteString
}
newtype StatePower = StatePower {
- power :: Word16
}
encodeMessage :: Bool -> Word8 -> Word32 -> Message a -> ByteString
data Header = Header {
- size :: Word16
- protocol :: Word16
- addressable :: Bool
- tagged :: Bool
- origin :: Word8
- source :: Word32
- target :: Word64
- resRequired :: Bool
- ackRequired :: Bool
- sequenceCounter :: Word8
- packetType :: Word16
}

Documentation

sendMessage :: MonadLifx m => HostAddress -> Message a -> m a Source #

data Message a where Source #

Constructors

GetPower :: Message StatePower
SetPower :: Bool -> Message ()
GetColor :: Message LightState
SetColor :: HSBK -> Duration -> Message ()
SetLightPower :: Bool -> Duration -> Message ()

Instances

Instances details

Eq (Message a) Source #
Instance details Defined in Lifx.Lan Methods (==) :: Message a -> Message a -> Bool # (/=) :: Message a -> Message a -> Bool #
Ord (Message a) Source #
Instance details Defined in Lifx.Lan Methods compare :: Message a -> Message a -> Ordering # (<) :: Message a -> Message a -> Bool # (<=) :: Message a -> Message a -> Bool # (>) :: Message a -> Message a -> Bool # (>=) :: Message a -> Message a -> Bool # max :: Message a -> Message a -> Message a # min :: Message a -> Message a -> Message a #
Show (Message a) Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> Message a -> ShowS # show :: Message a -> String # showList :: [Message a] -> ShowS #

data HSBK Source #

Constructors

HSBK
Fields hue :: Word16 saturation :: Word16 brightness :: Word16 kelvin :: Word16

Instances

Instances details

Eq HSBK Source #
Instance details Defined in Lifx.Lan Methods (==) :: HSBK -> HSBK -> Bool # (/=) :: HSBK -> HSBK -> Bool #
Ord HSBK Source #
Instance details Defined in Lifx.Lan Methods compare :: HSBK -> HSBK -> Ordering # (<) :: HSBK -> HSBK -> Bool # (<=) :: HSBK -> HSBK -> Bool # (>) :: HSBK -> HSBK -> Bool # (>=) :: HSBK -> HSBK -> Bool # max :: HSBK -> HSBK -> HSBK # min :: HSBK -> HSBK -> HSBK #
Show HSBK Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> HSBK -> ShowS # show :: HSBK -> String # showList :: [HSBK] -> ShowS #
Generic HSBK Source #
Instance details Defined in Lifx.Lan Associated Types type Rep HSBK :: Type -> Type # Methods from :: HSBK -> Rep HSBK x # to :: Rep HSBK x -> HSBK #
type Rep HSBK Source #
Instance details Defined in Lifx.Lan type Rep HSBK = D1 ('MetaData "HSBK" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'False) (C1 ('MetaCons "HSBK" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :: S1 ('MetaSel ('Just "saturation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)) :: (S1 ('MetaSel ('Just "brightness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: S1 ('MetaSel ('Just "kelvin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16))))

newtype Duration Source #

Constructors

Duration Word32

Instances

Instances details

Eq Duration Source #
Instance details Defined in Lifx.Lan Methods (==) :: Duration -> Duration -> Bool # (/=) :: Duration -> Duration -> Bool #
Ord Duration Source #
Instance details Defined in Lifx.Lan Methods compare :: Duration -> Duration -> Ordering # (<) :: Duration -> Duration -> Bool # (<=) :: Duration -> Duration -> Bool # (>) :: Duration -> Duration -> Bool # (>=) :: Duration -> Duration -> Bool # max :: Duration -> Duration -> Duration # min :: Duration -> Duration -> Duration #
Show Duration Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> Duration -> ShowS # show :: Duration -> String # showList :: [Duration] -> ShowS #
Generic Duration Source #
Instance details Defined in Lifx.Lan Associated Types type Rep Duration :: Type -> Type # Methods from :: Duration -> Rep Duration x # to :: Rep Duration x -> Duration #
type Rep Duration Source #
Instance details Defined in Lifx.Lan type Rep Duration = D1 ('MetaData "Duration" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'True) (C1 ('MetaCons "Duration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

type Lifx = LifxT IO Source #

runLifx :: Lifx a -> IO a Source #

Note that this throws LifxErrors as IOExceptions, and sets timeout to 1 second. Use runLifxT for more control.

newtype LifxT m a Source #

Constructors

LifxT
Fields unLifxT :: StateT Word8 (ReaderT (Socket, Word32, Int) (ExceptT LifxError m)) a

Instances

Instances details

Monad m => Monad (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods (>>=) :: LifxT m a -> (a -> LifxT m b) -> LifxT m b # (>>) :: LifxT m a -> LifxT m b -> LifxT m b # return :: a -> LifxT m a #
Functor m => Functor (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods fmap :: (a -> b) -> LifxT m a -> LifxT m b # (<$) :: a -> LifxT m b -> LifxT m a #
Monad m => Applicative (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods pure :: a -> LifxT m a # (<>) :: LifxT m (a -> b) -> LifxT m a -> LifxT m b # liftA2 :: (a -> b -> c) -> LifxT m a -> LifxT m b -> LifxT m c # (>) :: LifxT m a -> LifxT m b -> LifxT m b # (<*) :: LifxT m a -> LifxT m b -> LifxT m a #
MonadIO m => MonadIO (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods liftIO :: IO a -> LifxT m a #
MonadIO m => MonadLifx (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods getSocket :: LifxT m Socket Source # getSource :: LifxT m Word32 Source # getTimeout :: LifxT m Int Source # incrementCounter :: LifxT m () Source # getCounter :: LifxT m Word8 Source # lifxThrow :: LifxError -> LifxT m a Source #

runLifxT :: MonadIO m => Int -> LifxT m a -> m (Either LifxError a) Source #

data LifxError Source #

Constructors

DecodeFailure ByteString ByteOffset String
RecvTimeout
WrongPacketType Word16 Word16
WrongSender SockAddr SockAddr
WrongSequenceNumber Word8 Word8

Instances

Instances details

Eq LifxError Source #
Instance details Defined in Lifx.Lan Methods (==) :: LifxError -> LifxError -> Bool # (/=) :: LifxError -> LifxError -> Bool #
Ord LifxError Source #
Instance details Defined in Lifx.Lan Methods compare :: LifxError -> LifxError -> Ordering # (<) :: LifxError -> LifxError -> Bool # (<=) :: LifxError -> LifxError -> Bool # (>) :: LifxError -> LifxError -> Bool # (>=) :: LifxError -> LifxError -> Bool # max :: LifxError -> LifxError -> LifxError # min :: LifxError -> LifxError -> LifxError #
Show LifxError Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> LifxError -> ShowS # show :: LifxError -> String # showList :: [LifxError] -> ShowS #
Generic LifxError Source #
Instance details Defined in Lifx.Lan Associated Types type Rep LifxError :: Type -> Type # Methods from :: LifxError -> Rep LifxError x # to :: Rep LifxError x -> LifxError #
type Rep LifxError Source #
Instance details Defined in Lifx.Lan type Rep LifxError = D1 ('MetaData "LifxError" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'False) ((C1 ('MetaCons "DecodeFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteOffset) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))) :+: C1 ('MetaCons "RecvTimeout" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WrongPacketType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)) :+: (C1 ('MetaCons "WrongSender" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SockAddr) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SockAddr)) :+: C1 ('MetaCons "WrongSequenceNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))))

class MonadIO m => MonadLifx m where Source #

Methods

getSocket :: m Socket Source #

getSource :: m Word32 Source #

getTimeout :: m Int Source #

incrementCounter :: m () Source #

getCounter :: m Word8 Source #

lifxThrow :: LifxError -> m a Source #

Instances

Instances details

MonadIO m => MonadLifx (LifxT m) Source #
Instance details Defined in Lifx.Lan Methods getSocket :: LifxT m Socket Source # getSource :: LifxT m Word32 Source # getTimeout :: LifxT m Int Source # incrementCounter :: LifxT m () Source # getCounter :: LifxT m Word8 Source # lifxThrow :: LifxError -> LifxT m a Source #
MonadLifx m => MonadLifx (ReaderT e m) Source #
Instance details Defined in Lifx.Lan Methods getSocket :: ReaderT e m Socket Source # getSource :: ReaderT e m Word32 Source # getTimeout :: ReaderT e m Int Source # incrementCounter :: ReaderT e m () Source # getCounter :: ReaderT e m Word8 Source # lifxThrow :: LifxError -> ReaderT e m a Source #
MonadLifx m => MonadLifx (StateT s m) Source #
Instance details Defined in Lifx.Lan Methods getSocket :: StateT s m Socket Source # getSource :: StateT s m Word32 Source # getTimeout :: StateT s m Int Source # incrementCounter :: StateT s m () Source # getCounter :: StateT s m Word8 Source # lifxThrow :: LifxError -> StateT s m a Source #

Responses

data LightState Source #

Constructors

LightState
Fields hsbk :: HSBK power :: Word16 label :: ByteString

Instances

Instances details

Eq LightState Source #
Instance details Defined in Lifx.Lan Methods (==) :: LightState -> LightState -> Bool # (/=) :: LightState -> LightState -> Bool #
Ord LightState Source #
Instance details Defined in Lifx.Lan Methods compare :: LightState -> LightState -> Ordering # (<) :: LightState -> LightState -> Bool # (<=) :: LightState -> LightState -> Bool # (>) :: LightState -> LightState -> Bool # (>=) :: LightState -> LightState -> Bool # max :: LightState -> LightState -> LightState # min :: LightState -> LightState -> LightState #
Show LightState Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> LightState -> ShowS # show :: LightState -> String # showList :: [LightState] -> ShowS #
Generic LightState Source #
Instance details Defined in Lifx.Lan Associated Types type Rep LightState :: Type -> Type # Methods from :: LightState -> Rep LightState x # to :: Rep LightState x -> LightState #
type Rep LightState Source #
Instance details Defined in Lifx.Lan type Rep LightState = D1 ('MetaData "LightState" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'False) (C1 ('MetaCons "LightState" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsbk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HSBK) :: (S1 ('MetaSel ('Just "power") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :: S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))))

newtype StatePower Source #

Constructors

StatePower
Fields power :: Word16

Instances

Instances details

Eq StatePower Source #
Instance details Defined in Lifx.Lan Methods (==) :: StatePower -> StatePower -> Bool # (/=) :: StatePower -> StatePower -> Bool #
Ord StatePower Source #
Instance details Defined in Lifx.Lan Methods compare :: StatePower -> StatePower -> Ordering # (<) :: StatePower -> StatePower -> Bool # (<=) :: StatePower -> StatePower -> Bool # (>) :: StatePower -> StatePower -> Bool # (>=) :: StatePower -> StatePower -> Bool # max :: StatePower -> StatePower -> StatePower # min :: StatePower -> StatePower -> StatePower #
Show StatePower Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> StatePower -> ShowS # show :: StatePower -> String # showList :: [StatePower] -> ShowS #
Generic StatePower Source #
Instance details Defined in Lifx.Lan Associated Types type Rep StatePower :: Type -> Type # Methods from :: StatePower -> Rep StatePower x # to :: Rep StatePower x -> StatePower #
type Rep StatePower Source #
Instance details Defined in Lifx.Lan type Rep StatePower = D1 ('MetaData "StatePower" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'True) (C1 ('MetaCons "StatePower" 'PrefixI 'True) (S1 ('MetaSel ('Just "power") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

Low-level

encodeMessage :: Bool -> Word8 -> Word32 -> Message a -> ByteString Source #

data Header Source #

https://lan.developer.lifx.com/docs/encoding-a-packet

Constructors

Header
Fields size :: Word16 protocol :: Word16 addressable :: Bool tagged :: Bool origin :: Word8 source :: Word32 target :: Word64 resRequired :: Bool ackRequired :: Bool sequenceCounter :: Word8 packetType :: Word16

Eq Header Source #
Instance details Defined in Lifx.Lan Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Ord Header Source #
Instance details Defined in Lifx.Lan Methods compare :: Header -> Header -> Ordering # (<) :: Header -> Header -> Bool # (<=) :: Header -> Header -> Bool # (>) :: Header -> Header -> Bool # (>=) :: Header -> Header -> Bool # max :: Header -> Header -> Header # min :: Header -> Header -> Header #
Show Header Source #
Instance details Defined in Lifx.Lan Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Generic Header Source #
Instance details Defined in Lifx.Lan Associated Types type Rep Header :: Type -> Type # Methods from :: Header -> Rep Header x # to :: Rep Header x -> Header #
Binary Header Source #
Instance details Defined in Lifx.Lan Methods put :: Header -> Put # get :: Get Header # putList :: [Header] -> Put #
type Rep Header Source #
Instance details Defined in Lifx.Lan type Rep Header = D1 ('MetaData "Header" "Lifx.Lan" "lifx-lan-0.2.0-EXDZ9MuSZ9YFWpI9PywcjM" 'False) (C1 ('MetaCons "Header" 'PrefixI 'True) (((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)) :: (S1 ('MetaSel ('Just "addressable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "tagged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))) :: ((S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :: S1 ('MetaSel ('Just "resRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :: (S1 ('MetaSel ('Just "ackRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "sequenceCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :: S1 ('MetaSel ('Just "packetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16))))))