<!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-21)</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>