Click or drag to resize

ObservingConditions Class

Provides universal access to ObservingConditions drivers. Defines the IObservingConditions Interface. This interface provides a limited set of values that are useful for astronomical purposes for things such as determining if it is safe to open or operate the observing system, for recording astronomical data or determining refraction corrections.
Inheritance Hierarchy
SystemObject
  ASCOM.DriverAccessAscomDriver
    ASCOM.DriverAccessObservingConditions

Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0
Syntax
Copy
public class ObservingConditions : AscomDriver, 
	IObservingConditionsV2

The ObservingConditions type exposes the following members.

Constructors
 NameDescription
Public methodObservingConditions Creates an ObservingConditions object with the given Prog ID
Top
Properties
 NameDescription
Public propertyAveragePeriod Gets And sets the time period over which observations will be averaged
Public propertyCloudCover Amount of sky obscured by cloud
Public propertyConnected Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.
(Inherited from AscomDriver)
Public propertyConnecting Returns True while the device is undertaking an asynchronous connect or disconnect operation.
(Inherited from AscomDriver)
Public propertyDescription Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
(Inherited from AscomDriver)
Public propertyDeviceState Returns the device's operational state in a single call.
(Inherited from AscomDriver)
Public propertyDewPoint Atmospheric dew point at the observatory
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AscomDriver)
Public propertyDriverVersion A string containing only the major and minor version of the driver.
(Inherited from AscomDriver)
Public propertyHasConnectAndDeviceState Returns if the device has a Platform 7 or later interface that supports Connect / Disconnect and DeviceState
(Inherited from AscomDriver)
Public propertyHumidity Atmospheric humidity at the observatory
Public propertyInterfaceVersion The interface version number that this device supports.
(Inherited from AscomDriver)
Public propertyName The short name of the driver, for display purposes
(Inherited from AscomDriver)
Public propertyObservingConditionsState ObservingConditions device state
Public propertyPressure Atmospheric pressure at the observatory
Public propertyRainRate Rain rate at the observatory
Public propertySkyBrightness Sky brightness at the observatory
Public propertySkyQuality Sky quality at the observatory
Public propertySkyTemperature Sky temperature at the observatory
Public propertyStarFWHM Seeing at the observatory measured as star full width half maximum (FWHM) in arc secs.
Public propertySupportedActionsReturns the list of custom action names supported by this driver.
(Inherited from AscomDriver)
Public propertyTemperature Temperature at the observatory
Public propertyWindDirection Wind direction at the observatory
Public propertyWindGust Peak 3 second wind gust at the observatory over the last 2 minutes
Public propertyWindSpeed Wind speed at the observatory
Top
Methods
 NameDescription
Public methodActionInvokes the specified device-specific custom action.
(Inherited from AscomDriver)
Public methodStatic memberChoose Brings up the ASCOM Chooser Dialogue to choose an ObservingConditions driver.
Public methodCommandBlind Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodCommandBool Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodCommandString Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodConnect Connect to the device asynchronously
(Inherited from AscomDriver)
Public methodDisconnect Disconnect from the device asynchronously
(Inherited from AscomDriver)
Public methodDispose This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method.
(Inherited from AscomDriver)
Public methodRefresh Forces the driver to immediately query its attached hardware to refresh sensor values
Public methodSensorDescription Provides a description of the sensor providing the requested property
Public methodSetupDialog Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancel manually.
(Inherited from AscomDriver)
Public methodTimeSinceLastUpdate Provides the time since the sensor value was last updated
Top
Remarks
It is NOT intended as a general purpose environmental sensor system. The Action method and SupportedActions property can be used to add driver-specific sensors.
See Also