com.smartdevicelink.proxy.rpc

Class ReadDID

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.ReadDID

All Implemented Interfaces:

Cloneable

public class ReadDID
extends RPCRequest

Non periodic vehicle data read request. This is an RPC to get diagnostics data from certain vehicle modules. DIDs of a certain module might differ from vehicle type to vehicle type

Function Group: ProprietaryData

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
ecuName	Integer	Name of ECU.	Y	Minvalue: 0; Maxvalue: 65535	SmartDeviceLink 2.0
didLocation	Integer	Get raw data from vehicle data DID location(s).	Y	Minvalue: 0; Maxvalue: 65535	SmartDeviceLink 2.0
appID	Integer	ID of the application that requested this RPC.	Y		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

TRUNCATED_DATA

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DID_LOCATION
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
ReadDID() Constructs a new ReadDID object
ReadDID(Hashtable<String,Object> hash) Constructs a new ReadDID object indicated by the Hashtable parameter
ReadDID(Integer ecuName, List<Integer> didLocation) Constructs a new ReadDID object

Method Summary

Modifier and Type	Method and Description
List<Integer>	getDidLocation() Gets raw data from vehicle data DID location(s)
Integer	getEcuName() Gets the ID of the vehicle module
ReadDID	setDidLocation(List<Integer> didLocation) Sets raw data from vehicle data DID location(s)
ReadDID	setEcuName(Integer ecuName) Sets an ID of the vehicle module

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_ECU_NAME

public static final String KEY_ECU_NAME

See Also:

Constant Field Values

KEY_DID_LOCATION

public static final String KEY_DID_LOCATION

See Also:

Constant Field Values

Constructor Detail

ReadDID

public ReadDID()

Constructs a new ReadDID object

ReadDID

public ReadDID(Hashtable<String,Object> hash)

Constructs a new ReadDID object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ReadDID

public ReadDID(@NonNull
               Integer ecuName,
               @NonNull
               List<Integer> didLocation)

Constructs a new ReadDID object

Parameters:

ecuName - an Integer value representing the ID of the vehicle module Notes: Minvalue:0; Maxvalue:65535

didLocation - a List value representing raw data from vehicle data DID location(s)
Notes:

• Minvalue:0; Maxvalue:65535
• ArrayMin:0; ArrayMax:1000

Method Detail

setEcuName

public ReadDID setEcuName(@NonNull
                          Integer ecuName)

Sets an ID of the vehicle module

Parameters:

ecuName - an Integer value representing the ID of the vehicle module

Notes: Minvalue:0; Maxvalue:65535

getEcuName

public Integer getEcuName()

Gets the ID of the vehicle module

Returns:

Integer -an Integer value representing the ID of the vehicle module

setDidLocation

public ReadDID setDidLocation(@NonNull
                              List<Integer> didLocation)

Sets raw data from vehicle data DID location(s)

Parameters:

didLocation - a List value representing raw data from vehicle data DID location(s)

Notes:

• Minvalue:0; Maxvalue:65535
• ArrayMin:0; ArrayMax:1000

getDidLocation

public List<Integer> getDidLocation()

Gets raw data from vehicle data DID location(s)

Returns:

List -a List value representing raw data from vehicle data DID location(s)