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

Description

Synopsis

data Actuator = Actuator' {
- allowedValues :: Maybe [Text]
- assignedValue :: Maybe Text
- description :: Maybe Text
- max :: Maybe Double
- min :: Maybe Double
- unit :: Maybe Text
- fullyQualifiedName :: Text
- dataType :: NodeDataType
}
newActuator :: Text -> NodeDataType -> Actuator
actuator_allowedValues :: Lens' Actuator (Maybe [Text])
actuator_assignedValue :: Lens' Actuator (Maybe Text)
actuator_description :: Lens' Actuator (Maybe Text)
actuator_max :: Lens' Actuator (Maybe Double)
actuator_min :: Lens' Actuator (Maybe Double)
actuator_unit :: Lens' Actuator (Maybe Text)
actuator_fullyQualifiedName :: Lens' Actuator Text
actuator_dataType :: Lens' Actuator NodeDataType

Documentation

data Actuator Source #

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

See: newActuator smart constructor.

Constructors

Actuator'

Fields

allowedValues :: Maybe [Text]
A list of possible values an actuator can take.
assignedValue :: Maybe Text
A specified value for the actuator.
description :: Maybe Text
A brief description of the actuator.
max :: Maybe Double
The specified possible maximum value of an actuator.
min :: Maybe Double
The specified possible minimum value of an actuator.
unit :: Maybe Text
The scientific unit for the actuator.
fullyQualifiedName :: Text
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
dataType :: NodeDataType
The specified data type of the actuator.

Instances

Instances details

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

newActuator Source #

Arguments

:: Text	`$sel:fullyQualifiedName:Actuator'`
-> NodeDataType	`$sel:dataType:Actuator'`
-> Actuator

Create a value of Actuator 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:allowedValues:Actuator', actuator_allowedValues - A list of possible values an actuator can take.

$sel:assignedValue:Actuator', actuator_assignedValue - A specified value for the actuator.

$sel:description:Actuator', actuator_description - A brief description of the actuator.

$sel:max:Actuator', actuator_max - The specified possible maximum value of an actuator.

$sel:min:Actuator', actuator_min - The specified possible minimum value of an actuator.

$sel:unit:Actuator', actuator_unit - The scientific unit for the actuator.

$sel:fullyQualifiedName:Actuator', actuator_fullyQualifiedName - The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

$sel:dataType:Actuator', actuator_dataType - The specified data type of the actuator.

actuator_allowedValues :: Lens' Actuator (Maybe [Text]) Source #

A list of possible values an actuator can take.

actuator_assignedValue :: Lens' Actuator (Maybe Text) Source #

A specified value for the actuator.

actuator_description :: Lens' Actuator (Maybe Text) Source #

A brief description of the actuator.

actuator_max :: Lens' Actuator (Maybe Double) Source #

The specified possible maximum value of an actuator.

actuator_min :: Lens' Actuator (Maybe Double) Source #

The specified possible minimum value of an actuator.

actuator_unit :: Lens' Actuator (Maybe Text) Source #

The scientific unit for the actuator.

actuator_fullyQualifiedName :: Lens' Actuator Text Source #

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

actuator_dataType :: Lens' Actuator NodeDataType Source #

The specified data type of the actuator.