home-assistant-client-0.1.0.0: Client library for the Home Assistant API.
Safe HaskellNone
LanguageHaskell2010

HomeAssistant.Client

Description

Client library for the Home Assistant API.

Synopsis

Documentation

type API = "api" :> Endpoints Source #

The Home Assistant API as a type.

type HA = ClientM Source #

type JSONOptions (prefix :: Symbol) = '[OmitNothingFields, FieldLabelModifier '[StripPrefix prefix, CamelToSnake]] Source #

The custom JSON encoding/decoding options for HA types.

HA does not like fields that are set to null - they must be omitted.

data StateChange Source #

Represents information about the state of an entity.

Instances

Instances details
FromJSON StateChange Source # 
Instance details

Defined in HomeAssistant.Client

Methods

parseJSON :: Value -> Parser StateChange #

parseJSONList :: Value -> Parser [StateChange] #

omittedField :: Maybe StateChange #

ToJSON StateChange Source # 
Instance details

Defined in HomeAssistant.Client

Methods

toJSON :: StateChange -> Value #

toEncoding :: StateChange -> Encoding #

toJSONList :: [StateChange] -> Value #

toEncodingList :: [StateChange] -> Encoding #

omitField :: StateChange -> Bool #

Generic StateChange Source # 
Instance details

Defined in HomeAssistant.Client

Associated Types

type Rep StateChange 
Instance details

Defined in HomeAssistant.Client

type Rep StateChange = D1 ('MetaData "StateChange" "HomeAssistant.Client" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkStateChange" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stateChangeAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :*: S1 ('MetaSel ('Just "stateChangeEntityID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "stateChangeLastChanged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "stateChangeState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: StateChange -> Rep StateChange x #

to :: Rep StateChange x -> StateChange #

Show StateChange Source # 
Instance details

Defined in HomeAssistant.Client

Methods

showsPrec :: Int -> StateChange -> ShowS #

show :: StateChange -> String #

showList :: [StateChange] -> ShowS #

Eq StateChange Source # 
Instance details

Defined in HomeAssistant.Client

Methods

(==) :: StateChange -> StateChange -> Bool #

(/=) :: StateChange -> StateChange -> Bool #

type Rep StateChange Source # 
Instance details

Defined in HomeAssistant.Client

type Rep StateChange = D1 ('MetaData "StateChange" "HomeAssistant.Client" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkStateChange" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stateChangeAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :*: S1 ('MetaSel ('Just "stateChangeEntityID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "stateChangeLastChanged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "stateChangeState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

status :: HA Value Source #

config :: HA Config Source #

services :: HA [ServiceDomain] Source #

callService :: Text -> Text -> Maybe Value -> HA Value Source #

callService domain service body calls service in domain with an optional body. The result depends on the service.

mkHomeAssistantEnv :: ByteString -> Manager -> BaseUrl -> ClientEnv Source #

module Servant.Client