Skip to content

Commit f36419c

Browse files
committed
Renamed units to unit and fixed KCD extraction
1 parent c9962d1 commit f36419c

9 files changed

Lines changed: 81 additions & 84 deletions

File tree

docs/classes/DatabaseService.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1>DatabaseService Class</h1>
8585

8686

8787
<div class="foundat">
88-
Defined in: <a href="../files/socketcan.js.html#l205"><code>socketcan.js:205</code></a>
88+
Defined in: <a href="../files/socketcan.js.html#l203"><code>socketcan.js:203</code></a>
8989
</div>
9090

9191
Module: <a href="../modules/Signals.html">Signals</a>
@@ -128,7 +128,7 @@ <h3 class="name"><code>DatabaseService</code></h3>
128128
<div class="meta">
129129
<p>
130130
Defined in
131-
<a href="../files/socketcan.js.html#l205"><code>socketcan.js:205</code></a>
131+
<a href="../files/socketcan.js.html#l203"><code>socketcan.js:203</code></a>
132132
</p>
133133

134134

@@ -241,7 +241,7 @@ <h3 class="name"><code>send</code></h3>
241241
<div class="meta">
242242
<p>
243243
Defined in
244-
<a href="../files/socketcan.js.html#l282"><code>socketcan.js:282</code></a>
244+
<a href="../files/socketcan.js.html#l279"><code>socketcan.js:279</code></a>
245245
</p>
246246

247247

@@ -296,7 +296,7 @@ <h3 class="name"><code>messages</code></h3>
296296
<div class="meta">
297297
<p>
298298
Defined in
299-
<a href="../files/socketcan.js.html#l218"><code>socketcan.js:218</code></a>
299+
<a href="../files/socketcan.js.html#l216"><code>socketcan.js:216</code></a>
300300
</p>
301301

302302

docs/classes/Message.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1>Message Class</h1>
8585

8686

8787
<div class="foundat">
88-
Defined in: <a href="../files/socketcan.js.html#l136"><code>socketcan.js:136</code></a>
88+
Defined in: <a href="../files/socketcan.js.html#l134"><code>socketcan.js:134</code></a>
8989
</div>
9090

9191
Module: <a href="../modules/Signals.html">Signals</a>
@@ -163,7 +163,7 @@ <h3 class="name"><code>ext</code></h3>
163163
<div class="meta">
164164
<p>
165165
Defined in
166-
<a href="../files/socketcan.js.html#l149"><code>socketcan.js:149</code></a>
166+
<a href="../files/socketcan.js.html#l147"><code>socketcan.js:147</code></a>
167167
</p>
168168

169169

@@ -193,7 +193,7 @@ <h3 class="name"><code>id</code></h3>
193193
<div class="meta">
194194
<p>
195195
Defined in
196-
<a href="../files/socketcan.js.html#l142"><code>socketcan.js:142</code></a>
196+
<a href="../files/socketcan.js.html#l140"><code>socketcan.js:140</code></a>
197197
</p>
198198

199199

@@ -223,7 +223,7 @@ <h3 class="name"><code>interval</code></h3>
223223
<div class="meta">
224224
<p>
225225
Defined in
226-
<a href="../files/socketcan.js.html#l171"><code>socketcan.js:171</code></a>
226+
<a href="../files/socketcan.js.html#l169"><code>socketcan.js:169</code></a>
227227
</p>
228228

229229

@@ -253,7 +253,7 @@ <h3 class="name"><code>len</code></h3>
253253
<div class="meta">
254254
<p>
255255
Defined in
256-
<a href="../files/socketcan.js.html#l163"><code>socketcan.js:163</code></a>
256+
<a href="../files/socketcan.js.html#l161"><code>socketcan.js:161</code></a>
257257
</p>
258258

259259

@@ -283,7 +283,7 @@ <h3 class="name"><code>muxed</code></h3>
283283
<div class="meta">
284284
<p>
285285
Defined in
286-
<a href="../files/socketcan.js.html#l179"><code>socketcan.js:179</code></a>
286+
<a href="../files/socketcan.js.html#l177"><code>socketcan.js:177</code></a>
287287
</p>
288288

289289

@@ -313,7 +313,7 @@ <h3 class="name"><code>name</code></h3>
313313
<div class="meta">
314314
<p>
315315
Defined in
316-
<a href="../files/socketcan.js.html#l156"><code>socketcan.js:156</code></a>
316+
<a href="../files/socketcan.js.html#l154"><code>socketcan.js:154</code></a>
317317
</p>
318318

319319

@@ -343,7 +343,7 @@ <h3 class="name"><code>signals</code></h3>
343343
<div class="meta">
344344
<p>
345345
Defined in
346-
<a href="../files/socketcan.js.html#l187"><code>socketcan.js:187</code></a>
346+
<a href="../files/socketcan.js.html#l185"><code>socketcan.js:185</code></a>
347347
</p>
348348

349349

docs/classes/Signal.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ <h3 class="name"><code>onChange</code></h3>
166166
<div class="meta">
167167
<p>
168168
Defined in
169-
<a href="../files/socketcan.js.html#l97"><code>socketcan.js:97</code></a>
169+
<a href="../files/socketcan.js.html#l95"><code>socketcan.js:95</code></a>
170170
</p>
171171

172172

@@ -220,7 +220,7 @@ <h3 class="name"><code>update</code></h3>
220220
<div class="meta">
221221
<p>
222222
Defined in
223-
<a href="../files/socketcan.js.html#l107"><code>socketcan.js:107</code></a>
223+
<a href="../files/socketcan.js.html#l105"><code>socketcan.js:105</code></a>
224224
</p>
225225

226226

docs/classes/exports.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h3 class="name"><code>parseNetworkDescription</code></h3>
217217
<div class="meta">
218218
<p>
219219
Defined in
220-
<a href="../files/socketcan.js.html#l346"><code>socketcan.js:346</code></a>
220+
<a href="../files/socketcan.js.html#l343"><code>socketcan.js:343</code></a>
221221
</p>
222222

223223

docs/data.json

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"namespaces": {},
3939
"tag": "module",
4040
"file": "socketcan.js",
41-
"line": 205,
41+
"line": 203,
4242
"description": "The Signals modules provides an interface to access the values/signals\nencoded in CAN messages."
4343
}
4444
},
@@ -78,7 +78,7 @@
7878
"module": "Signals",
7979
"namespace": "",
8080
"file": "socketcan.js",
81-
"line": 136,
81+
"line": 134,
8282
"description": "Just a container to keep the Signals."
8383
},
8484
"DatabaseService": {
@@ -92,7 +92,7 @@
9292
"module": "Signals",
9393
"namespace": "",
9494
"file": "socketcan.js",
95-
"line": 205,
95+
"line": 203,
9696
"description": "A DatabaseService is usually generated once per bus to collect signals\ncoded in the CAN messages according a DB description.",
9797
"is_constructor": 1,
9898
"params": [
@@ -166,7 +166,7 @@
166166
},
167167
{
168168
"file": "socketcan.js",
169-
"line": 97,
169+
"line": 95,
170170
"description": "Keep track of listeners who want to be notified if this signal changes",
171171
"itemtype": "method",
172172
"name": "onChange",
@@ -181,7 +181,7 @@
181181
},
182182
{
183183
"file": "socketcan.js",
184-
"line": 107,
184+
"line": 105,
185185
"description": "Set new value of this signal. Any local registered clients will\nreceive a notification. Please note, no CAN message is actually\nsend to the bus (@see DatabaseServer::send)",
186186
"itemtype": "method",
187187
"name": "update",
@@ -197,7 +197,7 @@
197197
},
198198
{
199199
"file": "socketcan.js",
200-
"line": 142,
200+
"line": 140,
201201
"description": "CAN identifier",
202202
"itemtype": "attribute",
203203
"name": "id",
@@ -207,7 +207,7 @@
207207
},
208208
{
209209
"file": "socketcan.js",
210-
"line": 149,
210+
"line": 147,
211211
"description": "Extended Frame Format used",
212212
"itemtype": "attribute",
213213
"name": "ext",
@@ -217,7 +217,7 @@
217217
},
218218
{
219219
"file": "socketcan.js",
220-
"line": 156,
220+
"line": 154,
221221
"description": "Symbolic name",
222222
"itemtype": "attribute",
223223
"name": "name",
@@ -227,7 +227,7 @@
227227
},
228228
{
229229
"file": "socketcan.js",
230-
"line": 163,
230+
"line": 161,
231231
"description": "Length in bytes of resulting CAN message",
232232
"itemtype": "attribute",
233233
"name": "len",
@@ -237,7 +237,7 @@
237237
},
238238
{
239239
"file": "socketcan.js",
240-
"line": 171,
240+
"line": 169,
241241
"description": "This is the time frame that the message gets generated",
242242
"itemtype": "attribute",
243243
"name": "interval",
@@ -247,7 +247,7 @@
247247
},
248248
{
249249
"file": "socketcan.js",
250-
"line": 179,
250+
"line": 177,
251251
"description": "This is tells us the message is mutliplexed.",
252252
"itemtype": "attribute",
253253
"name": "muxed",
@@ -257,7 +257,7 @@
257257
},
258258
{
259259
"file": "socketcan.js",
260-
"line": 187,
260+
"line": 185,
261261
"description": "Named array of signals within this message. Accessible via index and name.",
262262
"itemtype": "attribute",
263263
"name": "signals",
@@ -268,7 +268,7 @@
268268
},
269269
{
270270
"file": "socketcan.js",
271-
"line": 218,
271+
"line": 216,
272272
"description": "Named array of known messages. Accessible via index and name.",
273273
"itemtype": "attribute",
274274
"name": "messages",
@@ -278,7 +278,7 @@
278278
},
279279
{
280280
"file": "socketcan.js",
281-
"line": 282,
281+
"line": 279,
282282
"description": "Construct a CAN message and encode all related signals according\nthe rules. Finally send the message to the bus.",
283283
"itemtype": "method",
284284
"name": "send",
@@ -293,7 +293,7 @@
293293
},
294294
{
295295
"file": "socketcan.js",
296-
"line": 346,
296+
"line": 343,
297297
"itemtype": "method",
298298
"name": "parseNetworkDescription",
299299
"params": [

docs/files/socketcan.js.html

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ <h1 class="file-heading">File: socketcan.js</h1>
155155
this.minValue = desc[&#x27;minValue&#x27;];
156156
this.maxValue = desc[&#x27;maxValue&#x27;];
157157

158-
this.units = desc[&#x27;units&#x27;];
158+
this.unit = desc[&#x27;unit&#x27;];
159159

160160
/**
161161
* Label set for defined states of the signal.
@@ -173,9 +173,7 @@ <h1 class="file-heading">File: socketcan.js</h1>
173173
* @attribute value
174174
* @final
175175
*/
176-
this.value = desc[&#x27;defaultValue&#x27;];
177-
if (!this.value)
178-
this.value = 0;
176+
this.value = null;
179177

180178
this.listeners = [];
181179
}
@@ -333,7 +331,6 @@ <h1 class="file-heading">File: socketcan.js</h1>
333331

334332
if (!m)
335333
{
336-
console.log(&quot;Message ID &quot; + msg.id + &quot; not found&quot;);
337334
return;
338335
}
339336

docs/modules/Signals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1>Signals Module</h1>
8585

8686

8787
<div class="foundat">
88-
Defined in: <a href="../files/socketcan.js.html#l205"><code>socketcan.js:205</code></a>
88+
Defined in: <a href="../files/socketcan.js.html#l203"><code>socketcan.js:203</code></a>
8989
</div>
9090

9191
</div>

0 commit comments

Comments
 (0)