System Object

RSS

Provides base automation system methods and properties, such as Sleep() and Log().

Table of Contents [Hide/Show]

Static Methods
   Sleep
   Log
   DeviceNameExists
   GetDeviceContainer
   GetLightingDeviceContainers
   GetOutputDeviceContainers
   GetClimateControlDeviceContainers
   GetMediaPlayerDeviceContainers
   GetTaskDeviceContainers
   GetSecurityDeviceContainers
   GetWeatherDeviceContainers

Static Methods

Sleep

Suspends the current script execution for the specified number of milliseconds.

Syntax:

void Sleep( Number milliseconds )

Parameters:

milliseconds: The number of milliseconds to sleep.

Example:

System.Sleep( 5000 ); // sleep 5 seconds

Log

Logs an informational message.

Syntax:

void Log( String message )

Parameters:

message: The message text to log.

Example:

System.Log( "This is a logged message." );

DeviceNameExists

Indicates if the specified device name exists.

Syntax:

Boolean DeviceNameExists( String deviceName )

Parameters:

deviceName: The unique name of the device.

GetDeviceContainer

Gets a reference to the specified device container.

This method is intended to be used when a device's name is not known at design time, for example when used with a control that enumerates device names where the user can choose a name from a list. If the device name is known at design time, then the device name should be directly used as the object instead of using this method.

Syntax:

DeviceContainer GetDeviceContainer( String deviceName )

Example:


deviceName = "itunes";
devicesContainer = System.GetDeviceContainer( deviceName );

GetLightingDeviceContainers

Gets references to all the device containers supporting the lighting and electrical interface.

Example driver(s) supporting the lighting and electrical interface are Elk M1 Driver and Vizia RF Driver.

Syntax:

Array GetLightingDeviceContainers( )

Example:


// Turn off all lights for all lighting devices.
devicesContainers = System.GetLightingDeviceContainers();
for (i=0; i < devicesContainers.Length; i++)
	devicesContainers[i].GetDevice().TurnOffAllLights();

GetOutputDeviceContainers

Gets references to all the device containers supporting the output interface.

Example driver(s) supporting the output interface are Elk M1 Driver.

Syntax:

Array GetOutputDeviceContainers( )

GetClimateControlDeviceContainers

Gets references to all the device containers supporting the climate control interface.

Example driver(s) supporting the climate control interface are Elk M1 Driver.

Syntax:

Array GetClimateControlDeviceContainers( )

GetMediaPlayerDeviceContainers

Gets references to all the device containers supporting the media player interface.

Example driver(s) supporting the climate control interface are SqueezeCenter Driver.

Syntax:

Array GetMediaPlayerDeviceContainers( )

GetTaskDeviceContainers

Gets references to all the device containers supporting the tasks interface.

Example driver(s) supporting the tasks interface are Elk M1 Driver.

Syntax:

Array GetTaskDeviceContainers( )

GetSecurityDeviceContainers

Gets references to all the device containers supporting the security interface.

Example driver(s) supporting the security interface are Elk M1 Driver.

Syntax:

Array GetSecurityDeviceContainers( )

GetWeatherDeviceContainers

Gets references to all the device containers supporting the weather interface.

Example driver(s) supporting the weather interface are NOAA Weather Driver and Weather Channel Driver.

Syntax:

Array GetWeatherDeviceContainers( )