Safe Haskell	None
Language	Haskell2010

HomeAssistant.Types

Description

Types used by Home Assistant.

Synopsis

type JSONOptions (prefix :: Symbol) = '[OmitNothingFields, FieldLabelModifier '[StripPrefix prefix, CamelToSnake]]
data UnitSystem = MkUnitSystem {
- unitSystemLength :: Text
- unitSystemMass :: Text
- unitSystemTemperature :: Text
- unitSystemVolume :: Text
}
data Config = MkConfig {
- configComponents :: [Text]
- configConfigDir :: Text
- configLocationName :: Text
- configTimeZone :: Text
- configElevation :: Int
- configLatitude :: Double
- configLongitude :: Double
- configUnitSystem :: UnitSystem
- configVersion :: Text
- configWhitelistExternalDirs :: [Text]
}
data Service = MkService {
- serviceName :: Text
- serviceDescription :: Text
- serviceFields :: Map Text Value
}
data ServiceDomain = MkServiceDomain {
- sdDomain :: Text
- sdServices :: Map Text Service
}

Documentation

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 UnitSystem Source #

Represents units that Home Assistant is configured to use.

Constructors

MkUnitSystem
Fields unitSystemLength :: Text Identifies the unit used for distances. unitSystemMass :: Text Identifies the unit used for mass. unitSystemTemperature :: Text Identifies the unit used for temperatures. unitSystemVolume :: Text Identifies the unit used for volumes.

Instances

Instances details

FromJSON UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

Methods

parseJSON :: Value -> Parser UnitSystem #

parseJSONList :: Value -> Parser [UnitSystem] #

omittedField :: Maybe UnitSystem #

ToJSON UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

Methods

toJSON :: UnitSystem -> Value #

toEncoding :: UnitSystem -> Encoding #

toJSONList :: [UnitSystem] -> Value #

toEncodingList :: [UnitSystem] -> Encoding #

omitField :: UnitSystem -> Bool #

Generic UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

Associated Types

type Rep UnitSystem

Instance details

Defined in HomeAssistant.Types

type Rep UnitSystem = D1 ('MetaData "UnitSystem" "HomeAssistant.Types" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkUnitSystem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "unitSystemLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "unitSystemMass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "unitSystemTemperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "unitSystemVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: UnitSystem -> Rep UnitSystem x #

to :: Rep UnitSystem x -> UnitSystem #

Show UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

Methods

showsPrec :: Int -> UnitSystem -> ShowS #

show :: UnitSystem -> String #

showList :: [UnitSystem] -> ShowS #

Eq UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

Methods

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

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

type Rep UnitSystem Source #

Instance details

Defined in HomeAssistant.Types

type Rep UnitSystem = D1 ('MetaData "UnitSystem" "HomeAssistant.Types" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkUnitSystem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "unitSystemLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "unitSystemMass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "unitSystemTemperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "unitSystemVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data Config Source #

Represents Home Assistant configurations.

Constructors

MkConfig
Fields configComponents :: [Text] configConfigDir :: Text configLocationName :: Text configTimeZone :: Text configElevation :: Int configLatitude :: Double configLongitude :: Double configUnitSystem :: UnitSystem The units that Home Assistant is configured to use. configVersion :: Text configWhitelistExternalDirs :: [Text]

Instances

Instances details

FromJSON Config Source #

Instance details

Defined in HomeAssistant.Types

Methods

parseJSON :: Value -> Parser Config #

parseJSONList :: Value -> Parser [Config] #

omittedField :: Maybe Config #

ToJSON Config Source #

Instance details

Defined in HomeAssistant.Types

Methods

toJSON :: Config -> Value #

toEncoding :: Config -> Encoding #

toJSONList :: [Config] -> Value #

toEncodingList :: [Config] -> Encoding #

omitField :: Config -> Bool #

Generic Config Source #

Instance details

Defined in HomeAssistant.Types

Associated Types

type Rep Config

Instance details

Defined in HomeAssistant.Types

Methods

from :: Config -> Rep Config x #

to :: Rep Config x -> Config #

Show Config Source #

Instance details

Defined in HomeAssistant.Types

Methods

showsPrec :: Int -> Config -> ShowS #

show :: Config -> String #

showList :: [Config] -> ShowS #

Eq Config Source #

Instance details

Defined in HomeAssistant.Types

Methods

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

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

type Rep Config Source #

Instance details

Defined in HomeAssistant.Types

data Service Source #

Represents Home Assistant services.

Constructors

MkService
Fields serviceName :: Text serviceDescription :: Text serviceFields :: Map Text Value

Instances

Instances details

FromJSON Service Source #

Instance details

Defined in HomeAssistant.Types

Methods

parseJSON :: Value -> Parser Service #

parseJSONList :: Value -> Parser [Service] #

omittedField :: Maybe Service #

ToJSON Service Source #

Instance details

Defined in HomeAssistant.Types

Methods

toJSON :: Service -> Value #

toEncoding :: Service -> Encoding #

toJSONList :: [Service] -> Value #

toEncodingList :: [Service] -> Encoding #

omitField :: Service -> Bool #

Generic Service Source #

Instance details

Defined in HomeAssistant.Types

Associated Types

type Rep Service

Instance details

Defined in HomeAssistant.Types

type Rep Service = D1 ('MetaData "Service" "HomeAssistant.Types" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkService" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "serviceDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Value)))))

Methods

from :: Service -> Rep Service x #

to :: Rep Service x -> Service #

Show Service Source #

Instance details

Defined in HomeAssistant.Types

Methods

showsPrec :: Int -> Service -> ShowS #

show :: Service -> String #

showList :: [Service] -> ShowS #

Eq Service Source #

Instance details

Defined in HomeAssistant.Types

Methods

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

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

type Rep Service Source #

Instance details

Defined in HomeAssistant.Types

type Rep Service = D1 ('MetaData "Service" "HomeAssistant.Types" "home-assistant-client-0.1.0.0-52CqQ6sONoKHixgMqSwY6f" 'False) (C1 ('MetaCons "MkService" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "serviceDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Value)))))

data ServiceDomain Source #

Represents Home Assistant service domains.

Constructors

MkServiceDomain
Fields sdDomain :: Text The domain name. sdServices :: Map Text Service The services in this domain as a mapping from names to services.