ASCOM ObservingConditions: Difference between revisions

From Deep Sky Chile
No edit summary
No edit summary
Line 2: Line 2:


== Overview ==
== 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 <ref>[cite: 1]</ref>. [cite_start]It retrieves real-time meteorological data from the Deep Sky Chile API and maps it to standard ASCOM ObservingConditions properties <ref>[cite: 2]</ref>. [cite_start]This driver is intended for remote observatory automation systems (like N.I.N.A., Voyager, SGP) to monitor environmental conditions <ref>[cite: 3]</ref>.
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"
 
{| class="wikitable"
! Property
! Property
! Value
! Value
|-
|-
| '''Version'''
| '''Version'''
| [cite_start]1.0.0 <ref>[cite: 1]</ref>
| 1.0.0 |-
|-
| '''Author'''
| '''Author'''
| [cite_start]Cédric Thomas <ref>[cite: 1]</ref>
| Cédric Thomas |}
|}


== Supported Sensors ==
== Supported Sensors ==
[cite_start]The driver supports the following sensors <ref>[cite: 3]</ref>:
The driver supports the following sensors: * Temperature, Humidity, Dew Point
* Temperature, Humidity, Dew Point
* Wind Speed & Wind Gust
* Wind Speed & Wind Gust
* Seeing (StarFWHM)
* Seeing (StarFWHM)
Line 24: Line 19:
* Cloud Cover & Rain Rate
* Cloud Cover & Rain Rate


== How it works ==
== Operation Logic ==
[cite_start]The driver periodically queries the API (default: <code>http://api.deepskychile.com/weather</code>) <ref>[cite: 4]</ref>.
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




Line 31: Line 30:
[Image of API data flow diagram]
[Image of API data flow diagram]


[cite_start]It performs the following logic <ref>[cite: 5]</ref>:
# 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.


== Configuration ==
== Configuration ==
[cite_start]Configuration is handled via the driver’s Setup dialog from any ASCOM application <ref>[cite: 5]</ref>.
Open the driver’s Setup dialog from any ASCOM application to configure the following: * API URL Endpoint
 
=== Settings ===
[cite_start]You may configure the following parameters <ref>[cite: 6]</ref>:
* API URL Endpoint
* Polling interval (seconds)
* Polling interval (seconds)
* Stale data multiplier
* Stale data multiplier
Line 50: Line 38:


=== Logging ===
=== Logging ===
[cite_start]Trace logs are stored in <ref>[cite: 6]</ref>:
Trace logs are stored in: : <code>Documents\ASCOM\Logs</code>
: <code>Documents\ASCOM\Logs</code>


== Installation and Uninstallation ==
== Installation ==
; Installation
Run the installer to: * Copy driver files
[cite_start]Run the installer to copy driver files, register the COM driver, and add ASCOM profile entries <ref>[cite: 7]</ref>.
* Register the COM driver
* Add ASCOM profile entries


; Uninstallation
== Uninstallation ==
Use Windows Add/Remove Programs. [cite_start]The uninstaller removes all files and registry entries <ref>[cite: 8]</ref>.
Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support ==
For help, contact: : Cédric Thomas (cedric@deepskychile.com)


== Disclaimer ==
== Disclaimer ==
This driver relies entirely on the Deep Sky Chile API. [cite_start]Always use redundant safety systems in remote observatory operations <ref>[cite: 9]</ref>.
This driver relies entirely on the Deep Sky Chile API. Always use redundant safety systems in remote observatory operations. ```
 
***
 
### Page 2: Deep Sky Chile Safety Monitor Driver
 
```mediawiki
= Deep Sky Chile Safety Monitor =
 
== Overview ==
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"
! Property
! Value
|-
| '''Version'''
| 1.2.0 |-
| '''Author'''
| Cédric Thomas |}
 
== Safety Logic ==
The driver maps the roof state to the ASCOM safety status: * '''Roof open''' → Safe = True
* '''Roof closed''' → Safe = False
 
== Operation Logic ==
The driver periodically queries the API at: : <code>http://api.deepskychile.com/observatories</code>
 
It then performs the following steps: # Identifies the selected observatory
# Reads its roofState
# Converts this into ASCOM IsSafe
# Supports stale data protection
# Provides optional trace logging
 
== Configuration ==
Open the driver’s Setup dialog from any ASCOM application to configure: * API URL
* Observatory selection (dropdown list)
* Polling interval
* Stale data multiplier
* Fail-safe mode
* Trace logging
 
=== Logging ===
Trace logs are stored in: : <code>Documents\ASCOM\Logs</code>
 
== Installation ==
Run the installer to: * Copy driver files
* Register the COM driver
* Add ASCOM profile entries


== Support ==
== Uninstallation ==
[cite_start]For help, contact Cédric Thomas at <code>[email protected]</code> <ref>[cite: 8]</ref>.
Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support ==
For help, contact: : Cédric Thomas ([email protected])
 
== Disclaimer ==
This driver relies entirely on the Deep Sky Chile API. Always use redundant safety systems in remote observatory operations. ```


== References ==
### Next Step
<references />
Would you like me to generate a summary email to Cédric Thomas notifying him that the documentation has been drafted?

Revision as of 13:24, 4 December 2025

Deep Sky Chile Observing Conditions Driver

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 driver supports the following sensors: * Temperature, Humidity, Dew Point

  • Wind Speed & Wind Gust
  • Seeing (StarFWHM)
  • Sky Quality (NSB)
  • Sky Temperature
  • Cloud Cover & Rain Rate

Operation Logic

The driver periodically queries the API (default: http://api.deepskychile.com/weather). It then performs the following operations: # Retrieves the JSON data via HTTP (TLS 1.2 secured)

  1. Extracts sensor values (Temp, Hum, Seeing, etc.)
  2. Converts cloud/rain status into percentage/rate
  3. Supports stale data protection (configurable multiplier)
  4. Provides detailed trace logging


[Image of API data flow diagram]


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

Trace logs are stored in: : Documents\ASCOM\Logs

Installation

Run the installer to: * Copy driver files

  • Register the COM driver
  • Add ASCOM profile entries

Uninstallation

Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support == For help, contact: : Cédric Thomas ([email protected])

Disclaimer

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

      1. Page 2: Deep Sky Chile Safety Monitor Driver

```mediawiki

Deep Sky Chile Safety Monitor

Overview

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" ! Property ! Value |- | Version | 1.2.0 |- | Author | Cédric Thomas |}

Safety Logic

The driver maps the roof state to the ASCOM safety status: * Roof open → Safe = True

  • Roof closed → Safe = False

Operation Logic

The driver periodically queries the API at: : http://api.deepskychile.com/observatories

It then performs the following steps: # Identifies the selected observatory

  1. Reads its roofState
  2. Converts this into ASCOM IsSafe
  3. Supports stale data protection
  4. Provides optional trace logging

Configuration

Open the driver’s Setup dialog from any ASCOM application to configure: * API URL

  • Observatory selection (dropdown list)
  • Polling interval
  • Stale data multiplier
  • Fail-safe mode
  • Trace logging

Logging

Trace logs are stored in: : Documents\ASCOM\Logs

Installation

Run the installer to: * Copy driver files

  • Register the COM driver
  • Add ASCOM profile entries

Uninstallation

Use Windows Add/Remove Programs. The uninstaller removes all files and registry entries. == Support == For help, contact: : Cédric Thomas ([email protected])

Disclaimer

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

      1. Next Step

Would you like me to generate a summary email to Cédric Thomas notifying him that the documentation has been drafted?