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.ObdSignal

Description

Synopsis

data ObdSignal = ObdSignal' {
- bitMaskLength :: Maybe Natural
- bitRightShift :: Maybe Natural
- pidResponseLength :: Natural
- serviceMode :: Natural
- pid :: Natural
- scaling :: Double
- offset :: Double
- startByte :: Natural
- byteLength :: Natural
}
newObdSignal :: Natural -> Natural -> Natural -> Double -> Double -> Natural -> Natural -> ObdSignal
obdSignal_bitMaskLength :: Lens' ObdSignal (Maybe Natural)
obdSignal_bitRightShift :: Lens' ObdSignal (Maybe Natural)
obdSignal_pidResponseLength :: Lens' ObdSignal Natural
obdSignal_serviceMode :: Lens' ObdSignal Natural
obdSignal_pid :: Lens' ObdSignal Natural
obdSignal_scaling :: Lens' ObdSignal Double
obdSignal_offset :: Lens' ObdSignal Double
obdSignal_startByte :: Lens' ObdSignal Natural
obdSignal_byteLength :: Lens' ObdSignal Natural

Documentation

data ObdSignal Source #

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

See: newObdSignal smart constructor.

Constructors

ObdSignal'

Fields

bitMaskLength :: Maybe Natural
The number of bits to mask in a message.
bitRightShift :: Maybe Natural
The number of positions to shift bits in the message.
pidResponseLength :: Natural
The length of the requested data.
serviceMode :: Natural
The mode of operation (diagnostic service) in a message.
pid :: Natural
The diagnostic code used to request data from a vehicle for this signal.
scaling :: Double
A multiplier used to decode the message.
offset :: Double
Indicates where data appears in the message.
startByte :: Natural
Indicates the beginning of the message.
byteLength :: Natural
The length of a message.

Instances

Instances details

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

newObdSignal Source #

Arguments

:: Natural	`$sel:pidResponseLength:ObdSignal'`
-> Natural	`$sel:serviceMode:ObdSignal'`
-> Natural	`$sel:pid:ObdSignal'`
-> Double	`$sel:scaling:ObdSignal'`
-> Double	`$sel:offset:ObdSignal'`
-> Natural	`$sel:startByte:ObdSignal'`
-> Natural	`$sel:byteLength:ObdSignal'`
-> ObdSignal

Create a value of ObdSignal 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:bitMaskLength:ObdSignal', obdSignal_bitMaskLength - The number of bits to mask in a message.

$sel:bitRightShift:ObdSignal', obdSignal_bitRightShift - The number of positions to shift bits in the message.

$sel:pidResponseLength:ObdSignal', obdSignal_pidResponseLength - The length of the requested data.

$sel:serviceMode:ObdSignal', obdSignal_serviceMode - The mode of operation (diagnostic service) in a message.

$sel:pid:ObdSignal', obdSignal_pid - The diagnostic code used to request data from a vehicle for this signal.

$sel:scaling:ObdSignal', obdSignal_scaling - A multiplier used to decode the message.

$sel:offset:ObdSignal', obdSignal_offset - Indicates where data appears in the message.

$sel:startByte:ObdSignal', obdSignal_startByte - Indicates the beginning of the message.

$sel:byteLength:ObdSignal', obdSignal_byteLength - The length of a message.

obdSignal_bitMaskLength :: Lens' ObdSignal (Maybe Natural) Source #

The number of bits to mask in a message.

obdSignal_bitRightShift :: Lens' ObdSignal (Maybe Natural) Source #

The number of positions to shift bits in the message.

obdSignal_pidResponseLength :: Lens' ObdSignal Natural Source #

The length of the requested data.

obdSignal_serviceMode :: Lens' ObdSignal Natural Source #

The mode of operation (diagnostic service) in a message.

obdSignal_pid :: Lens' ObdSignal Natural Source #

The diagnostic code used to request data from a vehicle for this signal.

obdSignal_scaling :: Lens' ObdSignal Double Source #

A multiplier used to decode the message.

obdSignal_offset :: Lens' ObdSignal Double Source #

Indicates where data appears in the message.

obdSignal_startByte :: Lens' ObdSignal Natural Source #

Indicates the beginning of the message.

obdSignal_byteLength :: Lens' ObdSignal Natural Source #

The length of a message.