Em-Hub Wiki Android Docs iOS Docs Support

- Index
- Hierarchy

# EMDeviceBasicDescription Class Reference

Inherits from | NSObject
Declared in | EMDeviceBasicDescription.h EMDeviceBasicDescription.m

## Overview

EMDeviceBasicDescription is a class used to describe basic device characteristics throughout the entire framework. All devices, regardless of connection type, will have these properties.

All classes implementing the EMConnectionType protocol will receive and deliver device information in the form of an EMDeviceBasicDescription.

## Tasks

- `name`

  The name of the device used thoughout the framework. Like the unique_identifier, this property needs to be unique.

  property
- `connectionType`

  A concrete EMConnectionType instance that will be used to send messages to the device.

  property
- `signalStrength`

  A value between -100 and 0 used to describe signal strength.

  property
- `signalStrengthFilter`

  The signal strength filter for smoothing

  property
- `advertiseData`

  Data that was discovered along with the device. Ex: When dealing with bluetooth, this is the advertising packet data

  property
- `advertiseObject`

  An object taken from the advertise data based on the advertise resource in the device’s schema Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData

  property
- `shortSchemaHash`

  The first six characters of the device’s schema

  property
- `schemaFilePath`

  The name 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

  property

## Properties

### advertiseData

Data that was discovered along with the device. Ex: When dealing with bluetooth, this is the advertising packet data

`@property (nonatomic, strong) NSData *advertiseData`

#### Discussion

Data that was discovered along with the device. Ex: When dealing with bluetooth, this is the advertising packet data

#### Declared In

`EMDeviceBasicDescription.h`

### advertiseObject

An object taken from the advertise data based on the advertise resource in the device’s schema Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData

`@property (nonatomic, strong) id advertiseObject`

#### Discussion

An object taken from the advertise data based on the advertise resource in the device’s schema Possible classes: NSString, NSNumber, NSDictionary, NSArray, NSData

#### Declared In

`EMDeviceBasicDescription.h`

### connectionType

A concrete EMConnectionType instance that will be used to send messages to the device.

`@property (nonatomic, strong) id<EMConnectionType> connectionType`

#### Discussion

A concrete EMConnectionType instance that will be used to send messages to the device.

#### Declared In

`EMDeviceBasicDescription.h`

### name

The name of the device used thoughout the framework. Like the unique_identifier, this property needs to be unique.

`@property (nonatomic, strong) NSString *name`

#### Discussion

The name of the device used thoughout the framework. Like the unique_identifier, this property needs to be unique.

#### Declared In

`EMDeviceBasicDescription.h`

### schemaFilePath

The name 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

`@property (nonatomic, strong) NSString *schemaFilePath`

#### Discussion

The name 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

#### Declared In

`EMDeviceBasicDescription.h`

### shortSchemaHash

The first six characters of the device’s schema

`@property (nonatomic, strong) NSString *shortSchemaHash`

#### Discussion

The first six characters of the device’s schema

#### Declared In

`EMDeviceBasicDescription.h`

### signalStrength

A value between -100 and 0 used to describe signal strength.

`@property (nonatomic) float signalStrength`

#### Discussion

A value between -100 and 0 used to describe signal strength.

#### Declared In

`EMDeviceBasicDescription.h`

### signalStrengthFilter

The signal strength filter for smoothing

`@property (nonatomic, strong) id<EMSignalStrengthFilter> signalStrengthFilter`

#### Discussion

The signal strength filter for smoothing

#### Declared In

`EMDeviceBasicDescription.h`

- Index
- Hierarchy

© 2014 Emmoco, Inc.. All rights reserved. (Last updated: 2014-02-21)
Generated by appledoc 2.2 (build 961).