{-# 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.CanSignal
-- 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.CanSignal 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

-- | Information about a single controller area network (CAN) signal and the
-- messages it receives and transmits.
--
-- /See:/ 'newCanSignal' smart constructor.
data CanSignal = CanSignal'
  { -- | The name of the signal.
    CanSignal -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The ID of the message.
    CanSignal -> Natural
messageId :: Prelude.Natural,
    -- | Whether the byte ordering of a CAN message is big-endian.
    CanSignal -> Bool
isBigEndian :: Prelude.Bool,
    -- | Whether the message data is specified as a signed value.
    CanSignal -> Bool
isSigned :: Prelude.Bool,
    -- | Indicates the beginning of the CAN message.
    CanSignal -> Natural
startBit :: Prelude.Natural,
    -- | Indicates where data appears in the CAN message.
    CanSignal -> Double
offset :: Prelude.Double,
    -- | A multiplier used to decode the CAN message.
    CanSignal -> Double
factor :: Prelude.Double,
    -- | How many bytes of data are in the message.
    CanSignal -> Natural
length :: Prelude.Natural
  }
  deriving (CanSignal -> CanSignal -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CanSignal -> CanSignal -> Bool
$c/= :: CanSignal -> CanSignal -> Bool
== :: CanSignal -> CanSignal -> Bool
$c== :: CanSignal -> CanSignal -> Bool
Prelude.Eq, ReadPrec [CanSignal]
ReadPrec CanSignal
Int -> ReadS CanSignal
ReadS [CanSignal]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CanSignal]
$creadListPrec :: ReadPrec [CanSignal]
readPrec :: ReadPrec CanSignal
$creadPrec :: ReadPrec CanSignal
readList :: ReadS [CanSignal]
$creadList :: ReadS [CanSignal]
readsPrec :: Int -> ReadS CanSignal
$creadsPrec :: Int -> ReadS CanSignal
Prelude.Read, Int -> CanSignal -> ShowS
[CanSignal] -> ShowS
CanSignal -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CanSignal] -> ShowS
$cshowList :: [CanSignal] -> ShowS
show :: CanSignal -> String
$cshow :: CanSignal -> String
showsPrec :: Int -> CanSignal -> ShowS
$cshowsPrec :: Int -> CanSignal -> ShowS
Prelude.Show, forall x. Rep CanSignal x -> CanSignal
forall x. CanSignal -> Rep CanSignal x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CanSignal x -> CanSignal
$cfrom :: forall x. CanSignal -> Rep CanSignal x
Prelude.Generic)

-- |
-- Create a value of 'CanSignal' 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:
--
-- 'name', 'canSignal_name' - The name of the signal.
--
-- 'messageId', 'canSignal_messageId' - The ID of the message.
--
-- 'isBigEndian', 'canSignal_isBigEndian' - Whether the byte ordering of a CAN message is big-endian.
--
-- 'isSigned', 'canSignal_isSigned' - Whether the message data is specified as a signed value.
--
-- 'startBit', 'canSignal_startBit' - Indicates the beginning of the CAN message.
--
-- 'offset', 'canSignal_offset' - Indicates where data appears in the CAN message.
--
-- 'factor', 'canSignal_factor' - A multiplier used to decode the CAN message.
--
-- 'length', 'canSignal_length' - How many bytes of data are in the message.
newCanSignal ::
  -- | 'messageId'
  Prelude.Natural ->
  -- | 'isBigEndian'
  Prelude.Bool ->
  -- | 'isSigned'
  Prelude.Bool ->
  -- | 'startBit'
  Prelude.Natural ->
  -- | 'offset'
  Prelude.Double ->
  -- | 'factor'
  Prelude.Double ->
  -- | 'length'
  Prelude.Natural ->
  CanSignal
newCanSignal :: Natural
-> Bool
-> Bool
-> Natural
-> Double
-> Double
-> Natural
-> CanSignal
newCanSignal
  Natural
pMessageId_
  Bool
pIsBigEndian_
  Bool
pIsSigned_
  Natural
pStartBit_
  Double
pOffset_
  Double
pFactor_
  Natural
pLength_ =
    CanSignal'
      { $sel:name:CanSignal' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
        $sel:messageId:CanSignal' :: Natural
messageId = Natural
pMessageId_,
        $sel:isBigEndian:CanSignal' :: Bool
isBigEndian = Bool
pIsBigEndian_,
        $sel:isSigned:CanSignal' :: Bool
isSigned = Bool
pIsSigned_,
        $sel:startBit:CanSignal' :: Natural
startBit = Natural
pStartBit_,
        $sel:offset:CanSignal' :: Double
offset = Double
pOffset_,
        $sel:factor:CanSignal' :: Double
factor = Double
pFactor_,
        $sel:length:CanSignal' :: Natural
length = Natural
pLength_
      }

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

-- | The ID of the message.
canSignal_messageId :: Lens.Lens' CanSignal Prelude.Natural
canSignal_messageId :: Lens' CanSignal Natural
canSignal_messageId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Natural
messageId :: Natural
$sel:messageId:CanSignal' :: CanSignal -> Natural
messageId} -> Natural
messageId) (\s :: CanSignal
s@CanSignal' {} Natural
a -> CanSignal
s {$sel:messageId:CanSignal' :: Natural
messageId = Natural
a} :: CanSignal)

-- | Whether the byte ordering of a CAN message is big-endian.
canSignal_isBigEndian :: Lens.Lens' CanSignal Prelude.Bool
canSignal_isBigEndian :: Lens' CanSignal Bool
canSignal_isBigEndian = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Bool
isBigEndian :: Bool
$sel:isBigEndian:CanSignal' :: CanSignal -> Bool
isBigEndian} -> Bool
isBigEndian) (\s :: CanSignal
s@CanSignal' {} Bool
a -> CanSignal
s {$sel:isBigEndian:CanSignal' :: Bool
isBigEndian = Bool
a} :: CanSignal)

-- | Whether the message data is specified as a signed value.
canSignal_isSigned :: Lens.Lens' CanSignal Prelude.Bool
canSignal_isSigned :: Lens' CanSignal Bool
canSignal_isSigned = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Bool
isSigned :: Bool
$sel:isSigned:CanSignal' :: CanSignal -> Bool
isSigned} -> Bool
isSigned) (\s :: CanSignal
s@CanSignal' {} Bool
a -> CanSignal
s {$sel:isSigned:CanSignal' :: Bool
isSigned = Bool
a} :: CanSignal)

-- | Indicates the beginning of the CAN message.
canSignal_startBit :: Lens.Lens' CanSignal Prelude.Natural
canSignal_startBit :: Lens' CanSignal Natural
canSignal_startBit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Natural
startBit :: Natural
$sel:startBit:CanSignal' :: CanSignal -> Natural
startBit} -> Natural
startBit) (\s :: CanSignal
s@CanSignal' {} Natural
a -> CanSignal
s {$sel:startBit:CanSignal' :: Natural
startBit = Natural
a} :: CanSignal)

-- | Indicates where data appears in the CAN message.
canSignal_offset :: Lens.Lens' CanSignal Prelude.Double
canSignal_offset :: Lens' CanSignal Double
canSignal_offset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Double
offset :: Double
$sel:offset:CanSignal' :: CanSignal -> Double
offset} -> Double
offset) (\s :: CanSignal
s@CanSignal' {} Double
a -> CanSignal
s {$sel:offset:CanSignal' :: Double
offset = Double
a} :: CanSignal)

-- | A multiplier used to decode the CAN message.
canSignal_factor :: Lens.Lens' CanSignal Prelude.Double
canSignal_factor :: Lens' CanSignal Double
canSignal_factor = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Double
factor :: Double
$sel:factor:CanSignal' :: CanSignal -> Double
factor} -> Double
factor) (\s :: CanSignal
s@CanSignal' {} Double
a -> CanSignal
s {$sel:factor:CanSignal' :: Double
factor = Double
a} :: CanSignal)

-- | How many bytes of data are in the message.
canSignal_length :: Lens.Lens' CanSignal Prelude.Natural
canSignal_length :: Lens' CanSignal Natural
canSignal_length = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CanSignal' {Natural
length :: Natural
$sel:length:CanSignal' :: CanSignal -> Natural
length} -> Natural
length) (\s :: CanSignal
s@CanSignal' {} Natural
a -> CanSignal
s {$sel:length:CanSignal' :: Natural
length = Natural
a} :: CanSignal)

instance Data.FromJSON CanSignal where
  parseJSON :: Value -> Parser CanSignal
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CanSignal"
      ( \Object
x ->
          Maybe Text
-> Natural
-> Bool
-> Bool
-> Natural
-> Double
-> Double
-> Natural
-> CanSignal
CanSignal'
            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
"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
"messageId")
            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
"isBigEndian")
            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
"isSigned")
            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
"startBit")
            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
"offset")
            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
"factor")
            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
"length")
      )

instance Prelude.Hashable CanSignal where
  hashWithSalt :: Int -> CanSignal -> Int
hashWithSalt Int
_salt CanSignal' {Bool
Double
Natural
Maybe Text
length :: Natural
factor :: Double
offset :: Double
startBit :: Natural
isSigned :: Bool
isBigEndian :: Bool
messageId :: Natural
name :: Maybe Text
$sel:length:CanSignal' :: CanSignal -> Natural
$sel:factor:CanSignal' :: CanSignal -> Double
$sel:offset:CanSignal' :: CanSignal -> Double
$sel:startBit:CanSignal' :: CanSignal -> Natural
$sel:isSigned:CanSignal' :: CanSignal -> Bool
$sel:isBigEndian:CanSignal' :: CanSignal -> Bool
$sel:messageId:CanSignal' :: CanSignal -> Natural
$sel:name:CanSignal' :: CanSignal -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
messageId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Bool
isBigEndian
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Bool
isSigned
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
startBit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Double
offset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Double
factor
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
length

instance Prelude.NFData CanSignal where
  rnf :: CanSignal -> ()
rnf CanSignal' {Bool
Double
Natural
Maybe Text
length :: Natural
factor :: Double
offset :: Double
startBit :: Natural
isSigned :: Bool
isBigEndian :: Bool
messageId :: Natural
name :: Maybe Text
$sel:length:CanSignal' :: CanSignal -> Natural
$sel:factor:CanSignal' :: CanSignal -> Double
$sel:offset:CanSignal' :: CanSignal -> Double
$sel:startBit:CanSignal' :: CanSignal -> Natural
$sel:isSigned:CanSignal' :: CanSignal -> Bool
$sel:isBigEndian:CanSignal' :: CanSignal -> Bool
$sel:messageId:CanSignal' :: CanSignal -> Natural
$sel:name:CanSignal' :: CanSignal -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
messageId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Bool
isBigEndian
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Bool
isSigned
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
startBit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Double
offset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Double
factor
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
length

instance Data.ToJSON CanSignal where
  toJSON :: CanSignal -> Value
toJSON CanSignal' {Bool
Double
Natural
Maybe Text
length :: Natural
factor :: Double
offset :: Double
startBit :: Natural
isSigned :: Bool
isBigEndian :: Bool
messageId :: Natural
name :: Maybe Text
$sel:length:CanSignal' :: CanSignal -> Natural
$sel:factor:CanSignal' :: CanSignal -> Double
$sel:offset:CanSignal' :: CanSignal -> Double
$sel:startBit:CanSignal' :: CanSignal -> Natural
$sel:isSigned:CanSignal' :: CanSignal -> Bool
$sel:isBigEndian:CanSignal' :: CanSignal -> Bool
$sel:messageId:CanSignal' :: CanSignal -> Natural
$sel:name:CanSignal' :: CanSignal -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"name" 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
name,
            forall a. a -> Maybe a
Prelude.Just (Key
"messageId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
messageId),
            forall a. a -> Maybe a
Prelude.Just (Key
"isBigEndian" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Bool
isBigEndian),
            forall a. a -> Maybe a
Prelude.Just (Key
"isSigned" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Bool
isSigned),
            forall a. a -> Maybe a
Prelude.Just (Key
"startBit" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
startBit),
            forall a. a -> Maybe a
Prelude.Just (Key
"offset" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Double
offset),
            forall a. a -> Maybe a
Prelude.Just (Key
"factor" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Double
factor),
            forall a. a -> Maybe a
Prelude.Just (Key
"length" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
length)
          ]
      )