Class FeatureFactory

C#
Visual Basic

public class FeatureFactory

Inheritance

System.Object

FeatureFactory

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: HomeSeer.PluginSdk.Devices

Assembly: PluginSdk.dll

Factory class for defining new HsFeatures for HomeSeer

Fields

View Source

_feature

HsFeature _feature

Field Value

Type	Description
HsFeature

Properties

View Source

Feature

Declaration

C#
Visual Basic

HsFeature Feature { }

Property Value

Type	Description
HsFeature

Methods

View Source

AddButton(Double, String, ControlLocation, EControlUse)

Add a button to the HsFeature.

Declaration

C#
Visual Basic

public FeatureFactory AddButton(double targetValue, string targetStatus, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddButton(targetValue As Double, targetStatus As String, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Double	targetValue	The unique value associated with this control.
System.String	targetStatus	The text displayed on the button.
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with a new StatusControl added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `targetStatus` is empty or whitespace.
System.ArgumentException	Thrown when a control, targeting the specified `targetValue`, already exists.

AddColorPicker(ControlLocation, EControlUse)

Deprecated

Declaration

C#
Visual Basic

[Obsolete("This signature has been deprecated. Use one of the new signatures.", true)]
public FeatureFactory AddColorPicker(ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

<Obsolete("This signature has been deprecated. Use one of the new signatures.", True)>
Public Function AddColorPicker(location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
ControlLocation	location	The location of the control in the grid
EControlUse	controlUse	The specific use for this control

Returns

Type	Description
FeatureFactory	A FeatureFactory with the new color control added

Exceptions

Type	Condition
System.ArgumentException	Thrown when a control, targeting the specified value, already exists

View Source

AddColorPicker(ValueRange, ControlLocation, EControlUse)

Add a color picker control to the feature

Declaration

C#
Visual Basic

public FeatureFactory AddColorPicker(ValueRange targetRange, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddColorPicker(targetRange As ValueRange, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
ValueRange	targetRange	The values this control occupies on the feature.
ControlLocation	location	The location of the control in the grid
EControlUse	controlUse	The specific use for this control

Returns

Type	Description
FeatureFactory	A FeatureFactory with the new color control added

Remarks

Color pickers do not use the value of the feature to operate. They use a control string; so the targetRange is superficial and does not correspond to the actual selected color.

Exceptions

Type	Condition
System.ArgumentException	Thrown when a control, targeting the specified value, already exists

AddColorPicker(Double, ControlLocation, EControlUse)

Add a color picker control to the feature

Declaration

C#
Visual Basic

public FeatureFactory AddColorPicker(double targetValue, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddColorPicker(targetValue As Double, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Double	targetValue	The value this control occupies on the feature.
ControlLocation	location	The location of the control in the grid
EControlUse	controlUse	The specific use for this control

Returns

Type	Description
FeatureFactory	A FeatureFactory with the new color control added

Remarks

Color pickers do not use the value of the feature to operate. They use a control string; so the targetValue is superficial and does not correspond to the actual selected color. A unique targetValue must still be specified.

Exceptions

Type	Condition
System.ArgumentException	Thrown when a control, targeting the specified value, already exists

AddControl(StatusControl)

Add a StatusControl to the HsFeature being built

Declaration

C#
Visual Basic

public FeatureFactory AddControl(StatusControl statusControl)

Parameters

Type	Name	Description
StatusControl	statusControl	The StatusControl to add.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with an added StatusControl

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `statusControl` is null.
System.ArgumentException	Thrown when a StatusControl for the values targeted by `statusControl` already exists.

View Source

AddGraphic(StatusGraphic)

Add a StatusGraphic to the HsFeature being built

Declaration

C#
Visual Basic

public FeatureFactory AddGraphic(StatusGraphic statusGraphic)

Parameters

Type	Name	Description
StatusGraphic	statusGraphic	The StatusGraphic to add.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with an added StatusGraphic

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `statusGraphic` is null.
System.ArgumentException	Thrown when a StatusGraphic for the values targeted by `statusGraphic` already exists.

View Source

AddGraphicForRange(String, Double, Double, String)

Add a StatusGraphic that targets a range of values to the HsFeature being built

Declaration

C#
Visual Basic

public FeatureFactory AddGraphicForRange(string imagePath, double minValue, double maxValue, string statusText = "")

Parameters

Type	Name	Description
System.String	imagePath	A path to an image file relative to the HomeSeer root directory
System.Double	minValue	The minimum value handled by the StatusGraphic.
System.Double	maxValue	The maximum value handled by the StatusGraphic
System.String	statusText	The text displayed by the StatusGraphic. Default is a blank string.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with an added StatusGraphic

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `imagePath` is empty or whitespace.
System.ArgumentException	Thrown when a StatusGraphic for a value between `minValue` and `maxValue` already exists.

View Source

AddGraphicForValue(String, Double, String)

Add a StatusGraphic that targets a single value to the HsFeature being built

Declaration

C#
Visual Basic

public FeatureFactory AddGraphicForValue(string imagePath, double targetValue, string statusText = "")

Parameters

Type	Name	Description
System.String	imagePath	A path to an image file relative to the HomeSeer root directory
System.Double	targetValue	The Value targeted by the StatusGraphic
System.String	statusText	The text displayed for the `targetValue`. Default is a blank string.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with an added StatusGraphic

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `imagePath` is empty or whitespace.
System.ArgumentException	Thrown when a StatusGraphic for the `targetValue` already exists.

View Source

AddNumberInputField(Double, String, ControlLocation, EControlUse)

Add a number input field to the HsFeature.

Declaration

C#
Visual Basic

public FeatureFactory AddNumberInputField(double targetValue, string hintText, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddNumberInputField(targetValue As Double, hintText As String, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Double	targetValue	The unique value associated with this control.
System.String	hintText	The text displayed to the user to help them know what kind of value to input.
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with a new StatusControl added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `hintText` is empty or whitespace.
System.ArgumentException	Thrown when a control, targeting the specified `targetValue`, already exists.

AddRadioSelectList(SortedDictionary<String, Double>, ControlLocation, EControlUse)

Add a set of radio input controls to the HsFeature

Declaration

C#
Visual Basic

public FeatureFactory AddRadioSelectList(SortedDictionary<string, double> textOptions, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddRadioSelectList(textOptions As SortedDictionary(Of String, Double), location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Collections.Generic.SortedDictionary<System.String, System.Double>	textOptions	A System.Collections.Generic.SortedDictionary<TKey, TValue> of options where the key is the Label and the value is the TargetValue
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with StatusControls with a ControlType of RadioOption added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when no `textOptions` are specified.
System.ArgumentException	Thrown when a control, targeting the specified value, already exists.

AddSlider(ValueRange, ControlLocation, EControlUse)

Add a slider control to the HsFeature.

Declaration

C#
Visual Basic

public FeatureFactory AddSlider(ValueRange targetRange, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddSlider(targetRange As ValueRange, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
ValueRange	targetRange	A ValueRange
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with a new StatusControl added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `targetRange` is null.
System.ArgumentException	Thrown when a control, targeting any of the specified values, already exists.

AddTextDropDown(SortedDictionary<String, Double>, ControlLocation, EControlUse)

Add a select list control to the HsFeature

Declaration

C#
Visual Basic

public FeatureFactory AddTextDropDown(SortedDictionary<string, double> textOptions, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddTextDropDown(textOptions As SortedDictionary(Of String, Double), location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Collections.Generic.SortedDictionary<System.String, System.Double>	textOptions	A System.Collections.Generic.SortedDictionary<TKey, TValue> of options where the key is the Label and the value is the TargetValue
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse. This is applied to all options.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with StatusControls with a ControlType of TextSelectList added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when no `textOptions` are specified.
System.ArgumentException	Thrown when a control, targeting any of the specified values, already exists.

AddTextInputField(Double, String, ControlLocation, EControlUse)

Add a text input field to the HsFeature.

Declaration

C#
Visual Basic

public FeatureFactory AddTextInputField(double targetValue, string hintText, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddTextInputField(targetValue As Double, hintText As String, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
System.Double	targetValue	The unique value associated with this control.
System.String	hintText	The text displayed to the user to help them know what kind of value to input.
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with a new StatusControl added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `hintText` is empty or whitespace.
System.ArgumentException	Thrown when a control, targeting the specified `targetValue`, already exists.

AddValueDropDown(ValueRange, ControlLocation, EControlUse)

Add a select list control to the HsFeature for a range of numbers.

Declaration

C#
Visual Basic

public FeatureFactory AddValueDropDown(ValueRange targetRange, ControlLocation location = null, EControlUse controlUse = EControlUse.NotSpecified)

Public Function AddValueDropDown(targetRange As ValueRange, location As ControlLocation = Nothing, controlUse As EControlUse = EControlUse.NotSpecified) As FeatureFactory

Parameters

Type	Name	Description
ValueRange	targetRange	A ValueRange
ControlLocation	location	The location of the control in the grid. See ControlLocation
EControlUse	controlUse	The specific use for this control. See EControlUse

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with a new StatusControl added

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `targetRange` is null.
System.ArgumentException	Thrown when a control, targeting any of the specified values, already exists.

AsType(EFeatureType, Int32)

Set the TypeInfo of the HsFeature.

Declaration

C#
Visual Basic

public FeatureFactory AsType(EFeatureType featureType, int featureSubType)

Parameters

Type	Name	Description
EFeatureType	featureType	The EFeatureType of the HsFeature
System.Int32	featureSubType	An int value representing a HsFeature sub type. See HomeSeer.PluginSdk.Devices.Identification for enums listed as "FeatureSubType" for current lists.

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with an updated TypeInfo

CreateFeature(String)

Prepare a new feature definition

Declaration

C#
Visual Basic

public static FeatureFactory CreateFeature(string pluginId)

Parameters

Type	Name	Description
System.String	pluginId	The Id of the plugin that owns the new feature

Returns

Type	Description
FeatureFactory	A FeatureFactory containing information about the new feature

Remarks

Make sure to associate this feature with a device before creating it. You can do this with OnDevice(Int32) or PrepareForHsDevice(Int32) if you are creating this feature on its own, or you can add this to a DeviceFactory with WithFeature(FeatureFactory).

View Source

CreateFeature(String, Int32)

Prepare a new feature definition for a specific HsDevice

Declaration

C#
Visual Basic

public static FeatureFactory CreateFeature(string pluginId, int devRef)

Parameters

Type	Name	Description
System.String	pluginId	The Id of the plugin that owns the new feature
System.Int32	devRef	The Ref of the device that should own the new feature

Returns

Type	Description
FeatureFactory	A FeatureFactory containing information about the new feature

View Source

CreateGenericBinaryControl(String, String, String, String, Double, Double)

Create a new generic, binary control feature that has 2 button controls and 2 corresponding status graphics.

Declaration

C#
Visual Basic

public static FeatureFactory CreateGenericBinaryControl(string pluginId, string name, string onText, string offText, double onValue = 1, double offValue = 0)

Public Shared Function CreateGenericBinaryControl(pluginId As String, name As String, onText As String, offText As String, onValue As Double = 1, offValue As Double = 0) As FeatureFactory

Parameters

Type	Name	Description
System.String	pluginId	The Id of the plugin to be used as the interface property
System.String	name	The name of the feature
System.String	onText	The text on the On button
System.String	offText	The text on the Off button
System.Double	onValue	The corresponding value for the On state
System.Double	offValue	The corresponding value for the Off state

Returns

Type	Description
FeatureFactory	A FeatureFactory representing the desired feature

View Source

CreateGenericBinarySensor(String, String, String, String, Double, Double)

Create a new generic, binary sensor feature that has 2 status graphics representing 2 different sensor states.

Declaration

C#
Visual Basic

public static FeatureFactory CreateGenericBinarySensor(string pluginId, string name, string onText, string offText, double onValue = 1, double offValue = 0)

Public Shared Function CreateGenericBinarySensor(pluginId As String, name As String, onText As String, offText As String, onValue As Double = 1, offValue As Double = 0) As FeatureFactory

Parameters

Type	Name	Description
System.String	pluginId	The Id of the plugin to be used as the interface property
System.String	name	The name of the feature
System.String	onText	The text displayed when the status is active
System.String	offText	The text displayed when the status is passive
System.Double	onValue	The corresponding value for the active state
System.Double	offValue	The corresponding value for the passive state

Returns

Type	Description
FeatureFactory	A FeatureFactory representing the desired feature

View Source

OnDevice(Int32)

Associate the feature with a specific HsDevice

Declaration

C#
Visual Basic

public FeatureFactory OnDevice(int devRef)

Parameters

Type	Name	Description
System.Int32	devRef	The Ref of the HsDevice that owns the feature

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with its AssociatedDevices set to link to the desired device

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown if a `devRef` is supplied that is less than or equal to 0

View Source

PrepareForHs()

Prepare the FeatureFactory to be sent to HomeSeer for creation.

Declaration

C#
Visual Basic

public NewFeatureData PrepareForHs()

Returns

Type	Description
NewFeatureData	NewFeatureData ready to be sent to HomeSeer via CreateFeatureForDevice(NewFeatureData)

Remarks

Make sure the HsFeature is associated with a device by calling OnDevice(Int32) to set the owning device prior to calling this method.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown when the HsFeature isn't correctly associated with a device.

PrepareForHsDevice(Int32)

Prepare the FeatureFactory to be sent to HomeSeer and added to a specific device.

Declaration

C#
Visual Basic

public NewFeatureData PrepareForHsDevice(int devRef)

Parameters

Type	Name	Description
System.Int32	devRef	The Ref of the HsDevice the HsFeature is being added to

Returns

Type	Description
NewFeatureData	NewFeatureData ready to be sent to HomeSeer via CreateFeatureForDevice(NewFeatureData)

Remarks

You can either use this to assign the feature to a device as the last step before creation, or you can call OnDevice(Int32) to set the owning device and then PrepareForHs() when you are ready to send it to HomeSeer.

WithAddress(String)

Add an Address to the feature

Declaration

C#
Visual Basic

public FeatureFactory WithAddress(string address)

Parameters

Type	Name	Description
System.String	address	The string to set the address to

Returns

Type	Description
FeatureFactory	The FeatureFactory with the updated address value

View Source

WithDefaultValue(Double)

Set the value the feature is created with

Declaration

C#
Visual Basic

public FeatureFactory WithDefaultValue(double value)

Parameters

Type	Name	Description
System.Double	value	The value the feature should default to when it is created

Returns

Type	Description
FeatureFactory	The FeatureFactory updated with the specified value

View Source

WithDisplayType(EFeatureDisplayType)

Set the DisplayType for the feature

Declaration

C#
Visual Basic

public FeatureFactory WithDisplayType(EFeatureDisplayType displayType)

Parameters

Type	Name	Description
EFeatureDisplayType	displayType	The EFeatureDisplayType to set

Returns

Type	Description
FeatureFactory	The FeatureFactory with the updated display type value

View Source

WithExtraData(PlugExtraData)

Set the PlugExtraData for the HsFeature

Declaration

C#
Visual Basic

public FeatureFactory WithExtraData(PlugExtraData extraData)

Parameters

Type	Name	Description
PlugExtraData	extraData	PlugExtraData to set on the HsFeature

Returns

Type	Description
FeatureFactory	The calling FeatureFactory with the specified PlugExtraData

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `extraData` is null

View Source

WithLocation(String)

Set the Location property on the feature.

Declaration

C#
Visual Basic

public FeatureFactory WithLocation(string location)

Parameters

Type	Name	Description
System.String	location	The location to set on the feature

Returns

Type	Description
FeatureFactory	The FeatureFactory updated with the specified location

Remarks

You should only adjust this if the location on the owning device is insufficient for this feature. This will be a location IN ADDITION to the device location.

View Source

WithLocation2(String)

Set the Location2 property on the feature.

Declaration

C#
Visual Basic

public FeatureFactory WithLocation2(string location2)

Parameters

Type	Name	Description
System.String	location2	The location2 to set on the feature

Returns

Type	Description
FeatureFactory	The FeatureFactory updated with the specified location2

Remarks

You should only adjust this if the location2 on the owning device is insufficient for this feature. This will be a location2 IN ADDITION to the device location2.

View Source

WithMiscFlags(EMiscFlag[])

Add a EMiscFlag to the feature

Declaration

C#
Visual Basic

public FeatureFactory WithMiscFlags(params EMiscFlag[] miscFlags)

Parameters

Type	Name	Description
EMiscFlag[]	miscFlags	EMiscFlag(s) to add

Returns

Type	Description
FeatureFactory	The FeatureFactory updated by adding the specified EMiscFlag(s)

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when no `miscFlags` are specified

View Source

WithName(String)

Set the name of the HsFeature. This sets Name

Declaration

C#
Visual Basic

public FeatureFactory WithName(string name)

Parameters

Type	Name	Description
System.String	name	The name of the feature

Returns

Type	Description
FeatureFactory	The calling FeatureFactory updated with the desired name

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if the `name` is empty or whitespace

View Source

WithoutMiscFlags(EMiscFlag[])

Remove a EMiscFlag from the feature

Declaration

C#
Visual Basic

public FeatureFactory WithoutMiscFlags(params EMiscFlag[] miscFlags)

Parameters

Type	Name	Description
EMiscFlag[]	miscFlags	EMiscFlag(s) to remove

Returns

Type	Description
FeatureFactory	The FeatureFactory updated by removing the specified EMiscFlag(s)

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when no `miscFlags` are specified

Class FeatureFactory

Inheritance

Inherited Members

Namespace: HomeSeer.PluginSdk.Devices

Assembly: PluginSdk.dll

Fields

_feature

Declaration

Field Value

Properties

Feature

Declaration

Property Value

Methods

AddButton(Double, String, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Exceptions

See Also

AddColorPicker(ControlLocation, EControlUse)

Declaration

Parameters

Returns

Exceptions

AddColorPicker(ValueRange, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

AddColorPicker(Double, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

AddControl(StatusControl)

Declaration

Parameters

Returns

Exceptions

AddGraphic(StatusGraphic)

Declaration

Parameters

Returns

Exceptions

AddGraphicForRange(String, Double, Double, String)

Declaration

Parameters

Returns

Exceptions

AddGraphicForValue(String, Double, String)

Declaration

Parameters

Returns

Exceptions

AddNumberInputField(Double, String, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Exceptions

See Also

AddRadioSelectList(SortedDictionary<String, Double>, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Exceptions

See Also

AddSlider(ValueRange, ControlLocation, EControlUse)

Declaration

Parameters

Returns

Exceptions

See Also

AddTextDropDown(SortedDictionary<String, Double>, ControlLocation, EControlUse)

Declaration

Parameters