ASCOM ObservingConditions: Difference between revisions

From Deep Sky Chile
No edit summary
No edit summary
Line 1: Line 1:
====== Deep Sky Chile Observing Conditions Driver ======
====== Deep Sky Chile Observing Conditions (ASCOM Driver) ======


===== Description =====
===== Overview =====
[cite_start]The **Deep Sky Chile Observing Conditions** driver is an ASCOM-compliant driver that exposes weather and seeing data from the Deep Sky Chile site[cite: 1]. [cite_start]It retrieves real-time meteorological data from the Deep Sky Chile API and maps it to standard ASCOM ObservingConditions properties[cite: 2].
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.


[cite_start]This driver is intended for remote observatory automation systems (like N.I.N.A., Voyager, SGP) to monitor environmental conditions[cite: 3].
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.).


^ Attribute ^ Detail ^
This driver is designed for **remote observatory automation**, to help you monitor environmental conditions and make safe decisions about imaging sessions.
| **Version** | [cite_start]1.0.0 [cite: 1] |
| **Author** | [cite_start]Cédric Thomas [cite: 1] |
| **Compliance** | [cite_start]ASCOM ObservingConditions [cite: 1] |


===== Supported Sensors =====
===== Features =====
[cite_start]The driver supports the following sensors[cite: 3]:
Supported sensors include:
  * Temperature, Humidity, Dew Point
  * Wind Speed & Wind Gust
  * Seeing (StarFWHM)
  * Sky Quality (NSB)
  * Sky Temperature
  * Cloud Cover & Rain Rate


===== How it works =====
  * **Temperature**
[cite_start]The driver periodically queries the API (default: http://api.deepskychile.com/weather)[cite: 4].
  * **Humidity**
  * **Dew Point**
  * **Wind Speed** and **Wind Gust**
  * **Seeing** (Star FWHM)
  * **Sky Quality** (NSB)
  * **Sky Temperature**
  * **Cloud Cover**
  * **Rain Rate**


[cite_start]It then performs the following steps[cite: 5]:
Other key features:
   - Retrieves the JSON data via HTTP (TLS 1.2 secured)
 
   - Extracts sensor values (Temp, Hum, Seeing, etc.)
  * Periodic polling of the Deep Sky Chile weather API
   - Converts cloud/rain status into percentage/rate
  * Conversion of raw values into standard ASCOM properties
   - Supports stale data protection (configurable multiplier)
  * Stale data protection with a configurable time multiplier
   - Provides detailed trace logging
  * Optional detailed trace logging for troubleshooting
 
===== How it Works =====
The driver periodically queries the Deep Sky Chile weather API (default endpoint):
 
  * ''http://api.deepskychile.com/weather''
 
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 ''ObservingConditions'' interface
 
===== Requirements =====
To use this driver you need:
 
  * A Windows PC
  * The **ASCOM Platform** installed
  * An internet connection to reach the Deep Sky Chile API
  * Compatible client software (e.g. N.I.N.A., Voyager, SGP, …)
 
===== Installation =====
  - 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).


===== Configuration =====
===== Configuration =====
[cite_start]Open the driver’s Setup dialog from any ASCOM application[cite: 5].
You configure the driver via its **Setup** dialog, accessible from any ASCOM-compatible application:


[cite_start]You may configure the following[cite: 6]:
  * **API URL endpoint**
  * API URL Endpoint
    * Default: ''http://api.deepskychile.com/weather''
   * Polling interval (seconds)
    * Change this only if instructed by Deep Sky Chile.
   * Stale data multiplier
 
   * Trace logging (Enable/Disable)
   * **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 (enable/disable)**
    * When enabled, the driver writes a detailed log of its activity.


Trace logs are stored in:
Trace logs are stored in:
[cite_start]''Documents\ASCOM\Logs'' [cite: 6]


===== Installation =====
  * ''Documents\ASCOM\Logs''
Run the installer. [cite_start]It will[cite: 7]:
 
   * Copy driver files
===== Usage with Automation Software =====
   * Register the COM driver
Typical usage pattern:
   * Add ASCOM profile entries
 
  - Open your automation software (e.g. 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.
 
Once connected, your software will be able to read:
 
  * Temperature, humidity, dew point
  * 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.
 
===== Logging and Troubleshooting =====
If you encounter issues:
 
   - Enable **trace logging** in the Setup dialog.
  - Reproduce the problem (e.g. connection error, missing data).
  - 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/long)?
   * Is the system time on the PC correct (for stale data calculations)?


===== Uninstallation =====
===== Uninstallation =====
Use Windows Add/Remove Programs. [cite_start]The uninstaller removes all files and registry entries[cite: 8].
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 =====
===== Support =====
For help, contact:
For help, contact:
Cédric Thomas
 
[cite_start][email protected] [cite: 8]
  * **Cédric Thomas**
  * E-mail: ''[email protected]''


===== Disclaimer =====
===== Disclaimer =====
This driver relies entirely on the Deep Sky Chile API. [cite_start]**Always use redundant safety systems in remote observatory operations.** [cite: 9]
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.

Revision as of 13:28, 4 December 2025

Deep Sky Chile Observing Conditions (ASCOM Driver)
Overview

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

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

Features

Supported sensors include:

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

 * http://api.deepskychile.com/weather

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 ObservingConditions interface
Requirements

To use this driver you need:

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

Configuration

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

 * **API URL endpoint**
   * 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.
   * 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 (enable/disable)**
   * When enabled, the driver writes a detailed log of its activity.

Trace logs are stored in:

 * Documents\ASCOM\Logs
Usage with Automation Software

Typical usage pattern:

 - Open your automation software (e.g. 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.

Once connected, your software will be able to read:

 * Temperature, humidity, dew point
 * 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.

Logging and Troubleshooting

If you encounter issues:

 - Enable **trace logging** in the Setup dialog.
 - Reproduce the problem (e.g. connection error, missing data).
 - 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/long)?
 * Is the system time on the PC correct (for stale data calculations)?
Uninstallation

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: [email protected]
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 defense.