summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLGetDTCs.html
blob: 783fca605c3117eca1e98e581ac4709efff28374 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<h1>SDLGetDTCs Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithECUName:">-initWithECUName:</a></li>
  <li><a href="#section--initWithECUName:mask:">-initWithECUName:mask:</a></li>
  <li><a href="#section-ecuName">ecuName</a></li>
  <li><a href="#section-dtcMask">dtcMask</a></li>
</ul>

<h3>Overview</h3>

<p>This RPC allows to request diagnostic module trouble codes from a certain
vehicle module
<p>
Function Group: ProprietaryData
<p>
<b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
<p></p>


<section class="section task-group-section">
  <h3 id="section--initWithECUName:">
      -initWithECUName:
  </h3>
  
  <p>Convenience init</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithECUName</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)ecuName">ecuName</a></span> <span class="nv">name</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>name</dt>
      <dd><p>Name of the module to receive the DTC form</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLGetDTCs object</p>
  </div>
  
  <h3 id="section--initWithECUName:mask:">
      -initWithECUName:mask:
  </h3>
  
  <p>Convenience init with all properties</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithECUName</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">name</span> <span class="nf">mask</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">mask</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)ecuName">ecuName</a></span> <span class="nv">name</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</span> <span class="nv">mask</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>name</dt>
      <dd><p>Name of the module to receive the DTC form</p></dd>
      <dt>mask</dt>
      <dd><p>DTC Mask Byte to be sent in diagnostic request to module</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLGetDTCs object</p>
  </div>
  
  <h3 id="section-ecuName">
      ecuName
  </h3>
  
  <p>a name of the module to receive the DTC form
@discussion an NSNumber value representing a name of the module to receive
           the DTC form
           <p>
           <b>Notes: </b>Minvalue:0; Maxvalue:65535</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">ecuName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">ecuName</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-dtcMask">
      dtcMask
  </h3>
  
  <p>DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">dtcMask</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">dtcMask</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>