Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTFleetWise.Types.CanSignal

Description

Synopsis

data CanSignal = CanSignal' {
- name :: Maybe Text
- messageId :: Natural
- isBigEndian :: Bool
- isSigned :: Bool
- startBit :: Natural
- offset :: Double
- factor :: Double
- length :: Natural
}
newCanSignal :: Natural -> Bool -> Bool -> Natural -> Double -> Double -> Natural -> CanSignal
canSignal_name :: Lens' CanSignal (Maybe Text)
canSignal_messageId :: Lens' CanSignal Natural
canSignal_isBigEndian :: Lens' CanSignal Bool
canSignal_isSigned :: Lens' CanSignal Bool
canSignal_startBit :: Lens' CanSignal Natural
canSignal_offset :: Lens' CanSignal Double
canSignal_factor :: Lens' CanSignal Double
canSignal_length :: Lens' CanSignal Natural

Documentation

data CanSignal Source #

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

See: newCanSignal smart constructor.

Constructors

CanSignal'

Fields

name :: Maybe Text
The name of the signal.
messageId :: Natural
The ID of the message.
isBigEndian :: Bool
Whether the byte ordering of a CAN message is big-endian.
isSigned :: Bool
Whether the message data is specified as a signed value.
startBit :: Natural
Indicates the beginning of the CAN message.
offset :: Double
Indicates where data appears in the CAN message.
factor :: Double
A multiplier used to decode the CAN message.
length :: Natural
How many bytes of data are in the message.

Instances

Instances details

FromJSON CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods parseJSON :: Value -> Parser CanSignal # parseJSONList :: Value -> Parser [CanSignal] #
ToJSON CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods toJSON :: CanSignal -> Value # toEncoding :: CanSignal -> Encoding # toJSONList :: [CanSignal] -> Value # toEncodingList :: [CanSignal] -> Encoding #
Generic CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Associated Types type Rep CanSignal :: Type -> Type # Methods from :: CanSignal -> Rep CanSignal x # to :: Rep CanSignal x -> CanSignal #
Read CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods readsPrec :: Int -> ReadS CanSignal # readList :: ReadS [CanSignal] # readPrec :: ReadPrec CanSignal # readListPrec :: ReadPrec [CanSignal] #
Show CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods showsPrec :: Int -> CanSignal -> ShowS # show :: CanSignal -> String # showList :: [CanSignal] -> ShowS #
NFData CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods rnf :: CanSignal -> () #
Eq CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods (==) :: CanSignal -> CanSignal -> Bool # (/=) :: CanSignal -> CanSignal -> Bool #
Hashable CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal Methods hashWithSalt :: Int -> CanSignal -> Int # hash :: CanSignal -> Int #
type Rep CanSignal Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.CanSignal type Rep CanSignal = D1 ('MetaData "CanSignal" "Amazonka.IoTFleetWise.Types.CanSignal" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CanSignal'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "isBigEndian") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "isSigned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "startBit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :: (S1 ('MetaSel ('Just "factor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "length") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newCanSignal Source #

Arguments

:: Natural	`$sel:messageId:CanSignal'`
-> Bool	`$sel:isBigEndian:CanSignal'`
-> Bool	`$sel:isSigned:CanSignal'`
-> Natural	`$sel:startBit:CanSignal'`
-> Double	`$sel:offset:CanSignal'`
-> Double	`$sel:factor:CanSignal'`
-> Natural	`$sel:length:CanSignal'`
-> CanSignal

Create a value of CanSignal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:CanSignal', canSignal_name - The name of the signal.

$sel:messageId:CanSignal', canSignal_messageId - The ID of the message.

$sel:isBigEndian:CanSignal', canSignal_isBigEndian - Whether the byte ordering of a CAN message is big-endian.

$sel:isSigned:CanSignal', canSignal_isSigned - Whether the message data is specified as a signed value.

$sel:startBit:CanSignal', canSignal_startBit - Indicates the beginning of the CAN message.

$sel:offset:CanSignal', canSignal_offset - Indicates where data appears in the CAN message.

$sel:factor:CanSignal', canSignal_factor - A multiplier used to decode the CAN message.

$sel:length:CanSignal', canSignal_length - How many bytes of data are in the message.

canSignal_name :: Lens' CanSignal (Maybe Text) Source #

The name of the signal.

canSignal_messageId :: Lens' CanSignal Natural Source #

The ID of the message.

canSignal_isBigEndian :: Lens' CanSignal Bool Source #

Whether the byte ordering of a CAN message is big-endian.

canSignal_isSigned :: Lens' CanSignal Bool Source #

Whether the message data is specified as a signed value.

canSignal_startBit :: Lens' CanSignal Natural Source #

Indicates the beginning of the CAN message.

canSignal_offset :: Lens' CanSignal Double Source #

Indicates where data appears in the CAN message.

canSignal_factor :: Lens' CanSignal Double Source #

A multiplier used to decode the CAN message.

canSignal_length :: Lens' CanSignal Natural Source #

How many bytes of data are in the message.