Class GetDTCs
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
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
Quick Jump
Fields
KEY_DTC_MASK
public static final java.lang.String KEY_DTC_MASK
- Constant Value
- "dtcMask"
KEY_ECU_NAME
public static final java.lang.String KEY_ECU_NAME
- Constant Value
- "ecuName"
Inherited Fields
Constructors
GetDTCs()
Constructs a new GetDTCs object
public GetDTCs()
GetDTCs( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new GetDTCs object indicated by the Hashtable parameter
public GetDTCs(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
GetDTCs( Integer ecuName )
Constructs a new GetDTCs object
public GetDTCs(Integer ecuName)
Constructor Parameters
- ecuName
- an Integer value representing a name of the module to receive the DTC form
Notes: Minvalue:0; Maxvalue:65535
Methods
setEcuName( Integer ecuName )
Sets a name of the module to receive the DTC form
public com.smartdevicelink.proxy.rpc.GetDTCs setEcuName(Integer ecuName)
Method Parameters
- ecuName
- an Integer value representing a name of the module to receive
the DTC form
Notes:
Minvalue:0; Maxvalue:65535
getEcuName()
Gets a name of the module to receive the DTC form
public java.lang.Integer getEcuName()
setDtcMask( Integer dtcMask )
public com.smartdevicelink.proxy.rpc.GetDTCs setDtcMask(Integer dtcMask)
Method Parameters
- dtcMask
getDtcMask()
public java.lang.Integer getDtcMask()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong |
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |