Lifx.Lan

Documentation

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

broadcastMessage :: MonadLifx m => Message a -> m [(HostAddress, a)]

discoverDevices :: MonadLifx m => Maybe Int -> m [HostAddress]

If an integer argument is given, wait until we have responses from that number of devices. Otherwise just keep waiting until timeout.

data Message a where

Constructors

GetService :: Message StateService

GetPower :: Message StatePower

SetPower :: Bool -> Message ()

GetColor :: Message LightState

SetColor :: HSBK -> Duration -> Message ()

SetLightPower :: Bool -> Duration -> Message ()

Instances

Eq (Message a)

Defined in Lifx.Lan

Methods

(==) :: Message a -> Message a -> Bool

(/=) :: Message a -> Message a -> Bool

Ord (Message a)

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)

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Message a -> ShowS

show :: Message a -> String

showList :: [Message a] -> ShowS

data HSBK

Constructors

HSBK

Fields

• hue :: Word16
• saturation :: Word16
• brightness :: Word16
• kelvin :: Word16

Instances

Eq HSBK

Defined in Lifx.Lan

Methods

(==) :: HSBK -> HSBK -> Bool

(/=) :: HSBK -> HSBK -> Bool

Ord HSBK

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> HSBK -> ShowS

show :: HSBK -> String

showList :: [HSBK] -> ShowS

Generic HSBK

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

Defined in Lifx.Lan

type Rep HSBK = D1 ('MetaData "HSBK" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" '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

Constructors

Duration Word32

Instances

Eq Duration

Defined in Lifx.Lan

Methods

(==) :: Duration -> Duration -> Bool

(/=) :: Duration -> Duration -> Bool

Ord Duration

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Duration -> ShowS

show :: Duration -> String

showList :: [Duration] -> ShowS

Generic Duration

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

Defined in Lifx.Lan

type Rep Duration = D1 ('MetaData "Duration" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" 'True) (C1 ('MetaCons "Duration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

type Lifx = LifxT IO

runLifx :: Lifx a -> IO a

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

newtype LifxT m a

Constructors

LifxT

Fields

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

Instances

Monad m => Monad (LifxT m)

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)

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)

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)

Defined in Lifx.Lan

Methods

liftIO :: IO a -> LifxT m a

MonadIO m => MonadLifx (LifxT m)

Defined in Lifx.Lan

Methods

getSocket :: LifxT m Socket

getSource :: LifxT m Word32

getTimeout :: LifxT m Int

incrementCounter :: LifxT m ()

getCounter :: LifxT m Word8

lifxThrow :: LifxError -> LifxT m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> LifxT m ()

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

data LifxError

Constructors

DecodeFailure ByteString ByteOffset String

RecvTimeout

BroadcastTimeout [HostAddress]

WrongPacketType Word16 Word16

WrongSender HostAddress HostAddress

UnexpectedSockAddrType SockAddr

UnexpectedPort PortNumber

Instances

Eq LifxError

Defined in Lifx.Lan

Methods

(==) :: LifxError -> LifxError -> Bool

(/=) :: LifxError -> LifxError -> Bool

Ord LifxError

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> LifxError -> ShowS

show :: LifxError -> String

showList :: [LifxError] -> ShowS

Generic LifxError

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

Defined in Lifx.Lan

type Rep LifxError = D1 ('MetaData "LifxError" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" '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 "BroadcastTimeout" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [HostAddress])))) :+: ((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 HostAddress) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostAddress))) :+: (C1 ('MetaCons "UnexpectedSockAddrType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SockAddr)) :+: C1 ('MetaCons "UnexpectedPort" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber)))))

class MonadIO m => MonadLifx m where

Minimal complete definition

getSocket, getSource, getTimeout, incrementCounter, getCounter, lifxThrow

Methods

getSocket :: m Socket

getSource :: m Word32

getTimeout :: m Int

incrementCounter :: m ()

getCounter :: m Word8

lifxThrow :: LifxError -> m a

handleOldMessage

Arguments

:: Word8

expected counter value

-> Word8

actual counter value

-> Word16

packet type

-> ByteString

payload

-> m ()

Instances

MonadLifx m => MonadLifx (MaybeT m)

Defined in Lifx.Lan

Methods

getSocket :: MaybeT m Socket

getSource :: MaybeT m Word32

getTimeout :: MaybeT m Int

incrementCounter :: MaybeT m ()

getCounter :: MaybeT m Word8

lifxThrow :: LifxError -> MaybeT m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> MaybeT m ()

MonadIO m => MonadLifx (LifxT m)

Defined in Lifx.Lan

Methods

getSocket :: LifxT m Socket

getSource :: LifxT m Word32

getTimeout :: LifxT m Int

incrementCounter :: LifxT m ()

getCounter :: LifxT m Word8

lifxThrow :: LifxError -> LifxT m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> LifxT m ()

MonadLifx m => MonadLifx (ExceptT e m)

Defined in Lifx.Lan

Methods

getSocket :: ExceptT e m Socket

getSource :: ExceptT e m Word32

getTimeout :: ExceptT e m Int

incrementCounter :: ExceptT e m ()

getCounter :: ExceptT e m Word8

lifxThrow :: LifxError -> ExceptT e m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> ExceptT e m ()

MonadLifx m => MonadLifx (ReaderT e m)

Defined in Lifx.Lan

Methods

getSocket :: ReaderT e m Socket

getSource :: ReaderT e m Word32

getTimeout :: ReaderT e m Int

incrementCounter :: ReaderT e m ()

getCounter :: ReaderT e m Word8

lifxThrow :: LifxError -> ReaderT e m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> ReaderT e m ()

MonadLifx m => MonadLifx (StateT s m)

Defined in Lifx.Lan

Methods

getSocket :: StateT s m Socket

getSource :: StateT s m Word32

getTimeout :: StateT s m Int

incrementCounter :: StateT s m ()

getCounter :: StateT s m Word8

lifxThrow :: LifxError -> StateT s m a

handleOldMessage :: Word8 -> Word8 -> Word16 -> ByteString -> StateT s m ()

Responses

data LightState

Constructors

LightState

Fields

• hsbk :: HSBK
• power :: Word16
• label :: ByteString

Instances

Eq LightState

Defined in Lifx.Lan

Methods

(==) :: LightState -> LightState -> Bool

(/=) :: LightState -> LightState -> Bool

Ord LightState

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> LightState -> ShowS

show :: LightState -> String

showList :: [LightState] -> ShowS

Generic LightState

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

Defined in Lifx.Lan

type Rep LightState = D1 ('MetaData "LightState" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" '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))))

data StateService

Constructors

StateService

Fields

• service :: Service
• port :: Word32

Instances

Eq StateService

Defined in Lifx.Lan

Methods

(==) :: StateService -> StateService -> Bool

(/=) :: StateService -> StateService -> Bool

Ord StateService

Defined in Lifx.Lan

Methods

compare :: StateService -> StateService -> Ordering

(<) :: StateService -> StateService -> Bool

(<=) :: StateService -> StateService -> Bool

(>) :: StateService -> StateService -> Bool

(>=) :: StateService -> StateService -> Bool

max :: StateService -> StateService -> StateService

min :: StateService -> StateService -> StateService

Show StateService

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StateService -> ShowS

show :: StateService -> String

showList :: [StateService] -> ShowS

Generic StateService

Defined in Lifx.Lan

Associated Types

type Rep StateService :: Type -> Type

Methods

from :: StateService -> Rep StateService x

to :: Rep StateService x -> StateService

type Rep StateService

Defined in Lifx.Lan

type Rep StateService = D1 ('MetaData "StateService" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" 'False) (C1 ('MetaCons "StateService" 'PrefixI 'True) (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Service) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

data Service

Constructors

ServiceUDP

ServiceReserved1

ServiceReserved2

ServiceReserved3

ServiceReserved4

Instances

Eq Service

Defined in Lifx.Lan

Methods

(==) :: Service -> Service -> Bool

(/=) :: Service -> Service -> Bool

Ord Service

Defined in Lifx.Lan

Methods

compare :: Service -> Service -> Ordering

(<) :: Service -> Service -> Bool

(<=) :: Service -> Service -> Bool

(>) :: Service -> Service -> Bool

(>=) :: Service -> Service -> Bool

max :: Service -> Service -> Service

min :: Service -> Service -> Service

Show Service

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Service -> ShowS

show :: Service -> String

showList :: [Service] -> ShowS

Generic Service

Defined in Lifx.Lan

Associated Types

type Rep Service :: Type -> Type

Methods

from :: Service -> Rep Service x

to :: Rep Service x -> Service

type Rep Service

Defined in Lifx.Lan

type Rep Service = D1 ('MetaData "Service" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" 'False) ((C1 ('MetaCons "ServiceUDP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ServiceReserved1" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ServiceReserved2" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ServiceReserved3" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ServiceReserved4" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype StatePower

Constructors

StatePower

Fields

• power :: Word16

Instances

Eq StatePower

Defined in Lifx.Lan

Methods

(==) :: StatePower -> StatePower -> Bool

(/=) :: StatePower -> StatePower -> Bool

Ord StatePower

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StatePower -> ShowS

show :: StatePower -> String

showList :: [StatePower] -> ShowS

Generic StatePower

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

Defined in Lifx.Lan

type Rep StatePower = D1 ('MetaData "StatePower" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" 'True) (C1 ('MetaCons "StatePower" 'PrefixI 'True) (S1 ('MetaSel ('Just "power") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

Low-level

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

data Header

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

Instances

Eq Header

Defined in Lifx.Lan

Methods

(==) :: Header -> Header -> Bool

(/=) :: Header -> Header -> Bool

Ord Header

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

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Generic Header

Defined in Lifx.Lan

Associated Types

type Rep Header :: Type -> Type

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

Binary Header

Defined in Lifx.Lan

Methods

put :: Header -> Put

get :: Get Header

putList :: [Header] -> Put

type Rep Header

Defined in Lifx.Lan

type Rep Header = D1 ('MetaData "Header" "Lifx.Lan" "lifx-lan-0.3.0-GAAfhhepnfu1kJe4hZeFDh" '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))))))