ASCOM ObservingConditions: Difference between revisions

From Deep Sky Chile
No edit summary
No edit summary
Line 1: Line 1:
====== Deep Sky Chile Observing Conditions (ASCOM Driver) ======
This page describes the '''Deep Sky Chile Observing Conditions''' ASCOM driver.


===== Overview =====
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.
The **Deep Sky Chile Observing Conditions** driver is an ASCOM-compliant driver that exposes real-time weather and seeing data from the Deep Sky Chile site.


It retrieves meteorological data from the Deep Sky Chile API and maps it to the standard ASCOM ''ObservingConditions'' properties used by most automation software (N.I.N.A., Voyager, SGP, etc.).
See also: [[ASCOM_SafetyMonitor|Deep Sky Chile Safety Monitor (ASCOM driver)]]


This driver is designed for **remote observatory automation**, to help you monitor environmental conditions and make safe decisions about imaging sessions.
== Overview ==


===== Features =====
The '''Deep Sky Chile Observing Conditions''' driver is an ASCOM-compliant driver that publishes:
Supported sensors include:


  * **Temperature**
* Ambient and sky conditions (temperature, humidity, wind, rain…)
  * **Humidity**
* Seeing and sky quality
  * **Dew Point**
* Cloud and rain status converted to standard ASCOM fields
  * **Wind Speed** and **Wind Gust**
  * **Seeing** (Star FWHM)
  * **Sky Quality** (NSB)
  * **Sky Temperature**
  * **Cloud Cover**
  * **Rain Rate**


Other key features:
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.


  * Periodic polling of the Deep Sky Chile weather API
== Features ==
  * Conversion of raw values into standard ASCOM properties
 
  * Stale data protection with a configurable time multiplier
'''Supported sensors'''
  * Optional detailed trace logging for troubleshooting
 
* '''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 ==


===== How it Works =====
The driver periodically queries the Deep Sky Chile weather API (default endpoint):
The driver periodically queries the Deep Sky Chile weather API (default endpoint):


  * ''http://api.deepskychile.com/weather''
* <code>http://api.deepskychile.com/weather</code>


On each poll it:
On each poll it:


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


===== Requirements =====
To use this driver you need:
To use this driver you need:


  * A Windows PC
* A Windows PC
  * The **ASCOM Platform 7.1 or later** installed
* The '''ASCOM Platform 7.1 or later''' installed
  * An internet connection to reach the Deep Sky Chile API
* An internet connection to reach the Deep Sky Chile API
  * Compatible client software (e.g. N.I.N.A., Voyager, SGP, …)
* Compatible client software (for example N.I.N.A., Voyager, SGP, …)
 
== Installation ==
 
# 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 ==


===== Installation =====
You configure the driver via its '''Setup''' dialog, accessible from any ASCOM-compatible application.
  - Download and run the driver installer.
  - 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 will appear in the ASCOM chooser as **Deep Sky Chile Observing Conditions** (or similar).
'''API URL endpoint'''


===== Configuration =====
* Default: <code>http://api.deepskychile.com/weather</code> 
You configure the driver via its **Setup** dialog, accessible from any ASCOM-compatible application:
* Change this only if instructed by Deep Sky Chile.


  * **API URL endpoint**
'''Polling interval (seconds)'''
    * Default: ''http://api.deepskychile.com/weather''
    * Change this only if instructed by Deep Sky Chile.


  * **Polling interval (seconds)**
* Defines how often the driver queries the API.
    * Defines how often the driver queries the API.
* Shorter intervals give fresher data but generate more network traffic.
    * Shorter intervals give fresher data but generate more network traffic.


  * **Stale data multiplier**
'''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 (enable/disable)**
* Protects against using old data. 
    * When enabled, the driver writes a detailed log of its activity.
* 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:
Trace logs are stored in:


  * ''Documents\ASCOM\Logs''
* <code>Documents\ASCOM\Logs</code>


===== Usage with Automation Software =====
== Usage with automation software ==
Typical usage pattern:


  - Open your automation software (e.g. N.I.N.A., Voyager, SGP).
A typical usage pattern:
  - In the **Observing Conditions** (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 will be able to read:
# Open your automation software (for example N.I.N.A., Voyager, SGP).
# In the '''Observing Conditions''' (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.


  * Temperature, humidity, dew point
Once connected, your software can read:
  * Wind speed and gusts
  * Cloud cover, 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.
* 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 ==


===== Logging and Troubleshooting =====
If you encounter issues:
If you encounter issues:


  - Enable **trace logging** in the Setup dialog.
# Enable '''trace logging''' in the Setup dialog.
  - Reproduce the problem (e.g. connection error, missing data).
# Reproduce the problem (for example connection error, missing data).
  - Check the latest log files in:
# Check the latest log files in:
    * ''Documents\ASCOM\Logs''
#* <code>Documents\ASCOM\Logs</code>


Typical checks:
Typical checks:


  * Can the PC reach the API URL in a web browser?
* Can the PC reach the API URL in a web browser?
  * Is the API URL correct?
* Is the API URL correct?
  * Is the polling interval reasonable (not too short/long)?
* Is the polling interval reasonable (not too short or too long)?
  * Is the system time on the PC correct (for stale data calculations)?
* Is the system time on the PC correct (for stale-data calculations)?
 
== Uninstallation ==


===== Uninstallation =====
To remove the driver:
To remove the driver:


  - Open **Windows Settings** **Apps** (or **Control Panel** **Programs and Features**).
# Open '''Windows Settings → Apps''' (or '''Control Panel → Programs and Features''').
  - Locate **Deep Sky Chile Observing Conditions**.
# Locate '''Deep Sky Chile Observing Conditions'''.
  - Click **Uninstall**.
# Click '''Uninstall'''.


The uninstaller removes all installed files and related registry entries.
The uninstaller removes all installed files and related registry entries.


===== Support =====
== Support ==
 
For help, contact:
For help, contact:


  * **Cédric Thomas**
* '''Cédric Thomas''' 
  * E-mail: ''[email protected]''
* E-mail: <code>[email protected]</code>
 
== Disclaimer ==
 
This driver relies entirely on the '''Deep Sky Chile API''' for its data.


===== Disclaimer =====
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.
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 defense.


[[Category:User manuals]]
[[Category:User manuals]]

Revision as of 13:39, 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

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

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):

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

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

  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

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

A typical usage pattern:

  1. Open your automation software (for example N.I.N.A., Voyager, SGP).
  2. In the Observing Conditions (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

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:

  • Can the PC reach the API URL in a web browser?
  • 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

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

For help, contact:

Disclaimer

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.