com.smartdevicelink.proxy.rpc

Class GetDTCs

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.GetDTCs

All Implemented Interfaces:

Cloneable

public class GetDTCs
extends RPCRequest

This RPC allows to request diagnostic module trouble codes from a certain vehicle module.

Function Group: ProprietaryData

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Name	Type	Description	Reg.	Notes	Version
ecuName	Integer	Name of ECU.	Y	Min Value: 0; Max Value: 65535	SmartDeviceLink 2.0
dtcMask	Integer	DTC Mask Byte to be sent in diagnostic request to module.	N	Min Value: 0; Max Value: 255	SmartDeviceLink 2.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

USER_DISALLOWED

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DTC_MASK
static String	KEY_ECU_NAME

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
GetDTCs() Constructs a new GetDTCs object
GetDTCs(Hashtable<String,Object> hash) Constructs a new GetDTCs object indicated by the Hashtable parameter
GetDTCs(Integer ecuName) Constructs a new GetDTCs object

Method Summary

Modifier and Type	Method and Description
Integer	getDtcMask()
Integer	getEcuName() Gets a name of the module to receive the DTC form
GetDTCs	setDtcMask(Integer dtcMask)
GetDTCs	setEcuName(Integer ecuName) Sets a name of the module to receive the DTC form

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_DTC_MASK

public static final String KEY_DTC_MASK

See Also:

Constant Field Values

KEY_ECU_NAME

public static final String KEY_ECU_NAME

See Also:

Constant Field Values

Constructor Detail

GetDTCs

public GetDTCs()

Constructs a new GetDTCs object

GetDTCs

public GetDTCs(Hashtable<String,Object> hash)

Constructs a new GetDTCs object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

GetDTCs

public GetDTCs(@NonNull
               Integer ecuName)

Constructs a new GetDTCs object

Parameters:

ecuName - an Integer value representing a name of the module to receive the DTC form
Notes: Minvalue:0; Maxvalue:65535

Method Detail

setEcuName

public GetDTCs setEcuName(@NonNull
                          Integer ecuName)

Sets a name of the module to receive the DTC form

Parameters:

ecuName - an Integer value representing a name of the module to receive the DTC form

Notes:

Minvalue:0; Maxvalue:65535

getEcuName

public Integer getEcuName()

Gets a name of the module to receive the DTC form

Returns:

Integer -an Integer value representing a name of the module to receive the DTC form

setDtcMask

public GetDTCs setDtcMask(Integer dtcMask)

getDtcMask

public Integer getDtcMask()