Class: AWSCDK::IoTFleetWise::CfnDecoderManifest::ObdInterfaceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_fleet_wise/cfn_decoder_manifest.rb

Overview

A network interface that specifies the On-board diagnostic (OBD) II network protocol.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, request_message_id:, dtc_request_interval_seconds: nil, has_transmission_ecu: nil, obd_standard: nil, pid_request_interval_seconds: nil, use_extended_ids: nil) ⇒ ObdInterfaceProperty

Returns a new instance of ObdInterfaceProperty.

Parameters:

  • name (String) —

    The name of the interface.

  • request_message_id (String) —

    The ID of the message requesting vehicle data.

  • dtc_request_interval_seconds (String, nil) (defaults to: nil) —

    The maximum number message requests per diagnostic trouble code per second.

  • has_transmission_ecu (String, nil) (defaults to: nil) —

    Whether the vehicle has a transmission control module (TCM).

  • obd_standard (String, nil) (defaults to: nil) —

    The standard OBD II PID.

  • pid_request_interval_seconds (String, nil) (defaults to: nil) —

    The maximum number message requests per second.

  • use_extended_ids (String, nil) (defaults to: nil) —

    Whether to use extended IDs in the message.



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 988

def initialize(name:, request_message_id:, dtc_request_interval_seconds: nil, has_transmission_ecu: nil, obd_standard: nil, pid_request_interval_seconds: nil, use_extended_ids: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @request_message_id = request_message_id
  Jsii::Type.check_type(@request_message_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requestMessageId")
  @dtc_request_interval_seconds = dtc_request_interval_seconds
  Jsii::Type.check_type(@dtc_request_interval_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dtcRequestIntervalSeconds") unless @dtc_request_interval_seconds.nil?
  @has_transmission_ecu = has_transmission_ecu
  Jsii::Type.check_type(@has_transmission_ecu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hasTransmissionEcu") unless @has_transmission_ecu.nil?
  @obd_standard = obd_standard
  Jsii::Type.check_type(@obd_standard, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "obdStandard") unless @obd_standard.nil?
  @pid_request_interval_seconds = pid_request_interval_seconds
  Jsii::Type.check_type(@pid_request_interval_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pidRequestIntervalSeconds") unless @pid_request_interval_seconds.nil?
  @use_extended_ids = use_extended_ids
  Jsii::Type.check_type(@use_extended_ids, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "useExtendedIds") unless @use_extended_ids.nil?
end

Instance Attribute Details

#dtc_request_interval_seconds ⇒ String? (readonly)

The maximum number message requests per diagnostic trouble code per second.

Returns:

  • (String, nil)

See Also:



1019
1020
1021
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1019

def dtc_request_interval_seconds
  @dtc_request_interval_seconds
end

#has_transmission_ecu ⇒ String? (readonly)

Whether the vehicle has a transmission control module (TCM).

Returns:

  • (String, nil)

See Also:



1024
1025
1026
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1024

def has_transmission_ecu
  @has_transmission_ecu
end

#name ⇒ String (readonly)

The name of the interface.

Returns:

  • (String)

See Also:



1009
1010
1011
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1009

def name
  @name
end

#obd_standard ⇒ String? (readonly)

The standard OBD II PID.

Returns:

  • (String, nil)

See Also:



1029
1030
1031
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1029

def obd_standard
  @obd_standard
end

#pid_request_interval_seconds ⇒ String? (readonly)

The maximum number message requests per second.

Returns:

  • (String, nil)

See Also:



1034
1035
1036
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1034

def pid_request_interval_seconds
  @pid_request_interval_seconds
end

#request_message_id ⇒ String (readonly)

The ID of the message requesting vehicle data.

Returns:

  • (String)

See Also:



1014
1015
1016
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1014

def request_message_id
  @request_message_id
end

#use_extended_ids ⇒ String? (readonly)

Whether to use extended IDs in the message.

Returns:

  • (String, nil)

See Also:



1039
1040
1041
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1039

def use_extended_ids
  @use_extended_ids
end

Class Method Details

.jsii_properties ⇒ Object 



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1041

def self.jsii_properties
  {
    :name => "name",
    :request_message_id => "requestMessageId",
    :dtc_request_interval_seconds => "dtcRequestIntervalSeconds",
    :has_transmission_ecu => "hasTransmissionEcu",
    :obd_standard => "obdStandard",
    :pid_request_interval_seconds => "pidRequestIntervalSeconds",
    :use_extended_ids => "useExtendedIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'io_t_fleet_wise/cfn_decoder_manifest.rb', line 1053

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "requestMessageId" => @request_message_id,
    "dtcRequestIntervalSeconds" => @dtc_request_interval_seconds,
    "hasTransmissionEcu" => @has_transmission_ecu,
    "obdStandard" => @obd_standard,
    "pidRequestIntervalSeconds" => @pid_request_interval_seconds,
    "useExtendedIds" => @use_extended_ids,
  })
  result.compact
end