IObserving |
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.
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.6.9999.9999)
SyntaxThe IObservingConditions type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AveragePeriod | Gets And sets the time period over which observations will be averaged |
| CloudCover | Amount of sky obscured by cloud |
| Connected | Set to True to connect to the device hardware. Set to 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. |
| Description | Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used. |
| DewPoint | Atmospheric dew point at the observatory |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| Humidity | Atmospheric humidity at the observatory |
| InterfaceVersion | The interface version number that this device supports. Must return 1 for this interface version. |
| Name | The short name of the driver, for display purposes |
| Pressure | Atmospheric pressure at the observatory |
| RainRate | Rain rate at the observatory |
| SkyBrightness | Sky brightness at the observatory |
| SkyQuality | Sky quality at the observatory |
| SkyTemperature | Sky temperature at the observatory |
| StarFWHM | Seeing at the observatory measured as star full width half maximum (FWHM) in arc secs. |
| SupportedActions | Returns the list of custom action names supported by this driver. |
| Temperature | Temperature at the observatory |
| WindDirection | Wind direction at the observatory |
| WindGust | Peak 3 second wind gust at the observatory over the last 2 minutes |
| WindSpeed | Wind speed at the observatory |
Methods| Name | Description | |
|---|---|---|
 | Action | Invokes the specified device-specific custom action. |
| CommandBlind | 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. |
| CommandBool | 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. |
| CommandString | 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. |
| Dispose | 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. |
| Refresh | Forces the driver to immediately query its attached hardware to refresh sensor values |
| SensorDescription | Provides a description of the sensor providing the requested property |
| SetupDialog | Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually. |
| TimeSinceLastUpdate | Provides the time since the sensor value was last updated |
RemarksIt is NOT intended as a general purpose environmental sensor system. The Action method and
SupportedActions property can be used to extend your driver to present any further sensors that you need.
See Also