Namespace HomeSeer.PluginSdk.Devices

Classes

AbstractHsDevice

The base implementation of a HomeSeer device.

Used to represent devices and features as either a HsDevice or HsFeature

DeviceFactory

Factory class for defining new HsDevices for HomeSeer

FeatureFactory

Factory class for defining new HsFeatures for HomeSeer

HsDevice

A device connected to a HomeSeer system. This is the top level item displayed to users when they are looking at the devices connected to their system.

HsFeature

A feature of a device connected to a HomeSeer system. It encapsulates a specific component of functionality available to the device it is associated with.

For example: A battery powered device should have a feature associated with it that handles only battery related information and controls. This feature should not contain anything having to do with any other component of that device.

NewDeviceData

A collection of information describing a new device that needs to be created in HomeSeer.

Created through PrepareForHs()

NewFeatureData

A collection of information describing a new feature that needs to be created in HomeSeer.

Created through PrepareForHs() or PrepareForHsDevice(Int32)

PlugExtraData

A collection of keyed and non-keyed data items attached to an AbstractHsDevice

StatusGraphic

Status graphics are used to specify what image is displayed for a device when its value matches certain criteria

StatusGraphicCollection

A managed collection of StatusGraphics

ValueRange

A range of values that can be targeted by StatusControls and StatusGraphics

Structs

EventUpdateReturnData

Data returned to HomeSeer by a plugin when an event action/trigger's configuration is updated

Enums

EEnergyFeatureSubType

EFeatureDisplayType

The display type for a HsFeature. This controls the way a feature and its controls are displayed in the HomeSeer UI.

EMiscFlag

Various bit flags available to add to AbstractHsDevice's Misc field that control its behavior on the HomeSeer platform.

EPollResponse

Possible responses to the UpdateStatusNow(Int32) call made by HomeSeer to get the latest status for a device/feature.

EProperty

HsDevice and HsFeature property types. Used for communicating device/feature related changed to HomeSeer.