IObservingConditionsV2 Interface
- class ObservingConditions
Bases:
ASCOM.DeviceInterfaceASCOM Standard IbservingConditionsV2 Interface
Methods
- ObservingConditions.Action(ActionName: str, ActionParameters)
Invoke the specified device-specific custom action
- Parameters:
ActionName (str) – A name from
SupportedActionsthat represents the action to be carried out.ActionParameters (str) – List of required arguments or empty string if none are required.
- Returns:
Action response. The meaning of returned strings is set by the driver author. See notes below.
- Return type:
string
- Raises:
MethodNotImplementedException – If no actions at all are supported
ActionNotImplementedException – If the driver does not support the requested ActionName. The supported action names are listed in
SupportedActions.NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Important
Must be implemented but may throw
MethodNotImplementedExceptionif no custom actions are supported.This method, combined with
SupportedActions, is the supported mechanic for adding non-standard functionality.Note
Action names must be case insensitive, so for example SelectWheel, selectwheel and SELECTWHEEL all refer to the same action.
An example of a string response: Suppose filter wheels start to appear with automatic wheel changers; new actions could be QueryWheels and SelectWheel. The former returning a formatted list of wheel names and the second taking a wheel name and making the change, returning appropriate values to indicate success or failure.
- ObservingConditions.CommandBlind(Command: str, Raw: bool)
Deprecated since version 2: Use the more flexible
Action()andSupportedActionsmechanic. See Notes below.Transmit an arbitrary string to the device and does not wait for a response.
- Parameters:
Command (str) – The literal command string to be transmitted.
Raw (bool) – If True, command is transmitted ‘as-is’. If False, then protocol framing characters may be added prior to transmission.
- Returns:
Nothing
- Raises:
MethodNotImplementedException – If the method is not implemented
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Deprecated, may result in
MethodNotImplementedExceptionNote
The CommandXXX methods are a historic mechanic that provides clients with direct and unimpeded access to change device hardware configuration. While highly enabling for clients, this mechanic is inherently risky because clients can fundamentally change hardware operation without the driver being aware that a change is taking / has taken place.
The newer
ActionandSupportedActionsmechanic provides discrete, named, functions that can deliver any functionality required.They do need driver authors to make provision for them within the driver, but this approach is much lower risk than using the CommandXXX methods because it enables the driver to resolve conflicts between standard device interface commands and extended commandsprovided as Actions.The driver is always aware of what is happening and can adapt more effectively to client needs.
- ObservingConditions.CommandBool(Command: str, Raw: bool)
Deprecated since version 2: Use the more flexible
Action()andSupportedActionsmechanic. See Notes below.Transmit an arbitrary string to the device and wait for a boolean response.
- Parameters:
Command (str) – The literal command string to be transmitted.
Raw (bool) – If True, command is transmitted ‘as-is’. If False, then protocol framing characters may be added prior to transmission.
- Returns:
True/False response from the command
- Return type:
boolean
- Raises:
MethodNotImplementedException – If the method is not implemented
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Deprecated, may result in
MethodNotImplementedExceptionNote
The CommandXXX methods are a historic mechanic that provides clients with direct and unimpeded access to change device hardware configuration. While highly enabling for clients, this mechanic is inherently risky because clients can fundamentally change hardware operation without the driver being aware that a change is taking / has taken place.
The newer
ActionandSupportedActionsmechanic provides discrete, named, functions that can deliver any functionality required.They do need driver authors to make provision for them within the driver, but this approach is much lower risk than using the CommandXXX methods because it enables the driver to resolve conflicts between standard device interface commands and extended commandsprovided as Actions.The driver is always aware of what is happening and can adapt more effectively to client needs.
- ObservingConditions.CommandString(Command: str, Raw: bool)
Deprecated since version 2: Use the more flexible
Action()andSupportedActionsmechanic. See Notes below.Transmit an arbitrary string to the device and wait for a string response.
- Parameters:
Command (str) – The literal command string to be transmitted.
Raw (bool) – If True, command is transmitted ‘as-is’. If False, then protocol framing characters may be added prior to transmission.
- Returns:
String response from the command
- Return type:
string
- Raises:
MethodNotImplementedException – If the method is not implemented
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Deprecated, may result in
MethodNotImplementedExceptionNote
The CommandXXX methods are a historic mechanic that provides clients with direct and unimpeded access to change device hardware configuration. While highly enabling for clients, this mechanic is inherently risky because clients can fundamentally change hardware operation without the driver being aware that a change is taking / has taken place.
The newer
ActionandSupportedActionsmechanic provides discrete, named, functions that can deliver any functionality required.They do need driver authors to make provision for them within the driver, but this approach is much lower risk than using the CommandXXX methods because it enables the driver to resolve conflicts between standard device interface commands and extended commandsprovided as Actions.The driver is always aware of what is happening and can adapt more effectively to client needs.
- async ObservingConditions.Connect()
Added in version 2: Preferred asynchronous connection mechanic. See Important section below.
Connect to the device asynchronously. Use this to connect to a device rather than setting
Connectedto True.
- Returns:
Nothing
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Important
Non-Blocking. On return,
Connectingmust be True unless already connected Connection has successfully completed whenConnectingbecomes (or is) False.This is a mandatory method and must not throw a
MethodNotConnectedException.Use this to connect to a device rather than setting
Connectedto True.Note
New in ObservingConditions V2
- async ObservingConditions.Disconnect()
Added in version 2: Preferred asynchronous connection mechanic. See Important section below.
Disconnect from the device asynchronously. Use this to disconnect from a device rather than setting
Connectedto False.
- Returns:
Nothing
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Important
Non-Blocking. On return,
Connectingmust be True unless already disconnected. Disconnect has successfully completed whenConnectingbecomes (or is) False.This is a mandatory method and must not throw a
MethodNotImplementedException.Use this to disconnect from a device rather than setting
Connectedto False.Note
New in ObservingConditions V2
- ObservingConditions.Refresh()
Forces the device to immediately query its attached hardware to refresh sensor values
- Returns:
Nothing
- Raises:
MethodNotImplementedException – If refreshing is not supported.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
This must be a short-lived synchronous call that triggers a refresh. It must not wait for long running processes to complete. It is the client’s responsibility to poll
TimeSinceLastUpdateto determine whether / when the data has been refreshed.
- ObservingConditions.SensorDescription(PropertyName: str)
Description of the sensor providing the requested property
- Parameters:
PropertyName (str) – The caseless name of the
ObservingConditionsmeterological property for which the sensor description is desired. For example “WindSpeed” (forWindSpeed) shall return a description of the sensor used to measure the wind speed.- Returns:
Description of the sensor used to measured the specified property.
- Return type:
string
- Raises:
MethodNotImplementedException – If the requested property/sensor is not implemented at all. See Attention section below for conditions.
InvalidValueException – If
PropertyNameis not the name of one of the properties ofObservingConditions.NotConnectedException – If the device is not connected, and a connection is neeeded to get the descriptive name.
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must not throw a
MethodNotImplementedExceptionwhen the specified sensor is implemented but not returning data. Must throw aMethodNotImplementedExceptionwhen the specified sensor is not implemented at all.Note
PropertyNamemust be the caseless name of one of the sensor properties specified in the ObservingConditions interface. If the caller supplies some other value, throw anInvalidValueException.If the sensor is implemented, this must return a valid string, even if the driver is not connected, so that applications can use this to determine what sensors are available.
If the sensor is not implemented at all, this must throw a
MethodNotImplementedException.
- ObservingConditions.SetupDialog()
Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancels manually.
Please note that this method is only valid for COM drivers. Alpaca devices should provide configuration through the Alpaca HTML endpoints and should not implement a SetupDialog endpoint.
- Returns:
Nothing
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
Blocking It is permissible that the configuration dialog is modal, and for the driver not to respond to other calls while this dialog is open.
- ObservingConditions.TimeSinceLastUpdate(PropertyName: str)
Elapsed time (seconds) since last update of the sensor providing the requested property
- Parameters:
PropertyName (str) – The name (in any casing) of the ObservingConditions meterological property for which time since last update is desired. For example “WindSpeed” (for
WindSpeed) shall return the number of seconds since wind speed was last updated.- Returns:
Elapsed time (seconds) since the requested property was last updated
- Return type:
float
- Raises:
MethodNotImplementedException – If the requested property/sensor is not implemented
InvalidValueException – If
PropertyNameis not the name of one of the properties ofObservingConditions.NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must not throw a
MethodNotImplementedExceptionwhen the specified sensor is implemented but must throw aMethodNotImplementedExceptionwhen the specified sensor is not implemented.Note
PropertyNamemust be the caseless name of one of the sensor properties specified in the IObservingConditions interface. If the caller supplies some other value, throw anInvalidValueException.Return a negative value to indicate that no valid value has ever been received from the hardware.
If an empty string is supplied as the
PropertyName, the driver must return the time since the most recent update of any sensor. AMethodNotImplementedExceptionmust not be thrown.
Properties
- property ObservingConditions.AveragePeriod: float
(read/write) Gets And sets the time period (hours) over which observations will be averaged
- Raises:
InvalidValueException – If the value set is not available for this driver. All drivers must accept 0.0 to specify that an instantaneous value is available.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Mandatory property, must be implemented, can not* throw a
PropertyNotImplementedExceptionNote
AveragePeriod muast return the time period (hours) over which sensor readings will be averaged. If the device is delivering instantaneous sensor readings this property must return a value of 0.0.
Please resist the temptation to throw exceptions when clients query sensor properties when insufficient time has passed to get a true average reading.A best estimate of the average sensor value should be returned in these situations.
- property ObservingConditions.CloudCover: float
Amount of sky obscured by cloud in percent (0.0 - 100.0)
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Optional property, can throw a
PropertyNotImplementedExceptionNote
This property should return a value between 0.0 and 100.0 where 0.0 = clear sky and 100.0 = 100% cloud coverage
- property ObservingConditions.Connected: boolean
Changed in version 2: Writing to change connection state superseded by asynchronous
Connect(),Disconnect(), andConnecting.(Read/Write) Retrieve or set the connected state of the device. Writing is deprecated, use the newer
Connect()andDisconnect()methods, and the newerConnectingproperty. See remarks below.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. See Notes below.
- Returns:
True if connected to the hardware, else false.
- Return type:
boolean
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Deprecation Notice
Property-write is deprecated as of ObservingConditions V2. Starting with Platform 7 and the interface revisions contained therein, writing to Connected is discouraged. To connect and disconnect, use the newer non-blocking
Connect()andDisconnect()methods, with the newConnectingproperty serving as the completion property.Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
Do not use a
NotConnectedExceptionhere, that exception is for use in other methods that require a connection in order to succeed.The Connected property sets and reports the state of connection to the device hardware. For a hub this means that Connected will be True when the first driver connects and will only be set to False when all drivers have disconnected. A second driver may find that Connected is already True and setting Connected to False does not report Connected as False. This is not an error because the physical state is that the hardware connection is still True.
Multiple calls setting Connected to True or False will not cause an error.
- property ObservingConditions.Connecting: Boolean
Added in version 2: Preferred asynchronous connection mechanic. See Important section below.
- Returns:
Returns True while the device is undertaking an asynchronous connect or disconnect operation.
- Return type:
boolean
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This is the correct property for determing when the non-blocking methods
Connect()orDisconnect()have completed. Completion is whenConnectingbecomes False after calling either of these methods.New in IObservingConditionsV2
- property ObservingConditions.Description: String
- Returns:
Description of the device such as manufacturer and model number. Any ASCII characters may be used.
- Return type:
string
- Raises:
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This describes the device, not the driver. See the
DriverInfoproperty for information on the ASCOM driver.The description length must be a maximum of 64 characters so that it can be used in FITS image headers, which are limited to 80 characters including the header name.
- property ObservingConditions.DeviceState: List[StateValue]
Added in version 2: To allow reduction of status polling
- Returns:
List of
StateValueobjects representing the operational properties of this device. See What is the “read all” feature and what are its rules?.- Return type:
List
- This device must return the following operational properties if they are known:
Note
For more info see What is the “read all” feature and what are its rules?.
Available only for the ObservingConditions Interface Version 4 and later.
- property ObservingConditions.DewPoint: float
Atmospheric dew point temperature (deg C) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Optional property, can throw a
PropertyNotImplementedExceptionwhen theHumidityproperty also throws aPropertyNotImplementedException.Mandatory property, must not throw a
PropertyNotImplementedExceptionwhen theHumidityproperty is implemented.The ASCOM specification requires that DewPoint and Humidity are either both implemented or both throw
PropertyNotImplementedException. It is not allowed for one to be implemented and the other to throw aPropertyNotImplementedException.Note
The units of this property are degrees Celsius.
- property ObservingConditions.DriverInfo: String
- Returns:
Descriptive and version information about the ASCOM driver
- Return type:
string
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This string may contain line endings and may be hundreds to thousands of characters long.It is intended to display detailed information on the ASCOM driver, including version and copyright data. See the
Descriptionproperty for information on the device itself.To get the driver version in a parse-able string, use theDriverVersionproperty.
- property ObservingConditions.DriverVersion: String
- Returns:
String containing only the major and minor version of the driver.
- Return type:
string
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This must be in the form “n.n”. It should not to be confused with the
InterfaceVersionproperty, which is the version of this specification supported by the driver.On systems with a comma as the decimal point you may need to make accommodations to parse the value.
- property ObservingConditions.Humidity: float
Atmospheric relative humidity (0.0 - 100.0 percent) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Optional property, can throw a
PropertyNotImplementedExceptionwhen theDewPointproperty also throws aPropertyNotImplementedException.Mandatory property, must not throw a
PropertyNotImplementedExceptionwhen theDewPointproperty is implemented.The ASCOM specification requires that DewPoint and Humidity are either both implemented or both throw
PropertyNotImplementedException. It is not allowed for one to be implemented and the other to throw aPropertyNotImplementedException.
- property ObservingConditions.InterfaceVersion: Short
- Returns:
ASCOM Device interface definition version that this device supports. Should return 2 for this interface version.
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This is a single “short” integer indicating the version of this specific ASCOM universal interface definition. For IObservingConditionsV2, this will be 2. It should not to be confused with the
DriverVersionproperty, which is the major.minor version of the driver for this ObservingConditions.
- property ObservingConditions.Name: String
- Returns:
The short name of the driver, for display purposes.
- Return type:
string
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
The
Descriptionproperty is used to return info about the device rather than the driver.
- property ObservingConditions.Pressure: float
Atmospheric pressure (hPa) at the observatory altitude
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
This must be the pressure at the observatory altitude and not the adjusted pressure at sea level. Please check whether your pressure sensor delivers local observatory pressure or sea level pressure. If it returns sea level pressure, your device must convert this to actual pressure at the observatory’s altitude before returning a value to the client.
- property ObservingConditions.RainRate: float
Rain rate (mm/hr) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Note
The units of this property are millimetres per hour.
This property can be interpreted as 0.0 = Dry any positive nonzero value = wet. Rainfall intensity is classified according to the rate of precipitation:
Light rain — when the precipitation rate is less than 2.5 mm (0.098 in) per hour
Moderate rain — when the precipitation rate is between 2.5 mm (0.098 in) and 10 mm (0.39 in) per hour
Heavy rain — when the precipitation rate is between 10 mm (0.39 in) and 50 mm (2.0 in) per hour
Violent rain — when the precipitation rate is > 50 mm (2.0 in) per hour
- property ObservingConditions.SkyBrightness: float
Sky brightness (Lux) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Note
- This property returns the sky brightness measured in Lux.
0.0001 lux Moonless, overcast night sky (starlight)
0.002 lux Moonless clear night sky with airglow
0.27–1.0 lux Full moon on a clear night
3.4 lux Dark limit of civil twilight under a clear sky
50 lux Family living room lights (Australia, 1998)
80 lux Office building hallway/toilet lighting
100 lux Very dark overcast day
320–500 lux Office lighting
400 lux Sunrise or sunset on a clear day.
1000 lux Overcast day; typical TV studio lighting
10000–25000 lux Full daylight (not direct sun)
32000–100000 lux Direct sunlight
- property ObservingConditions.SkyQuality: float
Sky quality (mag per sq-arcsec) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Note
Examples of typical sky quality values were published by Sky and Telescope (http://www.skyandtelescope.com/astronomy-resources/rate-your-skyglow/) and, in slightly adpated form, are reproduced below:
![]()
- property ObservingConditions.SkyTemperature: float
Sky temperature (deg C) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Note
The units of this property are degrees Celsius. Driver and application authors can use the ConvertUnits(Double, Units, Units) methodto convert these units to and from degrees Fahrenheit.
This is expected to be returned by an infra-red sensor looking at the sky. The lower the temperature the more the sky is likely to be clear.
- property ObservingConditions.StarFWHM: float
Seeing (FWHM in arc-sec) at the observatory
- Raises:
ValueNotSetException – Seeing data not currently available (daylight, clouds etc.)
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
- property ObservingConditions.SupportedActions: COM: ArrayList of String elements, Alpaca: Array of String
Returns the list of custom action names supported by this driver, to be used with
Action(),
- Returns:
The list of custom action names supported by this driver
- Return type:
COM: ArrayList of String elements, Alpaca: Array of String
- Raises:
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Attention
Must be implemented, must not throw a
PropertyNotImplementedExceptionNote
This method, combined with
Action(), is the supported mechanic for adding non-standard functionality.SupportedActions is a “discovery” mechanism that enables clients to know which Actions a device supports without having to exercise the Actions themselves. This mechanism is necessary because there could be people / equipment safety issues if actions are called unexpectedly or out of a defined process sequence. It follows from this that SupportedActions must return names that match the spelling of custom action names exactly, without additional descriptive text. However, returned names may use any casing because the
ActionNameparameter ofAction()is case insensitive.
- property ObservingConditions.Temperature: float
Atmospheric temperature (deg C) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
- property ObservingConditions.WindDirection
Direction (deg) from which the wind is blowing at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
Note
Meterological standards Wind direction is that from which the wind is blowing, measured in degrees clockwise from True North=0.0, East=90.0, South=180.0, West=270.0
If the wind velocity is 0 then direction must be reported as 0.
- property ObservingConditions.WindGust
Peak 3 second wind gust (m/s) at the observatory over the last 2 minutes
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.
- property ObservingConditions.WindSpeed
Wind speed (m/s) at the observatory
- Raises:
PropertyNotImplementedException – The device does not implement this property.
NotConnectedException – If the device is not connected
DriverException – An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. Includes communication errors.