Modules Manager Helper class.
Offers methods for filtering, selecting and operate on a group of modules.
Class instance accessor: Modules More...

Inheritance diagram for ModulesManager:

Public Member Functions
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
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

Modules Manager Helper class.
Offers methods for filtering, selecting and operate on a group of modules.
Class instance accessor: Modules

Member Function Documentation

◆ InDomain()

ModulesManager InDomain ( string domains )

Select modules belonging to specified domains.

Returns: ModulesManager

Parameters

domains A string containing comma seperated domain names.

Example:

// turn off all z-wave lights
Modules
    .InDomain("HomeAutomation.ZWave")
    .OfDeviceType("Light,Dimmer")
    .Off();

◆ WithAddress()

ModulesManager WithAddress ( string addresses )

Select modules with specified address.

Returns: ModulesManager

Parameters

addresses A string containing comma seperated address values.

Example:

// turn on X10 units A2 and B5

Modules.WithAddress("A2,B5").On();

◆ WithName()

ModulesManager WithName ( string moduleNames )

Select modules matching specified names.

Returns: ModulesManager

Parameters

moduleNames A string containing comma seperated module names.

Example:

// turn off ceiling light

Modules.WithName("Ceiling Light").Off();

◆ OfDeviceType()

ModulesManager OfDeviceType ( string deviceTypes )

Select modules of specified device types.

Returns: ModulesManager

Parameters

deviceTypes A string containing comma seperated type names.

Example:

// turn on all lights and appliances

Modules.OfDeviceType("Light,Dimmer,Switch").On();

◆ InGroup()

ModulesManager InGroup ( string groups )

Select modules included in specified groups.

Returns: ModulesManager

Parameters

groups A string containing comma seperated group names.

Example:

Modules.InGroup("Living Room,Kitchen").Off();

◆ WithParameter()

ModulesManager WithParameter ( string parameters )

Select all modules having specified parameters.

Returns: ModulesManager

Parameters

parameters A string containing comma seperated parameter names.

Example:

// select all modules with Sensor.Temperature parameter and get the average temperature value
var averagetemperature = Modules.WithParameter("Sensor.Temperature").Temperature;
Program.Notify("Average Temperature", averagetemperature);

◆ WithFeature()

ModulesManager WithFeature ( string features )

Select all modules having specified features.

Returns: ModulesManager

Parameters

features A string containing comma separated feature names.

Example:

// Turn on all Security System sirens

Modules.WithFeature("HomeGenie.SecurityAlarm").On();

◆ WithoutFeature()

ModulesManager WithoutFeature ( string features )

Select all modules NOT having specified features.

Returns: ModulesManager

Parameters

features A string containing comma seperated feature names.

Example:

// Turn off all modules not having the "EnergySavingMode" feature

Modules.WithoutFeature("EnergyManagement.EnergySavingMode").Off();

◆ Each()

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.

Parameters

callback Callback function to call for each iteration.

Returns: ModulesManager

Example:

var total_watts_load = 0D;
Modules.WithParameter("Meter.Watts").Each( (module) => {
            total_watts_load += module.Parameter("Meter.Watts").DecimalValue;
            return false; // continue iterating
});
Program.Notify("Current power load", total_watts_load + " watts");

◆ Get()

ModuleHelper Get ( )

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

Returns: ModuleHelper

Example:

var strobeAlarm = Modules.WithName("Strobe Alarm").Get(); <br>

◆ Command()

ModulesManager Command ( string cmd )

Select an API command to be executed for selected modules. To perform the selected command, Submit method must be called.

Returns: ModulesManager

Parameters

cmd	API command to be performed.

Example:

// turn on all modues of "Light" type
Modules.OfDeviceType("Light").Command("Control.On").Execute();
// set all dimmers to 50%
Modules.OfDeviceType("Dimmer").Command("Control.Level").Submit("50");

◆ IterationDelay()

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.

Returns: ModulesManager

Parameters

delaySeconds Delay seconds.

Example:

// Set the level of all dimmer type modules to 40%, 
// putting a 100ms delay between each command
Modules
    .OfDeviceType("Dimmer")
    .Command("Control.Level")
    .IterationDelay(0.1)
    .Submit("40");

◆ GetValue()

object GetValue ( string options = "" )

Execute current command on first selected module and return the response value.

Parameters

options Options.

◆ Submit() [1/2]

ModulesManager Submit ( Action< Module, object > callback )

Submits the command previously specified with Command method.

Parameters

callback Optional callback that will be called, for each module in the selection, with the result of the issued command.

Returns: ModulesManager

◆ Submit() [2/2]

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.

Parameters

options	A string containing a slash separated list of options to be passed to the selected command.
callback	Optional callback that will be called, for each module in the selection, with the result of the issued command.

Returns: ModulesManager

◆ On()

ModulesManager On ( )

Turn on all selected modules.

Returns: ModulesManager

◆ Off()

ModulesManager Off ( )

Turn off all selected modules.

Returns: ModulesManager

◆ Toggle()

ModulesManager Toggle ( )

Toggle all selected modules.

Returns: ModulesManager

◆ Copy()

ModulesManager Copy ( )

Creates a copy of the actual modules selection.

Returns: ModulesManager

◆ Reset()

ModulesManager Reset ( )

Resets all selection filters.

Returns: ModulesManager

Property Documentation

◆ ModulesListCallback

Func<ModulesManager,TsList<Module> > ModulesListCallback

getset

Gets or sets the modules list on which this helper class will be working on.

The modules list callback.

◆ Modules

TsList<Module> Modules

get

Gets the complete modules list.

The modules.

◆ SelectedModules

virtual TsList<Module> SelectedModules

get

Return the list of selected modules.

Returns: List<Module>

◆ Groups

List<string> Groups

get

Return the list of control groups.

Returns: List<string>

◆ Level

double Level

getset

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.

The level (percentage value 0.00-1.00).

Example:

// Set the level of all modules with EnergySavingMode flag enabled to 45%

Modules.WithFeature("EnergyManagement.EnergySavingMode").Level = 0.45;

◆ ColorHsb

string ColorHsb

getset

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.

The HSB color string (eg. "0.3130718,0.986,0.65").

◆ IsOn

bool IsOn

get

Gets "on" status ("Status.Level" > 0).

true if at least one module in the current selection is on; otherwise, false.

◆ IsOff

bool IsOff

get

Gets "off" status ("Status.Level" == 0).

true if at least one module in the current selection is off; otherwise, false.

◆ Alarmed

bool Alarmed

get

Gets "alarm" status ("Sensor.Alarm" > 0).

true if at least one module in the current is alarmed; otherwise, false.

◆ MotionDetected

bool MotionDetected

get

Gets "motion detection" status ("Sensor.MotionDetect" > 0).

true if at least one module in the current detected motion; otherwise, false.

◆ Temperature

double Temperature

get

Gets temperature value ("Sensor.Temperature").

The temperature parameter of selected module (average value is returned when more than one module is selected).

◆ Luminance

double Luminance

get

Gets luminance value ("Sensor.Luminance").

The luminance parameter of selected module (average value is returned when more than one module is selected).

◆ Humidity

double Humidity

get

Gets humidity value ("Sensor.Humidity").

The humidity parameter of selected module (average value is returned when more than one module is selected).

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

ModulesManager.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ InDomain()

◆ WithAddress()

◆ WithName()

◆ OfDeviceType()

◆ InGroup()

◆ WithParameter()

◆ WithFeature()

◆ WithoutFeature()

◆ Each()

◆ Get()

◆ Command()

◆ IterationDelay()

◆ GetValue()

◆ Submit() [1/2]

◆ Submit() [2/2]

◆ On()

◆ Off()

◆ Toggle()

◆ Copy()

◆ Reset()

Property Documentation

◆ ModulesListCallback

◆ Modules

◆ SelectedModules

◆ Groups

◆ Level

◆ ColorHsb

◆ IsOn

◆ IsOff

◆ Alarmed

◆ MotionDetected

◆ Temperature

◆ Luminance

◆ Humidity