|
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.
|
|
ModuleHelper | Emit (string parameter, object value, string description="") |
| Emits a new parameter value.
|
|
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.
|
|
|
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.
|
|
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").
|
|
Module Helper class.
This class is a module instance wrapper and it is used as return value of ModulesManager.Get() method.