Difference between revisions of "Extensions.DiagCom.SetComParameter"
Jump to navigation
Jump to search
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | [[Category:DiagCom]] | + | {{DISPLAYTITLE:OTX '''SetComParameter'''}}[[Category:DiagCom]] |
== Classification == | == Classification == | ||
− | {{ClassificationActivity | SetComParameter | | + | {{ClassificationActivity | SetComParameter | Changes the value of a communication parameter | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Actions|ComParameter related actions]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <br/> [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }} |
− | == | + | |
+ | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | SetComParameter( | + | DiagCom.SetComParameter(ComChannelValue comChannel, StringTerm name, Term value); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
+ | OTX '''SetComParameter''' activity is used to change the value of a communication parameter used by the communication backend. For example, bus timeouts or baud rates can be set using the '''SetComParameter''' node. | ||
+ | {{Note| In case an ODX/MVCI system is used for vehicle communication, the communication parameter names and data types that can be set are defined by the "D-PDU API/ODX communication parameter" specification.}} | ||
+ | {{Note|In case an ODX/MVCI system is used for vehicle communication, this action should implicitly control the LogicalLink State. The state should be adjusted for setting of COM Parameters. This requires state eONLINE.}} | ||
+ | |||
== Properties == | == Properties == | ||
− | == Examples == | + | {| {{TableHeader}} |
+ | {{TableRowPropertiesHeader}} | ||
+ | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Value]] | - | [1] | This element comprises the communication channel where the communication parameter will be modified.}} | ||
+ | {{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element specifies the name of the communication parameter which will be changed.}} | ||
+ | {{TableRowPropertie2| Value | - | [[Term]] | - | [1] | This element specifies the new communication parameter value that will be set.}} | ||
+ | |} | ||
+ | |||
+ | == OTL Examples == | ||
+ | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
+ | /// Local Declarations | ||
+ | |||
+ | DiagCom.ComChannel ComChannel1; | ||
+ | |||
+ | /// Flow | ||
+ | |||
+ | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); | ||
+ | DiagCom.SetComParameter(ComChannel1, "CP_TesterPresentMessage", &012345); | ||
+ | </syntaxhighlight> | ||
+ | |||
== See also == | == See also == | ||
+ | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
+ | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] |
Latest revision as of 10:41, 4 December 2019
Classification
Name | SetComParameter |
Short Description | Changes the value of a communication parameter |
Class | Action |
Extension | OTX DiagCom extension |
Group | ComParameter related actions |
Exceptions | UnknownTargetException TypeMismatchException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
DiagCom.SetComParameter(ComChannelValue comChannel, StringTerm name, Term value);
Description
OTX SetComParameter activity is used to change the value of a communication parameter used by the communication backend. For example, bus timeouts or baud rates can be set using the SetComParameter node.
Properties
Name | Data Type | Class | Default | Cardinality | Description |
ComChannel | ComChannel | Value | - | [1] | This element comprises the communication channel where the communication parameter will be modified. |
Name | String | Term | - | [1] | This element specifies the name of the communication parameter which will be changed. |
Value | - | Term | - | [1] | This element specifies the new communication parameter value that will be set. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagCom.SetComParameter(ComChannel1, "CP_TesterPresentMessage", &012345);