Lifx.Lan

-- these should be enabled by default in a future version of GHC
-- (they aren't entirely necessary here anyway - they just make the example even simpler)
{-# LANGUAGE BlockArguments #-}
{-# LANGUAGE NamedFieldPuns #-}

import Control.Monad.IO.Class (liftIO)
import Data.Foldable (for_)

import Lifx.Lan

-- | Find all devices on the network, print their addresses, and set their brightness to 50%.
main :: IO ()
main = runLifx do
    devs <- discoverDevices Nothing
    liftIO $ print devs
    for_ devs \d -> do
        LightState{hsbk} <- sendMessage d GetColor
        sendMessage d $ SetColor hsbk{brightness = maxBound `div` 2} 3

Documentation

data Device

A LIFX device, such as a bulb.

Instances

Show Device

Defined in Lifx.Lan.Internal

Methods

showsPrec :: Int -> Device -> ShowS

show :: Device -> String

showList :: [Device] -> ShowS

Eq Device

Defined in Lifx.Lan.Internal

Methods

(==) :: Device -> Device -> Bool

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

Ord Device

Defined in Lifx.Lan.Internal

Methods

compare :: Device -> Device -> Ordering

(<) :: Device -> Device -> Bool

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

(>) :: Device -> Device -> Bool

(>=) :: Device -> Device -> Bool

max :: Device -> Device -> Device

min :: Device -> Device -> Device

deviceAddress :: Device -> HostAddress

deviceFromAddress :: (Word8, Word8, Word8, Word8) -> Device

>>> deviceFromAddress (192, 168, 0, 1)
192.168.0.1

If we know the IP address of a Device, we can create it directly, rather than calling discoverDevices.

data Message r where

A message we can send to a Device. r is the type of the expected response.

Constructors

GetService :: Message StateService

https://lan.developer.lifx.com/docs/querying-the-device-for-data#getservice---packet-2 (you shouldn't need this - use discoverDevices)

GetHostFirmware :: Message StateHostFirmware

https://lan.developer.lifx.com/docs/querying-the-device-for-data#gethostfirmware---packet-14

GetPower :: Message StatePower

https://lan.developer.lifx.com/docs/querying-the-device-for-data#getpower---packet-20

SetPower :: Bool -> Message ()

https://lan.developer.lifx.com/docs/changing-a-device#setpower---packet-21

GetVersion :: Message StateVersion

https://lan.developer.lifx.com/docs/querying-the-device-for-data#getversion---packet-32

GetColor :: Message LightState

https://lan.developer.lifx.com/docs/querying-the-device-for-data#getcolor---packet-101

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

https://lan.developer.lifx.com/docs/changing-a-device#setcolor---packet-102

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

https://lan.developer.lifx.com/docs/changing-a-device#setlightpower---packet-117

Instances

Show (Message r)

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Message r -> ShowS

show :: Message r -> String

showList :: [Message r] -> ShowS

Eq (Message r)

Defined in Lifx.Lan

Methods

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

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

Ord (Message r)

Defined in Lifx.Lan

Methods

compare :: Message r -> Message r -> Ordering

(<) :: Message r -> Message r -> Bool

(<=) :: Message r -> Message r -> Bool

(>) :: Message r -> Message r -> Bool

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

max :: Message r -> Message r -> Message r

min :: Message r -> Message r -> Message r

data HSBK

A colour. See https://lan.developer.lifx.com/docs/representing-color-with-hsbk.

Constructors

HSBK

Fields

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

  takes values in the range 1500 to 9000

Instances

Generic HSBK

Defined in Lifx.Lan.Internal

Associated Types

type Rep HSBK :: Type -> Type

Methods

from :: HSBK -> Rep HSBK x

to :: Rep HSBK x -> HSBK

Show HSBK

Defined in Lifx.Lan.Internal

Methods

showsPrec :: Int -> HSBK -> ShowS

show :: HSBK -> String

showList :: [HSBK] -> ShowS

Eq HSBK

Defined in Lifx.Lan.Internal

Methods

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

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

Ord HSBK

Defined in Lifx.Lan.Internal

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

type Rep HSBK

Defined in Lifx.Lan.Internal

type Rep HSBK = D1 ('MetaData "HSBK" "Lifx.Lan.Internal" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" '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))))

type Lifx = LifxT IO

A simple implementation of MonadLifx.

runLifx :: Lifx a -> IO a

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

data LifxT m a

Instances

MonadTrans LifxT

Defined in Lifx.Lan.Internal

Methods

lift :: Monad m => m a -> LifxT m a

MonadError e m => MonadError e (LifxT m)

Defined in Lifx.Lan.Internal

Methods

throwError :: e -> LifxT m a

catchError :: LifxT m a -> (e -> LifxT m a) -> LifxT m a

MonadReader s m => MonadReader s (LifxT m)

Defined in Lifx.Lan.Internal

Methods

ask :: LifxT m s

local :: (s -> s) -> LifxT m a -> LifxT m a

reader :: (s -> a) -> LifxT m a

MonadState s m => MonadState s (LifxT m)

Defined in Lifx.Lan.Internal

Methods

get :: LifxT m s

put :: s -> LifxT m ()

state :: (s -> (a, s)) -> LifxT m a

MonadIO m => MonadIO (LifxT m)

Defined in Lifx.Lan.Internal

Methods

liftIO :: IO a -> LifxT m a

Monad m => Applicative (LifxT m)

Defined in Lifx.Lan.Internal

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

Functor m => Functor (LifxT m)

Defined in Lifx.Lan.Internal

Methods

fmap :: (a -> b) -> LifxT m a -> LifxT m b

(<$) :: a -> LifxT m b -> LifxT m a

Monad m => Monad (LifxT m)

Defined in Lifx.Lan.Internal

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

MonadIO m => MonadLifx (LifxT m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (LifxT m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (LifxT m)

lifxThrow :: MonadLifxError (LifxT m) -> LifxT m a

sendMessage :: Device -> Message r -> LifxT m r

broadcastMessage :: Message r -> LifxT m [(Device, r)]

discoverDevices :: Maybe Int -> LifxT m [Device]

MonadIO m => MonadLifxIO (LifxT m)

Defined in Lifx.Lan.Internal

Methods

getSocket :: LifxT m Socket

getSource :: LifxT m Word32

getTimeout :: LifxT m Int

incrementCounter :: LifxT m ()

getCounter :: LifxT m Word8

lifxThrowIO :: LifxError -> LifxT m a

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

type MonadLifxError (LifxT m)

Defined in Lifx.Lan

type MonadLifxError (LifxT m) = LifxError

runLifxT

Arguments

:: MonadIO m

=> Int

Timeout for waiting for message responses, in microseconds.

-> LifxT m a

-> m (Either LifxError a)

data LifxError

Constructors

DecodeFailure ByteString ByteOffset String

RecvTimeout

BroadcastTimeout [HostAddress]

WrongPacketType Word16 Word16

WrongSender Device HostAddress

UnexpectedSockAddrType SockAddr

UnexpectedPort PortNumber

ProductLookupError ProductLookupError

Instances

Generic LifxError

Defined in Lifx.Lan.Internal

Associated Types

type Rep LifxError :: Type -> Type

Methods

from :: LifxError -> Rep LifxError x

to :: Rep LifxError x -> LifxError

Show LifxError

Defined in Lifx.Lan.Internal

Methods

showsPrec :: Int -> LifxError -> ShowS

show :: LifxError -> String

showList :: [LifxError] -> ShowS

Eq LifxError

Defined in Lifx.Lan.Internal

Methods

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

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

Ord LifxError

Defined in Lifx.Lan.Internal

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

type Rep LifxError

Defined in Lifx.Lan.Internal

type Rep LifxError = D1 ('MetaData "LifxError" "Lifx.Lan.Internal" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" '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 Device) :*: 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)) :+: C1 ('MetaCons "ProductLookupError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProductLookupError)))))

data ProductLookupError

Constructors

UnknownVendorId Word32

UnknownProductId Word32

Instances

Generic ProductLookupError

Defined in Lifx.Internal.ProductInfoMap

Associated Types

type Rep ProductLookupError :: Type -> Type

Methods

from :: ProductLookupError -> Rep ProductLookupError x

to :: Rep ProductLookupError x -> ProductLookupError

Show ProductLookupError

Defined in Lifx.Internal.ProductInfoMap

Methods

showsPrec :: Int -> ProductLookupError -> ShowS

show :: ProductLookupError -> String

showList :: [ProductLookupError] -> ShowS

Eq ProductLookupError

Defined in Lifx.Internal.ProductInfoMap

Methods

(==) :: ProductLookupError -> ProductLookupError -> Bool

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

Ord ProductLookupError

Defined in Lifx.Internal.ProductInfoMap

Methods

compare :: ProductLookupError -> ProductLookupError -> Ordering

(<) :: ProductLookupError -> ProductLookupError -> Bool

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

(>) :: ProductLookupError -> ProductLookupError -> Bool

(>=) :: ProductLookupError -> ProductLookupError -> Bool

max :: ProductLookupError -> ProductLookupError -> ProductLookupError

min :: ProductLookupError -> ProductLookupError -> ProductLookupError

type Rep ProductLookupError

Defined in Lifx.Internal.ProductInfoMap

type Rep ProductLookupError = D1 ('MetaData "ProductLookupError" "Lifx.Internal.ProductInfoMap" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" 'False) (C1 ('MetaCons "UnknownVendorId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)) :+: C1 ('MetaCons "UnknownProductId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

class Monad m => MonadLifx m where

Associated Types

type MonadLifxError m

The type of errors associated with m.

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError m

lifxThrow :: MonadLifxError m -> m a

sendMessage :: Device -> Message r -> m r

Send a message and wait for a response.

broadcastMessage :: Message r -> m [(Device, r)]

Broadcast a message and wait for responses.

discoverDevices :: Maybe Int -> m [Device]

Search for devices on the local network. If an integer argument is given, wait until we have found that number of devices - otherwise just keep waiting until timeout.

Instances

MonadLifx Mock

Defined in Lifx.Lan.Mock.Terminal

Associated Types

type MonadLifxError Mock

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError Mock

lifxThrow :: MonadLifxError Mock -> Mock a

sendMessage :: Device -> Message r -> Mock r

broadcastMessage :: Message r -> Mock [(Device, r)]

discoverDevices :: Maybe Int -> Mock [Device]

MonadIO m => MonadLifx (LifxT m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (LifxT m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (LifxT m)

lifxThrow :: MonadLifxError (LifxT m) -> LifxT m a

sendMessage :: Device -> Message r -> LifxT m r

broadcastMessage :: Message r -> LifxT m [(Device, r)]

discoverDevices :: Maybe Int -> LifxT m [Device]

MonadLifx m => MonadLifx (MaybeT m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (MaybeT m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (MaybeT m)

lifxThrow :: MonadLifxError (MaybeT m) -> MaybeT m a

sendMessage :: Device -> Message r -> MaybeT m r

broadcastMessage :: Message r -> MaybeT m [(Device, r)]

discoverDevices :: Maybe Int -> MaybeT m [Device]

MonadLifx m => MonadLifx (ExceptT e m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (ExceptT e m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (ExceptT e m)

lifxThrow :: MonadLifxError (ExceptT e m) -> ExceptT e m a

sendMessage :: Device -> Message r -> ExceptT e m r

broadcastMessage :: Message r -> ExceptT e m [(Device, r)]

discoverDevices :: Maybe Int -> ExceptT e m [Device]

MonadLifx m => MonadLifx (ReaderT e m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (ReaderT e m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (ReaderT e m)

lifxThrow :: MonadLifxError (ReaderT e m) -> ReaderT e m a

sendMessage :: Device -> Message r -> ReaderT e m r

broadcastMessage :: Message r -> ReaderT e m [(Device, r)]

discoverDevices :: Maybe Int -> ReaderT e m [Device]

MonadLifx m => MonadLifx (StateT s m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (StateT s m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (StateT s m)

lifxThrow :: MonadLifxError (StateT s m) -> StateT s m a

sendMessage :: Device -> Message r -> StateT s m r

broadcastMessage :: Message r -> StateT s m [(Device, r)]

discoverDevices :: Maybe Int -> StateT s m [Device]

(MonadLifx m, Monoid t) => MonadLifx (WriterT t m)

Defined in Lifx.Lan

Associated Types

type MonadLifxError (WriterT t m)

Methods

liftProductLookupError :: ProductLookupError -> MonadLifxError (WriterT t m)

lifxThrow :: MonadLifxError (WriterT t m) -> WriterT t m a

sendMessage :: Device -> Message r -> WriterT t m r

broadcastMessage :: Message r -> WriterT t m [(Device, r)]

discoverDevices :: Maybe Int -> WriterT t m [Device]

sendMessageAndWait :: (MonadLifx m, MonadIO m) => Device -> Message () -> m ()

Like sendMessage, but for messages whose effect is not instantaneous (e.g. SetColor), block (using threadDelay) until completion.

Responses

data StateService

https://lan.developer.lifx.com/docs/information-messages#stateservice---packet-3

Constructors

StateService

Fields

• service :: Service
• port :: PortNumber

Instances

Generic StateService

Defined in Lifx.Lan

Associated Types

type Rep StateService :: Type -> Type

Methods

from :: StateService -> Rep StateService x

to :: Rep StateService x -> StateService

Show StateService

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StateService -> ShowS

show :: StateService -> String

showList :: [StateService] -> ShowS

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

type Rep StateService

Defined in Lifx.Lan

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

data Service

https://lan.developer.lifx.com/docs/field-types#services

Constructors

ServiceUDP

ServiceReserved1

ServiceReserved2

ServiceReserved3

ServiceReserved4

Instances

Generic Service

Defined in Lifx.Lan

Associated Types

type Rep Service :: Type -> Type

Methods

from :: Service -> Rep Service x

to :: Rep Service x -> Service

Show Service

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Service -> ShowS

show :: Service -> String

showList :: [Service] -> ShowS

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

type Rep Service

Defined in Lifx.Lan

type Rep Service = D1 ('MetaData "Service" "Lifx.Lan" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" '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))))

data StateHostFirmware

https://lan.developer.lifx.com/docs/information-messages#statehostfirmware---packet-15

Constructors

StateHostFirmware

Fields

• build :: Word64

  The timestamp of the firmware that is on the device as an epoch

• versionMinor :: Word16

  The minor component of the firmware version

• versionMajor :: Word16

  The major component of the firmware version

Instances

Generic StateHostFirmware

Defined in Lifx.Lan

Associated Types

type Rep StateHostFirmware :: Type -> Type

Methods

from :: StateHostFirmware -> Rep StateHostFirmware x

to :: Rep StateHostFirmware x -> StateHostFirmware

Show StateHostFirmware

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StateHostFirmware -> ShowS

show :: StateHostFirmware -> String

showList :: [StateHostFirmware] -> ShowS

Eq StateHostFirmware

Defined in Lifx.Lan

Methods

(==) :: StateHostFirmware -> StateHostFirmware -> Bool

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

Ord StateHostFirmware

Defined in Lifx.Lan

Methods

compare :: StateHostFirmware -> StateHostFirmware -> Ordering

(<) :: StateHostFirmware -> StateHostFirmware -> Bool

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

(>) :: StateHostFirmware -> StateHostFirmware -> Bool

(>=) :: StateHostFirmware -> StateHostFirmware -> Bool

max :: StateHostFirmware -> StateHostFirmware -> StateHostFirmware

min :: StateHostFirmware -> StateHostFirmware -> StateHostFirmware

type Rep StateHostFirmware

Defined in Lifx.Lan

type Rep StateHostFirmware = D1 ('MetaData "StateHostFirmware" "Lifx.Lan" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" 'False) (C1 ('MetaCons "StateHostFirmware" 'PrefixI 'True) (S1 ('MetaSel ('Just "build") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: (S1 ('MetaSel ('Just "versionMinor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: S1 ('MetaSel ('Just "versionMajor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16))))

newtype StatePower

https://lan.developer.lifx.com/docs/information-messages#statepower---packet-22

Constructors

StatePower

Fields

• power :: Word16

Instances

Generic StatePower

Defined in Lifx.Lan

Associated Types

type Rep StatePower :: Type -> Type

Methods

from :: StatePower -> Rep StatePower x

to :: Rep StatePower x -> StatePower

Show StatePower

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StatePower -> ShowS

show :: StatePower -> String

showList :: [StatePower] -> ShowS

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

type Rep StatePower

Defined in Lifx.Lan

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

data StateVersion

https://lan.developer.lifx.com/docs/information-messages#stateversion---packet-33

Constructors

StateVersion

Fields

• vendor :: Word32

  For LIFX products this value is 1. There may be devices in the future with a different vendor value.

• product :: Word32

  The product id of the device. The available products can be found in our Product Registry.

Instances

Generic StateVersion

Defined in Lifx.Lan

Associated Types

type Rep StateVersion :: Type -> Type

Methods

from :: StateVersion -> Rep StateVersion x

to :: Rep StateVersion x -> StateVersion

Show StateVersion

Defined in Lifx.Lan

Methods

showsPrec :: Int -> StateVersion -> ShowS

show :: StateVersion -> String

showList :: [StateVersion] -> ShowS

Eq StateVersion

Defined in Lifx.Lan

Methods

(==) :: StateVersion -> StateVersion -> Bool

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

Ord StateVersion

Defined in Lifx.Lan

Methods

compare :: StateVersion -> StateVersion -> Ordering

(<) :: StateVersion -> StateVersion -> Bool

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

(>) :: StateVersion -> StateVersion -> Bool

(>=) :: StateVersion -> StateVersion -> Bool

max :: StateVersion -> StateVersion -> StateVersion

min :: StateVersion -> StateVersion -> StateVersion

type Rep StateVersion

Defined in Lifx.Lan

type Rep StateVersion = D1 ('MetaData "StateVersion" "Lifx.Lan" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" 'False) (C1 ('MetaCons "StateVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "vendor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "product") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

data LightState

https://lan.developer.lifx.com/docs/information-messages#lightstate---packet-107

Constructors

LightState

Fields

• hsbk :: HSBK
• power :: Word16
• label :: Text

Instances

Generic LightState

Defined in Lifx.Lan

Associated Types

type Rep LightState :: Type -> Type

Methods

from :: LightState -> Rep LightState x

to :: Rep LightState x -> LightState

Show LightState

Defined in Lifx.Lan

Methods

showsPrec :: Int -> LightState -> ShowS

show :: LightState -> String

showList :: [LightState] -> ShowS

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

type Rep LightState

Defined in Lifx.Lan

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

Product info

getProductInfo :: forall m. MonadLifx m => Device -> m Product

Ask a device for its vendor and product ID, and look up info on it from the official database.

data Product

Information about a particular LIFX product.

Constructors

Product

Fields

• name :: Text
• id :: Word32
• features :: Features

Instances

Generic Product

Defined in Lifx.Internal.ProductInfoMap

Associated Types

type Rep Product :: Type -> Type

Methods

from :: Product -> Rep Product x

to :: Rep Product x -> Product

Show Product

Defined in Lifx.Internal.ProductInfoMap

Methods

showsPrec :: Int -> Product -> ShowS

show :: Product -> String

showList :: [Product] -> ShowS

Eq Product

Defined in Lifx.Internal.ProductInfoMap

Methods

(==) :: Product -> Product -> Bool

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

Ord Product

Defined in Lifx.Internal.ProductInfoMap

Methods

compare :: Product -> Product -> Ordering

(<) :: Product -> Product -> Bool

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

(>) :: Product -> Product -> Bool

(>=) :: Product -> Product -> Bool

max :: Product -> Product -> Product

min :: Product -> Product -> Product

type Rep Product

Defined in Lifx.Internal.ProductInfoMap

type Rep Product = D1 ('MetaData "Product" "Lifx.Internal.ProductInfoMap" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" 'False) (C1 ('MetaCons "Product" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Features))))

data Features

Constructors

Features

Fields

• hev :: Bool

  The light supports emitting HEV light

• color :: Bool

  The light changes physical appearance when the Hue value is changed

• chain :: Bool

  The light may be connected to physically separated hardware (currently only the LIFX Tile)

• matrix :: Bool

  The light supports a 2D matrix of LEDs (the Tile and Candle)

• relays :: Bool

  The device has relays for controlling physical power to something (the LIFX Switch)

• buttons :: Bool

  The device has physical buttons to press (the LIFX Switch)

• infrared :: Bool

  The light supports emitting infrared light

• multizone :: Bool

  The light supports a 1D linear array of LEDs (the Z and Beam)

• temperatureRange :: Maybe (Word16, Word16)

  An array of the minimum and maximum kelvin values this device supports. If the numbers are the same then the device does not support variable kelvin values. It is null for devices that aren't lighting products (the LIFX Switch)

• extendedMultizone :: Bool

  The more capable extended API for multizone control that lets us control all the zones on the device with a single message instead of many.

Instances

Generic Features

Defined in Lifx.Internal.Product

Associated Types

type Rep Features :: Type -> Type

Methods

from :: Features -> Rep Features x

to :: Rep Features x -> Features

Show Features

Defined in Lifx.Internal.Product

Methods

showsPrec :: Int -> Features -> ShowS

show :: Features -> String

showList :: [Features] -> ShowS

Eq Features

Defined in Lifx.Internal.Product

Methods

(==) :: Features -> Features -> Bool

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

Ord Features

Defined in Lifx.Internal.Product

Methods

compare :: Features -> Features -> Ordering

(<) :: Features -> Features -> Bool

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

(>) :: Features -> Features -> Bool

(>=) :: Features -> Features -> Bool

max :: Features -> Features -> Features

min :: Features -> Features -> Features

type Rep Features

Defined in Lifx.Internal.Product

type Rep Features = D1 ('MetaData "Features" "Lifx.Internal.Product" "lifx-lan-0.8.0-DQBIsgHV1Wl9JdIUUqinTJ" 'False) (C1 ('MetaCons "Features" 'PrefixI 'True) (((S1 ('MetaSel ('Just "hev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "chain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "matrix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "relays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "buttons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "infrared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "multizone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "temperatureRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Word16, Word16))) :*: S1 ('MetaSel ('Just "extendedMultizone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))

Message encoding

These are used internally by LifxT's sendMessage and broadcastMessage. They are exposed in order to support some advanced use cases.

encodeMessage

Arguments

:: Bool

tagged

-> Bool

ackRequired

-> Word8

sequenceCounter

-> Word32

source

-> Message r

-> 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

Generic Header

Defined in Lifx.Lan

Associated Types

type Rep Header :: Type -> Type

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

Show Header

Defined in Lifx.Lan

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Binary Header

Defined in Lifx.Lan

Methods

put :: Header -> Put

get :: Get Header

putList :: [Header] -> Put

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

type Rep Header

Defined in Lifx.Lan

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