Module Helper class.
This class is a module instance wrapper and it is used as return value of ModulesManager.Get() method. More...

Inheritance diagram for ModuleHelper:

Public Member Functions
bool	Is (string name)
	Determines whether this module has the given name.

bool	IsInDomain (string domain)
	Determines whether this module belongs to the specified domain.

bool	IsInGroup (string groupList)
	Determines whether this module is in the specified groupList.

bool	IsOfDeviceType (string typeList)
	Determines whether this module is of one of the types specified in typeList.

bool	HasFeature (string feature)
	Determines whether this module has the specified feature active.

bool	HasParameter (string parameter)
	Determines whether this module has the specified parameter.

ModuleParameter	Parameter (string parameter)
	Gets the specified module parameter.

ModulesManager	SetParameter (string parameter, string value)
	Sets the value of a parameter and emits associated event.

ModuleHelper	Emit (string parameter, object value, string description="")
	Emits a new parameter value.

Public Member Functions inherited from ModulesManager
ModulesManager	InDomain (string domains)
	Select modules belonging to specified domains.

ModulesManager	WithAddress (string addresses)
	Select modules with specified address.

ModulesManager	WithName (string moduleNames)
	Select modules matching specified names.

ModulesManager	OfDeviceType (string deviceTypes)
	Select modules of specified device types.

ModulesManager	InGroup (string groups)
	Select modules included in specified groups.

ModulesManager	WithParameter (string parameters)
	Select all modules having specified parameters.

ModulesManager	WithFeature (string features)
	Select all modules having specified features.

ModulesManager	WithoutFeature (string features)
	Select all modules NOT having specified features.

ModulesManager	Each (Func< ModuleHelper, bool > callback)
	Iterate through each module in the current selection and pass it to the specified `callback`. To break the iteration, the callback must return true, otherwise false.

ModuleHelper	Get ()
	Returns the module in the current selection. If the current selection contains more than one element, the first element will be returned.

ModulesManager	Command (string cmd)
	Select an API command to be executed for selected modules. To perform the selected command, `Submit` method must be called.

ModulesManager	IterationDelay (double delaySeconds)
	Used before a command (Submit, On, Off, Toggle, ...), it will put a pause after performing the command for each module in the current selection.

object	GetValue (string options="")
	Execute current command on first selected module and return the response value.

ModulesManager	Submit (Action< Module, object > callback)
	Submits the command previously specified with `Command` method.

ModulesManager	Submit (string options, Action< Module, object > callback=null)
	Submits the command previously specified with `Command` method, passing to it the options given by the `options` parameter.

ModulesManager	On ()
	Turn on all selected modules.

ModulesManager	Off ()
	Turn off all selected modules.

ModulesManager	Toggle ()
	Toggle all selected modules.

ModulesManager	Copy ()
	Creates a copy of the actual modules selection.

ModulesManager	Reset ()
	Resets all selection filters.

Properties
bool	Exists `[get]`
	Gets a value indicating whether this HomeGenie.Automation.Scripting.ModuleHelper has a valid module instance.

Module	Instance `[get]`
	Gets the underlying module instance.

Properties inherited from ModulesManager
Func< ModulesManager, TsList< Module > >	ModulesListCallback `[get, set]`
	Gets or sets the modules list on which this helper class will be working on.

TsList< Module >	Modules `[get]`
	Gets the complete modules list.

virtual TsList< Module >	SelectedModules `[get]`
	Return the list of selected modules.

List< string >	Groups `[get]`
	Return the list of control groups.

double	Level `[get, set]`
	Gets or sets "Status.Level" parameter of selected modules. If more than one module is selected, when reading this property the average level value is returned.

string	ColorHsb `[get, set]`
	Gets or sets "Status.ColorHsb" parameter of selected modules. If more than one module is selected, when reading this property the first module color is returned.

bool	IsOn `[get]`
	Gets "on" status ("Status.Level" > 0).

bool	IsOff `[get]`
	Gets "off" status ("Status.Level" == 0).

bool	Alarmed `[get]`
	Gets "alarm" status ("Sensor.Alarm" > 0).

bool	MotionDetected `[get]`
	Gets "motion detection" status ("Sensor.MotionDetect" > 0).

double	Temperature `[get]`
	Gets temperature value ("Sensor.Temperature").

double	Luminance `[get]`
	Gets luminance value ("Sensor.Luminance").

double	Humidity `[get]`
	Gets humidity value ("Sensor.Humidity").

Detailed Description

Module Helper class.
This class is a module instance wrapper and it is used as return value of ModulesManager.Get() method.

Member Function Documentation

◆ Is()

bool Is ( string name )

Determines whether this module has the given name.

Returns: true if this module has the given name; otherwise, false.

Parameters

name Name.

◆ IsInDomain()

bool IsInDomain ( string domain )

Determines whether this module belongs to the specified domain.

Returns: true if this module belongs to the specified domain; otherwise, false.

Parameters

domain Domain.

◆ IsInGroup()

bool IsInGroup ( string groupList )

Determines whether this module is in the specified groupList.

Returns: true if this instance is the specified groupList; otherwise, false.

Parameters

groupList Comma separated group names.

◆ IsOfDeviceType()

bool IsOfDeviceType ( string typeList )

Determines whether this module is of one of the types specified in typeList.

Returns: true if this module is of one of device types specified in typeList; otherwise, false.

Parameters

typeList Comma seprated type list.

◆ HasFeature()

bool HasFeature ( string feature )

Determines whether this module has the specified feature active.

Returns: true if this module has the specified feature active; otherwise, false.

Parameters

feature Feature.

◆ HasParameter()

bool HasParameter ( string parameter )

Determines whether this module has the specified parameter.

Returns: true if this module has the specified parameter; otherwise, false.

Parameters

parameter Parameter.

◆ Parameter()

ModuleParameter Parameter ( string parameter )

Gets the specified module parameter.

Parameters

parameter Parameter.

◆ SetParameter()

ModulesManager SetParameter	(	string	parameter,
		string	value
	)

Sets the value of a parameter and emits associated event.

Parameters

parameter	Parameter name.
value	Value to set.

Returns: ModulesManager

◆ Emit()

ModuleHelper Emit	(	string	parameter,
		object	value,
		string	description = `""`
	)

Emits a new parameter value.

Returns: ModuleHelper.

Parameters

parameter	Parameter name.
value	The new parameter value to set.
description	Event description. (optional)

Property Documentation

◆ Exists

bool Exists

get

Gets a value indicating whether this HomeGenie.Automation.Scripting.ModuleHelper has a valid module instance.

true if module instance is valid; otherwise, false.

◆ Instance

Module Instance

get

Gets the underlying module instance.

The instance.

The documentation for this class was generated from the following file:

ModuleHelper.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Is()

◆ IsInDomain()

◆ IsInGroup()

◆ IsOfDeviceType()

◆ HasFeature()

◆ HasParameter()

◆ Parameter()

◆ SetParameter()

◆ Emit()

Property Documentation

◆ Exists

◆ Instance