ASCOM ObservingConditions: Difference between revisions

From Deep Sky Chile
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Deep Sky Chile Observing Conditions Driver =
This page describes the '''Deep Sky Chile Observing Conditions''' ASCOM driver.
 
It exposes real-time weather and seeing data from the Deep Sky Chile site through the standard ASCOM <code>ObservingConditions</code> interface, so that automation software (N.I.N.A., Voyager, SGP, etc.) can use it for monitoring and safety decisions.
 
See also: [[ASCOM_SafetyMonitor|Deep Sky Chile Safety Monitor (ASCOM driver)]]


== Overview ==
== Overview ==
The '''Deep Sky Chile Observing Conditions''' driver is an ASCOM-compliant driver that exposes weather and seeing data from the Deep Sky Chile site. It retrieves real-time meteorological data from the Deep Sky Chile API and maps it to standard ASCOM ObservingConditions properties. This driver is intended for remote observatory automation systems (like N.I.N.A., Voyager, SGP) to monitor environmental conditions. {| class="wikitable"
! Property
! Value
|-
| '''Version'''
| 1.0.0 |-
| '''Author'''
| Cédric Thomas |}


== Supported Sensors ==
The '''Deep Sky Chile Observing Conditions''' driver is an ASCOM-compliant driver that publishes:
The driver supports the following sensors: * Temperature, Humidity, Dew Point
 
* Wind Speed & Wind Gust
* Ambient and sky conditions (temperature, humidity, wind, rain…)
* Seeing (StarFWHM)
* Seeing and sky quality
* Sky Quality (NSB)
* Cloud and rain status converted to standard ASCOM fields
* Sky Temperature
 
* Cloud Cover & Rain Rate
It retrieves meteorological data from the Deep Sky Chile API and maps it to ASCOM <code>ObservingConditions</code> properties used by most automation software. 
This driver is intended for '''remote observatory automation''', to help you make safe decisions about starting, stopping and continuing imaging sessions.
 
== Features ==
 
'''Supported sensors'''
 
* '''Temperature'''
* '''Humidity'''
* '''Dew point'''
* '''Wind speed''' and '''wind gust'''
* '''Seeing''' (star FWHM)
* '''Sky quality''' (NSB)
* '''Sky temperature'''
* '''Cloud cover'''
* '''Rain rate'''
 
'''Other key features'''
 
* Periodic polling of the Deep Sky Chile weather API
* Conversion of raw values into standard ASCOM properties
* Stale-data protection with a configurable time multiplier
* Optional detailed trace logging for troubleshooting
 
== How it works ==
 
The driver periodically queries the Deep Sky Chile weather API (default endpoint):
 
* <code>http://api.deepskychile.com/weather</code>
 
On each poll it:
 
# Retrieves the JSON weather data over HTTP (TLS 1.2 secured)
# Extracts the relevant sensor values (temperature, humidity, seeing, etc.)
# Converts cloud and rain status into ASCOM-compatible percentage / rate values
# Verifies that the data is not stale (based on the configured multiplier)
# Exposes everything through the ASCOM <code>ObservingConditions</code> interface
 
== Requirements ==


== Operation Logic ==
To use this driver you need:
The driver periodically queries the API (default: <code>http://api.deepskychile.com/weather</code>). It then performs the following operations: # Retrieves the JSON data via HTTP (TLS 1.2 secured)
# Extracts sensor values (Temp, Hum, Seeing, etc.)
# Converts cloud/rain status into percentage/rate
# Supports stale data protection (configurable multiplier)
# Provides detailed trace logging


* A Windows PC 
* The '''ASCOM Platform 7.1 or later''' installed 
* An internet connection to reach the Deep Sky Chile API 
* Compatible client software (for example N.I.N.A., Voyager, SGP, …)


== Installation ==


[Image of API data flow diagram]
# Download and run the driver installer from your Deep Sky Chile customer area.
# The installer will:
#* Copy the driver files to your system
#* Register the COM driver with ASCOM
#* Add the required ASCOM profile entries


Once installed, the driver appears in the ASCOM chooser as '''Deep Sky Chile Observing Conditions''' (or similar).


== Configuration ==
== Configuration ==
Open the driver’s Setup dialog from any ASCOM application to configure the following: * API URL Endpoint
* Polling interval (seconds)
* Stale data multiplier
* Trace logging (Enable/Disable)


=== Logging ===
You configure the driver via its '''Setup''' dialog, accessible from any ASCOM-compatible application.
Trace logs are stored in: : <code>Documents\ASCOM\Logs</code>


== Installation ==
'''API URL endpoint'''
Run the installer to: * Copy driver files
 
* Register the COM driver
* Default: <code>http://api.deepskychile.com/weather</code> 
* Add ASCOM profile entries
* Change this only if instructed by Deep Sky Chile.
 
'''Polling interval (seconds)'''
 
* Defines how often the driver queries the API. 
* Shorter intervals give fresher data but generate more network traffic.
 
'''Stale data multiplier'''
 
* Protects against using old data. 
* If the last update is older than <code>multiplier × polling interval</code>, the driver can treat the data as stale.
 
'''Trace logging'''
 
* When enabled, the driver writes a detailed log of its activity.
 
Trace logs are stored in:


== Uninstallation ==
* <code>Documents\ASCOM\Logs</code>
Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support ==
For help, contact: : Cédric Thomas ([email protected])


== Disclaimer ==
== Usage with automation software ==
This driver relies entirely on the Deep Sky Chile API. Always use redundant safety systems in remote observatory operations. ```


***
A typical usage pattern:


### Page 2: Deep Sky Chile Safety Monitor Driver
# Open your automation software (for example N.I.N.A., Voyager, SGP).
# In the '''Weather''' (or equivalent) device selection:
#* Open the ASCOM chooser.
#* Select '''Deep Sky Chile Observing Conditions'''.
#* Click '''Properties''' (or '''Setup''') to configure API URL, polling interval, etc.
#* Confirm and connect.


```mediawiki
Once connected, your software can read:
= Deep Sky Chile Safety Monitor =


== Overview ==
* Temperature, humidity, dew point 
The '''Deep Sky Chile Safety Monitor''' is an ASCOM-compliant driver that exposes the safety status of Deep Sky Chile observatories. It retrieves the ''roofState'' ("open" or "closed") from the Deep Sky Chile API and converts it into an ASCOM SafetyMonitor ''IsSafe'' value. This driver is intended for remote observatory automation systems that rely on ASCOM SafetyMonitor devices. {| class="wikitable"
* Wind speed and gusts 
! Property
* Cloud cover and rain rate 
! Value
* Seeing and sky quality 
|-
* Sky temperature 
| '''Version'''
| 1.2.0 |-
| '''Author'''
| Cédric Thomas |}


== Safety Logic ==
These values can then be used to drive safety limits, session start/stop rules and observing plans.
The driver maps the roof state to the ASCOM safety status: * '''Roof open''' → Safe = True
* '''Roof closed''' → Safe = False


== Operation Logic ==
== Logging and troubleshooting ==
The driver periodically queries the API at: : <code>http://api.deepskychile.com/observatories</code>


It then performs the following steps: # Identifies the selected observatory
If you encounter issues:
# Reads its roofState
# Converts this into ASCOM IsSafe
# Supports stale data protection
# Provides optional trace logging


== Configuration ==
# Enable '''trace logging''' in the Setup dialog.
Open the driver’s Setup dialog from any ASCOM application to configure: * API URL
# Reproduce the problem (for example connection error, missing data).
* Observatory selection (dropdown list)
# Check the latest log files in:
* Polling interval
#* <code>Documents\ASCOM\Logs</code>
* Stale data multiplier
* Fail-safe mode
* Trace logging


=== Logging ===
Typical checks:
Trace logs are stored in: : <code>Documents\ASCOM\Logs</code>


== Installation ==
* Is the API URL correct? 
Run the installer to: * Copy driver files
* Is the polling interval reasonable (not too short or too long)? 
* Register the COM driver
* Is the system time on the PC correct (for stale-data calculations)?
* Add ASCOM profile entries


== Uninstallation ==
== Uninstallation ==
Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support ==
 
For help, contact: : Cédric Thomas ([email protected])
To remove the driver:
 
# Open '''Windows Settings → Apps''' (or '''Control Panel → Programs and Features''').
# Locate '''Deep Sky Chile Observing Conditions'''.
# Click '''Uninstall'''.
 
The uninstaller removes all installed files and related registry entries.
 
== Support ==
 
For help, contact:
 
* '''Cédric Thomas''' 
* E-mail: <code>[email protected]</code>


== Disclaimer ==
== Disclaimer ==
This driver relies entirely on the Deep Sky Chile API. Always use redundant safety systems in remote observatory operations. ```


### Next Step
This driver relies entirely on the '''Deep Sky Chile API''' for its data.
Would you like me to generate a summary email to Cédric Thomas notifying him that the documentation has been drafted?
 
Always use redundant safety systems in remote observatories. This driver is intended as an information source and must not be your only line of defence.
 
 
[[Category:User manuals]]

Latest revision as of 13:47, 4 December 2025

This page describes the Deep Sky Chile Observing Conditions ASCOM driver.

It exposes real-time weather and seeing data from the Deep Sky Chile site through the standard ASCOM ObservingConditions interface, so that automation software (N.I.N.A., Voyager, SGP, etc.) can use it for monitoring and safety decisions.

See also: Deep Sky Chile Safety Monitor (ASCOM driver)

Overview[edit]

The Deep Sky Chile Observing Conditions driver is an ASCOM-compliant driver that publishes:

  • Ambient and sky conditions (temperature, humidity, wind, rain…)
  • Seeing and sky quality
  • Cloud and rain status converted to standard ASCOM fields

It retrieves meteorological data from the Deep Sky Chile API and maps it to ASCOM ObservingConditions properties used by most automation software. This driver is intended for remote observatory automation, to help you make safe decisions about starting, stopping and continuing imaging sessions.

Features[edit]

Supported sensors

  • Temperature
  • Humidity
  • Dew point
  • Wind speed and wind gust
  • Seeing (star FWHM)
  • Sky quality (NSB)
  • Sky temperature
  • Cloud cover
  • Rain rate

Other key features

  • Periodic polling of the Deep Sky Chile weather API
  • Conversion of raw values into standard ASCOM properties
  • Stale-data protection with a configurable time multiplier
  • Optional detailed trace logging for troubleshooting

How it works[edit]

The driver periodically queries the Deep Sky Chile weather API (default endpoint):

On each poll it:

  1. Retrieves the JSON weather data over HTTP (TLS 1.2 secured)
  2. Extracts the relevant sensor values (temperature, humidity, seeing, etc.)
  3. Converts cloud and rain status into ASCOM-compatible percentage / rate values
  4. Verifies that the data is not stale (based on the configured multiplier)
  5. Exposes everything through the ASCOM ObservingConditions interface

Requirements[edit]

To use this driver you need:

  • A Windows PC
  • The ASCOM Platform 7.1 or later installed
  • An internet connection to reach the Deep Sky Chile API
  • Compatible client software (for example N.I.N.A., Voyager, SGP, …)

Installation[edit]

  1. Download and run the driver installer from your Deep Sky Chile customer area.
  2. The installer will:
    • Copy the driver files to your system
    • Register the COM driver with ASCOM
    • Add the required ASCOM profile entries

Once installed, the driver appears in the ASCOM chooser as Deep Sky Chile Observing Conditions (or similar).

Configuration[edit]

You configure the driver via its Setup dialog, accessible from any ASCOM-compatible application.

API URL endpoint

Polling interval (seconds)

  • Defines how often the driver queries the API.
  • Shorter intervals give fresher data but generate more network traffic.

Stale data multiplier

  • Protects against using old data.
  • If the last update is older than multiplier × polling interval, the driver can treat the data as stale.

Trace logging

  • When enabled, the driver writes a detailed log of its activity.

Trace logs are stored in:

  • Documents\ASCOM\Logs

Usage with automation software[edit]

A typical usage pattern:

  1. Open your automation software (for example N.I.N.A., Voyager, SGP).
  2. In the Weather (or equivalent) device selection:
    • Open the ASCOM chooser.
    • Select Deep Sky Chile Observing Conditions.
    • Click Properties (or Setup) to configure API URL, polling interval, etc.
    • Confirm and connect.

Once connected, your software can read:

  • Temperature, humidity, dew point
  • Wind speed and gusts
  • Cloud cover and rain rate
  • Seeing and sky quality
  • Sky temperature

These values can then be used to drive safety limits, session start/stop rules and observing plans.

Logging and troubleshooting[edit]

If you encounter issues:

  1. Enable trace logging in the Setup dialog.
  2. Reproduce the problem (for example connection error, missing data).
  3. Check the latest log files in:
    • Documents\ASCOM\Logs

Typical checks:

  • Is the API URL correct?
  • Is the polling interval reasonable (not too short or too long)?
  • Is the system time on the PC correct (for stale-data calculations)?

Uninstallation[edit]

To remove the driver:

  1. Open Windows Settings → Apps (or Control Panel → Programs and Features).
  2. Locate Deep Sky Chile Observing Conditions.
  3. Click Uninstall.

The uninstaller removes all installed files and related registry entries.

Support[edit]

For help, contact:

Disclaimer[edit]

This driver relies entirely on the Deep Sky Chile API for its data.

Always use redundant safety systems in remote observatories. This driver is intended as an information source and must not be your only line of defence.