{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.IoTFleetWise.Types.ObdInterface
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.IoTFleetWise.Types.ObdInterface where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | A network interface that specifies the On-board diagnostic (OBD) II
-- network protocol.
--
-- /See:/ 'newObdInterface' smart constructor.
data ObdInterface = ObdInterface'
  { -- | The maximum number message requests per diagnostic trouble code per
    -- second.
    ObdInterface -> Maybe Natural
dtcRequestIntervalSeconds :: Prelude.Maybe Prelude.Natural,
    -- | Whether the vehicle has a transmission control module (TCM).
    ObdInterface -> Maybe Bool
hasTransmissionEcu :: Prelude.Maybe Prelude.Bool,
    -- | The standard OBD II PID.
    ObdInterface -> Maybe Text
obdStandard :: Prelude.Maybe Prelude.Text,
    -- | The maximum number message requests per second.
    ObdInterface -> Maybe Natural
pidRequestIntervalSeconds :: Prelude.Maybe Prelude.Natural,
    -- | Whether to use extended IDs in the message.
    ObdInterface -> Maybe Bool
useExtendedIds :: Prelude.Maybe Prelude.Bool,
    -- | The name of the interface.
    ObdInterface -> Text
name :: Prelude.Text,
    -- | The ID of the message requesting vehicle data.
    ObdInterface -> Natural
requestMessageId :: Prelude.Natural
  }
  deriving (ObdInterface -> ObdInterface -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ObdInterface -> ObdInterface -> Bool
$c/= :: ObdInterface -> ObdInterface -> Bool
== :: ObdInterface -> ObdInterface -> Bool
$c== :: ObdInterface -> ObdInterface -> Bool
Prelude.Eq, ReadPrec [ObdInterface]
ReadPrec ObdInterface
Int -> ReadS ObdInterface
ReadS [ObdInterface]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ObdInterface]
$creadListPrec :: ReadPrec [ObdInterface]
readPrec :: ReadPrec ObdInterface
$creadPrec :: ReadPrec ObdInterface
readList :: ReadS [ObdInterface]
$creadList :: ReadS [ObdInterface]
readsPrec :: Int -> ReadS ObdInterface
$creadsPrec :: Int -> ReadS ObdInterface
Prelude.Read, Int -> ObdInterface -> ShowS
[ObdInterface] -> ShowS
ObdInterface -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ObdInterface] -> ShowS
$cshowList :: [ObdInterface] -> ShowS
show :: ObdInterface -> String
$cshow :: ObdInterface -> String
showsPrec :: Int -> ObdInterface -> ShowS
$cshowsPrec :: Int -> ObdInterface -> ShowS
Prelude.Show, forall x. Rep ObdInterface x -> ObdInterface
forall x. ObdInterface -> Rep ObdInterface x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ObdInterface x -> ObdInterface
$cfrom :: forall x. ObdInterface -> Rep ObdInterface x
Prelude.Generic)

-- |
-- Create a value of 'ObdInterface' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'dtcRequestIntervalSeconds', 'obdInterface_dtcRequestIntervalSeconds' - The maximum number message requests per diagnostic trouble code per
-- second.
--
-- 'hasTransmissionEcu', 'obdInterface_hasTransmissionEcu' - Whether the vehicle has a transmission control module (TCM).
--
-- 'obdStandard', 'obdInterface_obdStandard' - The standard OBD II PID.
--
-- 'pidRequestIntervalSeconds', 'obdInterface_pidRequestIntervalSeconds' - The maximum number message requests per second.
--
-- 'useExtendedIds', 'obdInterface_useExtendedIds' - Whether to use extended IDs in the message.
--
-- 'name', 'obdInterface_name' - The name of the interface.
--
-- 'requestMessageId', 'obdInterface_requestMessageId' - The ID of the message requesting vehicle data.
newObdInterface ::
  -- | 'name'
  Prelude.Text ->
  -- | 'requestMessageId'
  Prelude.Natural ->
  ObdInterface
newObdInterface :: Text -> Natural -> ObdInterface
newObdInterface Text
pName_ Natural
pRequestMessageId_ =
  ObdInterface'
    { $sel:dtcRequestIntervalSeconds:ObdInterface' :: Maybe Natural
dtcRequestIntervalSeconds =
        forall a. Maybe a
Prelude.Nothing,
      $sel:hasTransmissionEcu:ObdInterface' :: Maybe Bool
hasTransmissionEcu = forall a. Maybe a
Prelude.Nothing,
      $sel:obdStandard:ObdInterface' :: Maybe Text
obdStandard = forall a. Maybe a
Prelude.Nothing,
      $sel:pidRequestIntervalSeconds:ObdInterface' :: Maybe Natural
pidRequestIntervalSeconds = forall a. Maybe a
Prelude.Nothing,
      $sel:useExtendedIds:ObdInterface' :: Maybe Bool
useExtendedIds = forall a. Maybe a
Prelude.Nothing,
      $sel:name:ObdInterface' :: Text
name = Text
pName_,
      $sel:requestMessageId:ObdInterface' :: Natural
requestMessageId = Natural
pRequestMessageId_
    }

-- | The maximum number message requests per diagnostic trouble code per
-- second.
obdInterface_dtcRequestIntervalSeconds :: Lens.Lens' ObdInterface (Prelude.Maybe Prelude.Natural)
obdInterface_dtcRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural)
obdInterface_dtcRequestIntervalSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Maybe Natural
dtcRequestIntervalSeconds :: Maybe Natural
$sel:dtcRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
dtcRequestIntervalSeconds} -> Maybe Natural
dtcRequestIntervalSeconds) (\s :: ObdInterface
s@ObdInterface' {} Maybe Natural
a -> ObdInterface
s {$sel:dtcRequestIntervalSeconds:ObdInterface' :: Maybe Natural
dtcRequestIntervalSeconds = Maybe Natural
a} :: ObdInterface)

-- | Whether the vehicle has a transmission control module (TCM).
obdInterface_hasTransmissionEcu :: Lens.Lens' ObdInterface (Prelude.Maybe Prelude.Bool)
obdInterface_hasTransmissionEcu :: Lens' ObdInterface (Maybe Bool)
obdInterface_hasTransmissionEcu = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Maybe Bool
hasTransmissionEcu :: Maybe Bool
$sel:hasTransmissionEcu:ObdInterface' :: ObdInterface -> Maybe Bool
hasTransmissionEcu} -> Maybe Bool
hasTransmissionEcu) (\s :: ObdInterface
s@ObdInterface' {} Maybe Bool
a -> ObdInterface
s {$sel:hasTransmissionEcu:ObdInterface' :: Maybe Bool
hasTransmissionEcu = Maybe Bool
a} :: ObdInterface)

-- | The standard OBD II PID.
obdInterface_obdStandard :: Lens.Lens' ObdInterface (Prelude.Maybe Prelude.Text)
obdInterface_obdStandard :: Lens' ObdInterface (Maybe Text)
obdInterface_obdStandard = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Maybe Text
obdStandard :: Maybe Text
$sel:obdStandard:ObdInterface' :: ObdInterface -> Maybe Text
obdStandard} -> Maybe Text
obdStandard) (\s :: ObdInterface
s@ObdInterface' {} Maybe Text
a -> ObdInterface
s {$sel:obdStandard:ObdInterface' :: Maybe Text
obdStandard = Maybe Text
a} :: ObdInterface)

-- | The maximum number message requests per second.
obdInterface_pidRequestIntervalSeconds :: Lens.Lens' ObdInterface (Prelude.Maybe Prelude.Natural)
obdInterface_pidRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural)
obdInterface_pidRequestIntervalSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Maybe Natural
pidRequestIntervalSeconds :: Maybe Natural
$sel:pidRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
pidRequestIntervalSeconds} -> Maybe Natural
pidRequestIntervalSeconds) (\s :: ObdInterface
s@ObdInterface' {} Maybe Natural
a -> ObdInterface
s {$sel:pidRequestIntervalSeconds:ObdInterface' :: Maybe Natural
pidRequestIntervalSeconds = Maybe Natural
a} :: ObdInterface)

-- | Whether to use extended IDs in the message.
obdInterface_useExtendedIds :: Lens.Lens' ObdInterface (Prelude.Maybe Prelude.Bool)
obdInterface_useExtendedIds :: Lens' ObdInterface (Maybe Bool)
obdInterface_useExtendedIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Maybe Bool
useExtendedIds :: Maybe Bool
$sel:useExtendedIds:ObdInterface' :: ObdInterface -> Maybe Bool
useExtendedIds} -> Maybe Bool
useExtendedIds) (\s :: ObdInterface
s@ObdInterface' {} Maybe Bool
a -> ObdInterface
s {$sel:useExtendedIds:ObdInterface' :: Maybe Bool
useExtendedIds = Maybe Bool
a} :: ObdInterface)

-- | The name of the interface.
obdInterface_name :: Lens.Lens' ObdInterface Prelude.Text
obdInterface_name :: Lens' ObdInterface Text
obdInterface_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Text
name :: Text
$sel:name:ObdInterface' :: ObdInterface -> Text
name} -> Text
name) (\s :: ObdInterface
s@ObdInterface' {} Text
a -> ObdInterface
s {$sel:name:ObdInterface' :: Text
name = Text
a} :: ObdInterface)

-- | The ID of the message requesting vehicle data.
obdInterface_requestMessageId :: Lens.Lens' ObdInterface Prelude.Natural
obdInterface_requestMessageId :: Lens' ObdInterface Natural
obdInterface_requestMessageId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ObdInterface' {Natural
requestMessageId :: Natural
$sel:requestMessageId:ObdInterface' :: ObdInterface -> Natural
requestMessageId} -> Natural
requestMessageId) (\s :: ObdInterface
s@ObdInterface' {} Natural
a -> ObdInterface
s {$sel:requestMessageId:ObdInterface' :: Natural
requestMessageId = Natural
a} :: ObdInterface)

instance Data.FromJSON ObdInterface where
  parseJSON :: Value -> Parser ObdInterface
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ObdInterface"
      ( \Object
x ->
          Maybe Natural
-> Maybe Bool
-> Maybe Text
-> Maybe Natural
-> Maybe Bool
-> Text
-> Natural
-> ObdInterface
ObdInterface'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"dtcRequestIntervalSeconds")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"hasTransmissionEcu")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"obdStandard")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"pidRequestIntervalSeconds")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"useExtendedIds")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"name")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"requestMessageId")
      )

instance Prelude.Hashable ObdInterface where
  hashWithSalt :: Int -> ObdInterface -> Int
hashWithSalt Int
_salt ObdInterface' {Natural
Maybe Bool
Maybe Natural
Maybe Text
Text
requestMessageId :: Natural
name :: Text
useExtendedIds :: Maybe Bool
pidRequestIntervalSeconds :: Maybe Natural
obdStandard :: Maybe Text
hasTransmissionEcu :: Maybe Bool
dtcRequestIntervalSeconds :: Maybe Natural
$sel:requestMessageId:ObdInterface' :: ObdInterface -> Natural
$sel:name:ObdInterface' :: ObdInterface -> Text
$sel:useExtendedIds:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:pidRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
$sel:obdStandard:ObdInterface' :: ObdInterface -> Maybe Text
$sel:hasTransmissionEcu:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:dtcRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
dtcRequestIntervalSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
hasTransmissionEcu
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
obdStandard
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
pidRequestIntervalSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
useExtendedIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
requestMessageId

instance Prelude.NFData ObdInterface where
  rnf :: ObdInterface -> ()
rnf ObdInterface' {Natural
Maybe Bool
Maybe Natural
Maybe Text
Text
requestMessageId :: Natural
name :: Text
useExtendedIds :: Maybe Bool
pidRequestIntervalSeconds :: Maybe Natural
obdStandard :: Maybe Text
hasTransmissionEcu :: Maybe Bool
dtcRequestIntervalSeconds :: Maybe Natural
$sel:requestMessageId:ObdInterface' :: ObdInterface -> Natural
$sel:name:ObdInterface' :: ObdInterface -> Text
$sel:useExtendedIds:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:pidRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
$sel:obdStandard:ObdInterface' :: ObdInterface -> Maybe Text
$sel:hasTransmissionEcu:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:dtcRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
dtcRequestIntervalSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
hasTransmissionEcu
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
obdStandard
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
pidRequestIntervalSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
useExtendedIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
requestMessageId

instance Data.ToJSON ObdInterface where
  toJSON :: ObdInterface -> Value
toJSON ObdInterface' {Natural
Maybe Bool
Maybe Natural
Maybe Text
Text
requestMessageId :: Natural
name :: Text
useExtendedIds :: Maybe Bool
pidRequestIntervalSeconds :: Maybe Natural
obdStandard :: Maybe Text
hasTransmissionEcu :: Maybe Bool
dtcRequestIntervalSeconds :: Maybe Natural
$sel:requestMessageId:ObdInterface' :: ObdInterface -> Natural
$sel:name:ObdInterface' :: ObdInterface -> Text
$sel:useExtendedIds:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:pidRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
$sel:obdStandard:ObdInterface' :: ObdInterface -> Maybe Text
$sel:hasTransmissionEcu:ObdInterface' :: ObdInterface -> Maybe Bool
$sel:dtcRequestIntervalSeconds:ObdInterface' :: ObdInterface -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"dtcRequestIntervalSeconds" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
dtcRequestIntervalSeconds,
            (Key
"hasTransmissionEcu" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
hasTransmissionEcu,
            (Key
"obdStandard" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
obdStandard,
            (Key
"pidRequestIntervalSeconds" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
pidRequestIntervalSeconds,
            (Key
"useExtendedIds" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
useExtendedIds,
            forall a. a -> Maybe a
Prelude.Just (Key
"name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"requestMessageId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
requestMessageId)
          ]
      )