Class ReadDID
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
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
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_ECU_NAME
public static final java.lang.String KEY_ECU_NAME
- Constant Value
- "ecuName"
KEY_DID_LOCATION
public static final java.lang.String KEY_DID_LOCATION
- Constant Value
- "didLocation"
Inherited Fields
Constructors
ReadDID()
Constructs a new ReadDID object
public ReadDID()
ReadDID( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new ReadDID object indicated by the Hashtable parameter
public ReadDID(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
ReadDID( Integer ecuName, java.util.List<java.lang.Integer> didLocation )
Constructs a new ReadDID object
public ReadDID(Integer ecuName,java.util.List<java.lang.Integer> didLocation)
Constructor 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
Methods
setEcuName( Integer ecuName )
Sets an ID of the vehicle module
public com.smartdevicelink.proxy.rpc.ReadDID setEcuName(Integer ecuName)
Method Parameters
- ecuName
- an Integer value representing the ID of the vehicle module Notes: Minvalue:0; Maxvalue:65535
getEcuName()
Gets the ID of the vehicle module
public java.lang.Integer getEcuName()
setDidLocation( java.util.List<java.lang.Integer> didLocation )
Sets raw data from vehicle data DID location(s)
public com.smartdevicelink.proxy.rpc.ReadDID setDidLocation(java.util.List<java.lang.Integer> didLocation)
Method Parameters
- didLocation
- a List
value representing raw data from vehicle data DID location(s) Notes: - Minvalue:0; Maxvalue:65535
- ArrayMin:0; ArrayMax:1000
getDidLocation()
Gets raw data from vehicle data DID location(s)
public java.util.List getDidLocation()
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 |