Click or drag to resize

CrestronEnvironment Class

Provides information about the current environment.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpCrestronEnvironment

Namespace: Crestron.SimplSharp
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public static class CrestronEnvironment

The CrestronEnvironment type exposes the following members.

Properties
 NameDescription
Public propertyStatic memberDevicePlatform Gets the platform SIMPL#/SIMPL# Pro is running on.
Public propertyStatic memberLatitude Property to set the latitude which is used by the native scheduling engine for the astronomical events. The Set feature is not supported on Server. It will throw a NotSupportedException. This property requires a reboot for it to take into effect. This property is read on startup and could be out of sync if it was changed and the unit was not rebooted. This defaults to 41.000000 North
Public propertyStatic memberLongitude Property to set the longitude which is used by the native scheduling engine for the astronomical events. The Set feature is not supported on Server. It will throw a NotSupportedException. This property requires a reboot for it to take into effect. This property is read on startup and could be out of sync if it was changed and the unit was not rebooted. This defaults to -73.933333 West
Public propertyStatic memberNewLine Gets the newline string defined for this environment.
Public propertyStatic memberProgramCompatibility Indicates the compatibility of programs for this control system.
Public propertyStatic memberRuntimeEnvironment Gets the runtime environment of the SIMPL# module.
Public propertyStatic memberTickCount Gets the number of milliseconds elapsed since the system started.
Top
Methods
 NameDescription
Public methodStatic memberAllowOtherAppsToRun This is a function that users will be allowed to call in order to be polite to the system and allow other applications to run.
Public methodStatic memberConvertTSIDToSerialNumber Method to convert the given TSID to the serial number. This method will only work on firmware versions greater then 1.503.0000.
Public methodStatic memberGetLocalTime Function to get the current local time of the system.
Public methodStatic memberGetTimeZone Get current timezone information
Public methodStatic memberGetTimeZone(UInt32) Get timezone information for the specified timezoneId
Public methodStatic memberGetTimeZoneDetail Get current timezone detail settings
Public methodStatic memberGetTimeZoneList Function to get the current timezone list
Public methodStatic memberScaleWithLimits(Int32, Int32, Int32, Int32, Int32) Scales a given input value that lies between a given set of input limits to an output value given a set of output limits. This version works on signed integer arguments.
Public methodStatic memberScaleWithLimits(UInt32, UInt32, UInt32, UInt32, UInt32) Scales a given input value that lies between a given set of input limits to an output value given a set of output limits. This version works on unsigned integer arguments.
Public methodStatic memberSetDate Function to change the current date of the system.
Public methodStatic memberSetTime Function to change the current time of the system.
Public methodStatic memberSetTimeAndDate Set the system time and date
Public methodStatic memberSetTimeZone Set local time to the timezone with given timezoneId
Public methodStatic memberSleep Function to sleep for the specified time
Top
Events
 NameDescription
Public eventStatic memberEthernetEventHandler Ethernet Event Handler. Programmer needs to subscribe to this handler for receiving ethernet events.
Public eventStatic memberProgramStatusEventHandler Program Event Handler. Programmer needs to subscribe to this handler for receiving program status events.
Public eventStatic memberSystemEventHandler System Event Handler. Programmer needs to subscribe to this handler for receiving system events.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also