The Device Class

Property

Type

Description

can_dim

boolean

This will be TRUE if the device is dimmable.

dc

string

The device code as a string (i.e., "1").

hc

string

The house code as string (i.e., "A").

location

string

This property describes the location of the device.

location2

string

This is an additional device location descriptor property.

dev_type_string

string

This property is the name of the last device type chosen for this device.

name

string

This is the name of the device.

ref

long

This is a device reference used internally and is unique for every device.  Events hold this as a reference to the device.  If the device is deleted, all events that reference the device will no longer control it.

status_support

boolean

This will be TRUE if the device supports the X10 status request command.

misc

long

This is a bit field that holds various properties for the device. The field is a long value. Set the appropriate bits to 1 to enable the feature.  The bits are defined as:

• &h1 = The device supports the X10 preset dim command.

• &h2 = The device supports the X10 Extended dim command.

• &h4 = This is a SmartLinc switch.

• &h8 = No logging changes to this device are recorded in the HomeSeer log.

• &h10 = This is a status-only device (cannot be controlled).

• &h20 = The device is hidden from views.

• &h40 = This device is a thermostat.

• &h80 = Include this device in the power fail feature (the device's state is restored in the event of a power failure).

• &h100 = Value names are selectable from the Control screen (values are assigned with hs.DeviceValuesAdd).

• &h200 = Create voice command(s) context to operate this device.

• &h400 = Voice commands must be confirmed for this device.

• &h800 = The device uses the Compose preset-dim protocol.

• &h1000 = This device is a Z-Wave device.

• &h2000 = This device supports direct-level dimming other than preset dim, extended data, or Z-Wave.

• &h4000 = This device, when its status is changed, should call SetIO/SetIOEx in the plug-in that owns it.

• &h8000 = This device, when its value is changed, should call SetIO/SetIOEx in the plug-in that owns it.

• &h10000 = If set, this device will only allow ON and OFF actions in the event properties

• &h20000 = If set, this device will not appear in the device status change trigger list or the device condition list.

values

string

This property holds the name/value pairs as added with the hs.DeviceValueAdd function.  See the plug-in SDK for more information.
 

buttons

string

This property holds information about buttons added with hs.DeviceButtonAdd.  See the plug-in SDK for more information.
 

graphics

string

This property holds information about graphics associated with device values.  See the plug-in SDK for more information.

UserNote

string

This property holds information that the user wishes to associate with this device.