Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class DiagnosticMessage

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 diagnostic request.

Parameter List

Name Type Description Reg. Notes Version
targetID Integer Name of target ECU. Y Min Value: 0; Max Value: 65535 SmartDeviceLink 3.0
messageLength Integer Length of message (in bytes). Y Min Value: 0; Max Value:65535 SmartDeviceLink 3.0
messageData Integer Array of bytes comprising CAN message. Y Min Value: 0; Max Value:255; Min Size:1; Max Size:65535 SmartDeviceLink 3.0

HMI must:

1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.

2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.

Fields

KEY_TARGET_ID

public static final java.lang.String KEY_TARGET_ID
Constant Value
"targetID"

KEY_MESSAGE_LENGTH

public static final java.lang.String KEY_MESSAGE_LENGTH
Constant Value
"messageLength"

KEY_MESSAGE_DATA

public static final java.lang.String KEY_MESSAGE_DATA
Constant Value
"messageData"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DiagnosticMessage()

Constructs a new DiagnosticMessage object

public DiagnosticMessage()

DiagnosticMessage( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new DiagnosticMessage object indicated by the Hashtable parameter

public DiagnosticMessage(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

DiagnosticMessage( Integer targetID, Integer messageLength, java.util.List<java.lang.Integer> messageData )

Constructs a new DiagnosticMessage object

public DiagnosticMessage(Integer targetID,Integer messageLength,java.util.List<java.lang.Integer> messageData)

Parameters

targetID
messageLength
messageData

Methods

setTargetID( Integer targetID )

public void setTargetID(Integer targetID)

Parameters

targetID

getTargetID()

Returns an Integer object representing the Target ID that you want to add

public java.lang.Integer getTargetID()

setMessageLength( Integer messageLength )

public void setMessageLength(Integer messageLength)

Parameters

messageLength

getMessageLength()

public java.lang.Integer getMessageLength()

getMessageData()

public java.util.List getMessageData()

setMessageData( java.util.List<java.lang.Integer> messageData )

public void setMessageData(java.util.List<java.lang.Integer> messageData)

Parameters

messageData

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section