Program Helper class.
Class instance accessor: Program More...

Inheritance diagram for ProgramHelper:

Public Member Functions
void	Setup (Action functionBlock)
	Execute a setup function when the program is enabled. It is meant to be used in the "Setup Code" to execute only once the instructions contained in the passed function. It is mainly used for setting program configuration fields, parameters and features.

void	Run (bool willRun)
	Run the program as soon as the "Setup Code" exits. This command is meant to be used in the "Setup Code".

ProgramHelper	UseWidget (string widget)
	Set the widget that will be used for displaying this program data in the UI Control page.

ProgramHelper	Implements (string interfaceId, string apiUrl, object options=null)
	Register this program as implementation of the specified interface.

ProgramHelper	AddOption (string field, string defaultValue, string description, string type)
	Adds a configuration option for the program. The option field will be displayed in the program options dialog using the UI widget specified by the "type" field.

ModuleParameter	Option (string field)
	Gets the value of a program option field.

ProgramHelper	AddFeature (string forDomains, string forModuleTypes, string parameterName, string description, string type)
	Adds a "feature" field to modules matching the specified domain/type. Feature fields are used by automation programs to create own handled module parameters. This command should only appear inside a Program.Setup delegate.

ProgramFeature	Feature (string parameterName)
	Return the feature field associated to the specified module parameter.

ProgramHelper	AddModule (string domain, string address, string type, string widget="", string[] implementedFeatures=null)
	Adds a new module to the system.

ProgramHelper	AddModules (string domain, int startAddress, int endAddress, string type, string widget="", string[] implementedFeatures=null)
	Adds a new set of modules to the system.

ProgramHelper	RemoveModule (string domain, string address)
	Remove a module from the system.

ProgramHelper	Notify (string message)
	Display UI notification message using the name of the program as default title for the notification.

ProgramHelper	Notify (string message, params object[] paramList)
	Display UI notification message using the name of the program as default title for the notification.

ProgramHelper	Notify (string title, string message)
	Display UI notification message from current program.

ProgramHelper	Notify (string title, string message, params object[] paramList)
	Display UI notification message from current program.

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

void	GoBackground ()
	This command is usually put at the end of the "Program Code". It is the equivalent of an infinite noop loop.

ModuleParameter	Parameter (string parameterName)
	Gets or sets a program parameter.

StoreHelper	Store (string storeName)
	Gets or creates a persistent data Store for this program.

bool	UpdateModuleDatabase ()
	Force update module database with current data.

Public Member Functions inherited from ProgramHelperBase
ProgramHelperBase	Say (string sentence, string locale=null, bool goAsync=false)
	Playbacks a synthesized voice message from speaker.

ProgramHelperBase	Play (string waveUrl)
	Playbacks a wave file.

Thread	RunAsyncTask (Utility.AsyncFunction functionBlock)
	Executes a function asynchronously.

void	Run (string programId, string options=null)
	Executes the specified Automation Program.

ProgramHelperBase	WaitFor (string programId)
	Waits for the given program to complete execution.

ProgramHelper	WithAddress (int programAddress)
	Returns a reference to the ProgramHelper of a program.

ProgramHelper	WithName (string programName)
	Returns a reference to the ProgramHelper of a program.

void	UpdateCheck ()
	Checks for system updates. If an update is available it will be notified in the UI.

Properties
bool	IsRunning `[get]`
	Gets a value indicating whether the program is running.

bool	IsEnabled `[get]`
	Gets a value indicating whether the program is enabled.

Module	Module `[get]`
	Get a reference to the Module associated to the program.

String	SystemId `[get]`
	Get the UID of this HomeGenie instance.

Properties inherited from ProgramHelperBase
NLog.Logger	Log `[get]`
	Gets the logger object.

Detailed Description

Program Helper class.
Class instance accessor: Program

Member Function Documentation

◆ Setup()

void Setup ( Action functionBlock )

Execute a setup function when the program is enabled. It is meant to be used in the "Setup Code" to execute only once the instructions contained in the passed function. It is mainly used for setting program configuration fields, parameters and features.

Parameters

functionBlock Function name or inline delegate.

Example:

Program.Setup(()=>
{
    Program.AddOption(
        "MaxLevel",
        "40",
        "Keep level below the following value",
        "slider:10:80");
    Program.AddFeature(
        "Dimmer",
        "EnergyManagement.EnergySavingMode",
        "Energy Saving Mode enabled light",
        "checkbox");
}, 0);

◆ Run()

void Run ( bool willRun )

Run the program as soon as the "Setup Code" exits. This command is meant to be used in the "Setup Code".

Parameters

willRun If set to true will run.

◆ UseWidget()

ProgramHelper UseWidget ( string widget )

Set the widget that will be used for displaying this program data in the UI Control page.

Returns: ProgramHelper.

Parameters

widget The widget path.

◆ Implements()

ProgramHelper Implements	(	string	interfaceId,
		string	apiUrl,
		object	options = `null`
	)

Register this program as implementation of the specified interface.

Returns: ProgramHelper

Parameters

interfaceId	The string identifier of the implemented interface. (e.g. "@Statistics:Provider")
apiUrl	Mandatory URL of API to call to get implementation details/config
options	Optional custom object

◆ AddOption()

ProgramHelper AddOption	(	string	field,
		string	defaultValue,
		string	description,
		string	type
	)

Adds a configuration option for the program. The option field will be displayed in the program options dialog using the UI widget specified by the "type" field.

Returns: ProgramHelper

Parameters

field	Name of this input field
defaultValue	Default value for this input field
description	Description for this input field
type	The type of this option (eg. "text", "password", "cron.text", ...). Each type can have different initialization options that are specified as ":" separated items. See html/ui/widgets folder for a list of possible types/options.

◆ Option()

ModuleParameter Option ( string field )

Gets the value of a program option field.

Returns: The option field.

Parameters

field Name of the option field to get.

Example:

// ....
var delay = Program.Option("OffDelay").DecimalValue;
Pause( delay );
Modules.WithFeature("Timer.TurnOffDelay").Off();

◆ AddFeature()

ProgramHelper AddFeature	(	string	forDomains,
		string	forModuleTypes,
		string	parameterName,
		string	description,
		string	type
	)

Adds a "feature" field to modules matching the specified domain/type. Feature fields are used by automation programs to create own handled module parameters. This command should only appear inside a Program.Setup delegate.

Returns: ProgramHelper.

Parameters

forDomains	Expression based on module domain names, used to select what modules will be showing this feature field. This can be either a valid Regular Expression enclosed by '/' and '/' delimiters or a simple comma (or '\|') separated list of domain names (prepend '!' to a name to exclude it).
forModuleTypes	Expression based on module types and parameters names, used to select what modules will be showing this feature field. This must be in the format `<types_expr>[:<parameters_expr>]`. <types_expr> and <parameters_expr> can be either a valid Regular Expression enclosed by '/' and '/' delimiters or a simple comma (or '\|') separated list of names (prepend '!' to a name to exclude it).
parameterName	Name of the module parameter bound to this feature field.
description	Description for this input field.
type	The type of this feature field (eg. "text", "password", "cron.text", ...). Each type can have different initialization options that are specified as ":" separated items. See html/ui/widgets folder for a list of possible types/options.

◆ Feature()

ProgramFeature Feature ( string parameterName )

Return the feature field associated to the specified module parameter.

Parameters

parameterName Parameter name.

◆ AddModule()

ProgramHelper AddModule	(	string	domain,
		string	address,
		string	type,
		string	widget = `""`,
		string[]	implementedFeatures = `null`
	)

Adds a new module to the system.

Returns: ProgramHelper.

Parameters

domain	Domain.
address	Address.
type	Type (Generic, Program, Switch, Light, Dimmer, Sensor, Temperature, Siren, Fan, Thermostat, Shutter, DoorWindow, MediaTransmitter, MediaReceiver).
widget	Widget to display this modules with.
implementedFeatures	Allow only features explicitly declared in this list

◆ AddModules()

ProgramHelper AddModules	(	string	domain,
		int	startAddress,
		int	endAddress,
		string	type,
		string	widget = `""`,
		string[]	implementedFeatures = `null`
	)

Adds a new set of modules to the system.

Returns: ProgramHelper.

Parameters

domain	Domain.
startAddress	Start address (numeric).
endAddress	End address (numeric).
type	Type (Generic, Program, Switch, Light, Dimmer, Sensor, Temperature, Siren, Fan, Thermostat, Shutter, DoorWindow, MediaTransmitter, MediaReceiver).
widget	Widget to display these modules with.
implementedFeatures	Allow only features explicitly declared in this list

◆ RemoveModule()

ProgramHelper RemoveModule	(	string	domain,
		string	address
	)

Remove a module from the system.

Returns: ProgramHelper.

Parameters

domain	Domain.
address	Address.

◆ Notify() [1/4]

ProgramHelper Notify ( string message )

Display UI notification message using the name of the program as default title for the notification.

Parameters

message Message.

Example:

Program.Notify("Hello world!");

◆ Notify() [2/4]

ProgramHelper Notify	(	string	message,
		params object[]	paramList
	)

Display UI notification message using the name of the program as default title for the notification.

Parameters

message	Formatted message.
paramList	Format parameter list.

Example:

Program.Notify("Hello world!");

◆ Notify() [3/4]

ProgramHelper Notify	(	string	title,
		string	message
	)

Display UI notification message from current program.

Parameters

title	Title.
message	Message.

Example:

Program.Notify("Test Program", "Hello world!");

◆ Notify() [4/4]

ProgramHelper Notify	(	string	title,
		string	message,
		params object[]	paramList
	)

Display UI notification message from current program.

Parameters

title	Title.
message	Formatted message.
paramList	Format parameter list.

◆ Emit()

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

Emits a new parameter value.

Returns: ProgramHelper.

Parameters

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

◆ Parameter()

ModuleParameter Parameter ( string parameterName )

Gets or sets a program parameter.

Parameters

parameterName Parameter name.

Example:

// sets an example program parameter
Program.Parameter("MyProgram.ExampleParameter").Value = "Just testing...";
 
// read "Sensor.Temperature" parameter of the program named "DHT-11"
if (Program.WithName("DHT-11").Parameter("Sensor.Temperature").DecimalValue < 20
    && Modules.WithName("Heater").IsOff)
{
    Modules.WithName("Heater").On();
}

◆ Store()

StoreHelper Store ( string storeName )

Gets or creates a persistent data Store for this program.

Parameters

storeName Store name.

Property Documentation

◆ IsRunning

bool IsRunning

get

Gets a value indicating whether the program is running.

true if this program is running; otherwise, false.

◆ IsEnabled

bool IsEnabled

get

Gets a value indicating whether the program is enabled.

true if this program is enabled; otherwise, false.

◆ Module

Module Module

get

Get a reference to the Module associated to the program.

Module object associated to the program.

◆ SystemId

String SystemId

get

Get the UID of this HomeGenie instance.

The unique identifier string of this system.

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

ProgramHelper.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Setup()

◆ Run()

◆ UseWidget()

◆ Implements()

◆ AddOption()

◆ Option()

◆ AddFeature()

◆ Feature()

◆ AddModule()

◆ AddModules()

◆ RemoveModule()

◆ Notify() [1/4]

◆ Notify() [2/4]

◆ Notify() [3/4]

◆ Notify() [4/4]

◆ Emit()

◆ Parameter()

◆ Store()

Property Documentation

◆ IsRunning

◆ IsEnabled

◆ Module

◆ SystemId