|
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
|
<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>EMDeviceBasicDescription Class Reference</title>
<meta id="xcode-display" name="xcode-display" content="render"/>
<meta name="viewport" content="width=550" />
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<div id="em-wrapper">
<style>
#utility_bar
{
position: relative;
height: 35px;
/*background: #231f20 url(../images/bg_tagline.png) no-repeat right
center;*/
background: #231f20 url(http://www.emmoco.com/images/bg_tagline.png) no-repeat right center;
color: #efefef;
overflow: hidden;
padding-left: 10px;
}
#utility_bar p
{
margin-top: 9px;
margin-bottom: 0;
}
#utility_bar a
{
color: #efefef;
margin-right: 15px;
padding: 2px;
}
#utility_bar a:hover
{
color: #fff;
}
#utility_bar a.selected
{
text-decoration: none;
background-color: #555;
}
</style>
<!-- begin utility bar -->
<div id="utility_bar">
<!-- user info / logout link -->
<p>
<a href="http://em-hub.com/">Em-Hub</a>
<a href="http://wiki.emmoco.com/">Wiki</a>
<a href="http://android.emmoco.com/">Android Docs</a>
<a class="selected" href="http://ios.emmoco.com/">iOS Docs</a>
<a href="http://support.emmoco.com/">Support</a>
</p>
</div>
<!-- end utility bar -->
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">iOS Framework </a></h1>
<a id="developerHome" href="../index.html">Emmoco, Inc.</a>
</div>
<div id="title" role="banner">
<h1 class="hideInXcode">EMDeviceBasicDescription Class Reference</h1>
</div>
<ul id="headerButtons" role="toolbar">
<li id="toc_button">
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
</li>
<li id="jumpto_button" role="navigation">
<select id="jumpTo">
<option value="top">Jump To…</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<option value="properties">Properties</option>
<option value="//api/name/advertiseData"> advertiseData</option>
<option value="//api/name/advertiseObject"> advertiseObject</option>
<option value="//api/name/connectionType"> connectionType</option>
<option value="//api/name/name"> name</option>
<option value="//api/name/schemaFilePath"> schemaFilePath</option>
<option value="//api/name/shortSchemaHash"> shortSchemaHash</option>
<option value="//api/name/signalStrength"> signalStrength</option>
<option value="//api/name/signalStrengthFilter"> signalStrengthFilter</option>
</select>
</li>
</ul>
</header>
<nav id="tocContainer" class="isShowingTOC">
<ul id="toc" role="tree">
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
</ul></li>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/advertiseData">advertiseData</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/advertiseObject">advertiseObject</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectionType">connectionType</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/name">name</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/schemaFilePath">schemaFilePath</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shortSchemaHash">shortSchemaHash</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/signalStrength">signalStrength</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/signalStrengthFilter">signalStrengthFilter</a></span></li>
</ul></li>
</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="EMDeviceBasicDescription Class Reference" name="top"></a>
<div class="main-navigation navigation-top">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">EMDeviceBasicDescription Class Reference</h1>
</div>
</div>
<div id="container">
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Inherits from</td>
<td class="specification-value">NSObject</td>
</tr><tr>
<td class="specification-title">Declared in</td>
<td class="specification-value">EMDeviceBasicDescription.h<br />EMDeviceBasicDescription.m</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>EMDeviceBasicDescription is a class used to describe basic device characteristics throughout the entire framework.
All devices, regardless of connection type, will have these properties.</p>
<p>All classes implementing the <a href="../Protocols/EMConnectionType.html">EMConnectionType</a> protocol will receive and deliver device information in the form of an EMDeviceBasicDescription.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<h2 class="subtitle subtitle-tasks">Tasks</h2>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/name"> name</a></code>
<span class="tooltip"><p>The name of the device used thoughout the framework.
Like the unique_identifier, this property needs to be unique.</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/connectionType"> connectionType</a></code>
<span class="tooltip"><p>A concrete <a href="../Protocols/EMConnectionType.html">EMConnectionType</a> instance that will be used to send messages to the device.</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/signalStrength"> signalStrength</a></code>
<span class="tooltip"><p>A value between -100 and 0 used to describe signal strength.</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/signalStrengthFilter"> signalStrengthFilter</a></code>
<span class="tooltip"><p>The signal strength filter for smoothing</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/advertiseData"> advertiseData</a></code>
<span class="tooltip"><p>Data that was discovered along with the device.
Ex: When dealing with bluetooth, this is the advertising packet data</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/advertiseObject"> advertiseObject</a></code>
<span class="tooltip"><p>An object taken from the advertise data based on the advertise resource in the device’s schema
Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/shortSchemaHash"> shortSchemaHash</a></code>
<span class="tooltip"><p>The first six characters of the device’s schema</p></span>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/schemaFilePath"> schemaFilePath</a></code>
<span class="tooltip"><p>The <a href="#//api/name/name">name</a> of the schema file in your bundle that relates to this device.
NOTE: Many devices do not broadcast this information. In this case, this property will not be set</p></span>
</span>
<span class="task-item-suffix">property</span>
</li>
</ul>
</div>
<div class="section section-methods">
<a title="Properties" name="properties"></a>
<h2 class="subtitle subtitle-methods">Properties</h2>
<div class="section-method">
<a name="//api/name/advertiseData" title="advertiseData"></a>
<h3 class="subsubtitle method-title">advertiseData</h3>
<div class="method-subsection brief-description">
<p>Data that was discovered along with the device.
Ex: When dealing with bluetooth, this is the advertising packet data</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSData *advertiseData</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Data that was discovered along with the device.
Ex: When dealing with bluetooth, this is the advertising packet data</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/advertiseObject" title="advertiseObject"></a>
<h3 class="subsubtitle method-title">advertiseObject</h3>
<div class="method-subsection brief-description">
<p>An object taken from the advertise data based on the advertise resource in the device’s schema
Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) id advertiseObject</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>An object taken from the advertise data based on the advertise resource in the device’s schema
Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/connectionType" title="connectionType"></a>
<h3 class="subsubtitle method-title">connectionType</h3>
<div class="method-subsection brief-description">
<p>A concrete <a href="../Protocols/EMConnectionType.html">EMConnectionType</a> instance that will be used to send messages to the device.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) id<EMConnectionType> connectionType</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>A concrete <a href="../Protocols/EMConnectionType.html">EMConnectionType</a> instance that will be used to send messages to the device.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/name" title="name"></a>
<h3 class="subsubtitle method-title">name</h3>
<div class="method-subsection brief-description">
<p>The name of the device used thoughout the framework.
Like the unique_identifier, this property needs to be unique.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSString *name</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The name of the device used thoughout the framework.
Like the unique_identifier, this property needs to be unique.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/schemaFilePath" title="schemaFilePath"></a>
<h3 class="subsubtitle method-title">schemaFilePath</h3>
<div class="method-subsection brief-description">
<p>The <a href="#//api/name/name">name</a> of the schema file in your bundle that relates to this device.
NOTE: Many devices do not broadcast this information. In this case, this property will not be set</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSString *schemaFilePath</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The <a href="#//api/name/name">name</a> of the schema file in your bundle that relates to this device.
NOTE: Many devices do not broadcast this information. In this case, this property will not be set</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/shortSchemaHash" title="shortSchemaHash"></a>
<h3 class="subsubtitle method-title">shortSchemaHash</h3>
<div class="method-subsection brief-description">
<p>The first six characters of the device’s schema</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSString *shortSchemaHash</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The first six characters of the device’s schema</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/signalStrength" title="signalStrength"></a>
<h3 class="subsubtitle method-title">signalStrength</h3>
<div class="method-subsection brief-description">
<p>A value between -100 and 0 used to describe signal strength.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic) float signalStrength</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>A value between -100 and 0 used to describe signal strength.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/signalStrengthFilter" title="signalStrengthFilter"></a>
<h3 class="subsubtitle method-title">signalStrengthFilter</h3>
<div class="method-subsection brief-description">
<p>The signal strength filter for smoothing</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) id<EMSignalStrengthFilter> signalStrengthFilter</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The signal strength filter for smoothing</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">EMDeviceBasicDescription.h</code><br />
</div>
</div>
</div>
</div>
<div class="main-navigation navigation-bottom">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="footer">
<hr />
<style>
#em-footer
{
background-color: #fff;
height: 100px;
font-size: 90%;
overflow: hidden;
}
#em-footer_logo_container
{
position: relative;
background-color: #d2d2d2;
height: 70px;
margin-bottom: 3px;
}
#em-footer_logo_container a
{
position: absolute;
right: 7px;
top: 7px;
}
</style>
<!-- begin em-footer -->
<div id="em-footer">
<div id="em-footer_logo_container"><a href="http://www.emmoco.com/"><img
src="http://www.emmoco.com/images/logo_emhub_footer.png"
alt="" width="85" height="57" alt="EMMOCO LOGO" /></a></div>
</div>
<div class="footer-copyright">
<p><span class="copyright">© 2014 Emmoco, Inc.. All rights reserved. (Last updated: 2014-02-20)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>
</div>
</div>
</div>
</article>
<script type="text/javascript">
function jumpToChange()
{
window.location.hash = this.options[this.selectedIndex].value;
}
function toggleTOC()
{
var contents = document.getElementById('contents');
var tocContainer = document.getElementById('tocContainer');
if (this.getAttribute('class') == 'open')
{
this.setAttribute('class', '');
contents.setAttribute('class', '');
tocContainer.setAttribute('class', '');
window.name = "hideTOC";
}
else
{
this.setAttribute('class', 'open');
contents.setAttribute('class', 'isShowingTOC');
tocContainer.setAttribute('class', 'isShowingTOC');
window.name = "";
}
return false;
}
function toggleTOCEntryChildren(e)
{
e.stopPropagation();
var currentClass = this.getAttribute('class');
if (currentClass == 'children') {
this.setAttribute('class', 'children open');
}
else if (currentClass == 'children open') {
this.setAttribute('class', 'children');
}
return false;
}
function tocEntryClick(e)
{
e.stopPropagation();
return true;
}
function init()
{
var selectElement = document.getElementById('jumpTo');
selectElement.addEventListener('change', jumpToChange, false);
var tocButton = document.getElementById('table_of_contents');
tocButton.addEventListener('click', toggleTOC, false);
var taskTreeItem = document.getElementById('task_treeitem');
if (taskTreeItem.getElementsByTagName('li').length > 0)
{
taskTreeItem.setAttribute('class', 'children');
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
}
var tocList = document.getElementById('toc');
var tocEntries = tocList.getElementsByTagName('li');
for (var i = 0; i < tocEntries.length; i++) {
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
}
var tocLinks = tocList.getElementsByTagName('a');
for (var i = 0; i < tocLinks.length; i++) {
tocLinks[i].addEventListener('click', tocEntryClick, false);
}
if (window.name == "hideTOC") {
toggleTOC.call(tocButton);
}
}
window.onload = init;
</script>
</body>
</html>
|