ASCOM SafetyMonitor: Difference between revisions

From Deep Sky Chile
No edit summary
No edit summary
 
Line 134: Line 134:
Things to verify:
Things to verify:


* Can your PC reach the API URL in a web browser? 
* Is the correct observatory selected in the Setup dialog?   
* Is the correct observatory selected in the Setup dialog?   
* Is the polling interval reasonable?   
* Is the polling interval reasonable?   

Latest revision as of 13:48, 4 December 2025

This page describes the Deep Sky Chile Safety Monitor ASCOM driver.

It reads the roof state of a selected observatory via the Deep Sky Chile API and exposes it as the ASCOM SafetyMonitor property IsSafe.

See also: Deep Sky Chile Observing Conditions (ASCOM driver)

Overview[edit]

The Deep Sky Chile Safety Monitor is an ASCOM-compliant driver that exposes the safety status of Deep Sky Chile observatories.

It converts the roof state into the standard ASCOM IsSafe value:

  • Roof openIsSafe = True
  • Roof closedIsSafe = False

This driver is intended for remote observatory automation systems that rely on an ASCOM SafetyMonitor to decide whether it is safe to operate equipment.

Features[edit]

  • ASCOM SafetyMonitor implementation
  • Periodic polling of the Deep Sky Chile observatories API
  • Observatory selection via dropdown list
  • Roof-state-to-safety mapping
  • Stale-data protection
  • Optional trace logging
  • Configurable fail-safe mode

How it works[edit]

The driver periodically queries the API endpoint:

On each poll it:

  1. Retrieves the list of observatories from the API.
  2. Identifies the selected observatory (configured in the Setup dialog).
  3. Reads its roofState value (typically open or closed).
  4. Converts this into an ASCOM IsSafe boolean:
    • Roof open → safe
    • Roof closed → unsafe
  5. Applies stale-data protection logic.
  6. Exposes IsSafe to any ASCOM client application.

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
  • Client software that supports ASCOM SafetyMonitor devices (for example N.I.N.A., Voyager, etc.)

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
    • Create the necessary ASCOM profile entries

After installation, the driver appears in the ASCOM chooser as Deep Sky Chile Safety Monitor (or similar).

Configuration[edit]

Open the Setup dialog from any ASCOM-compatible application (via the ASCOM chooser → Properties / Setup).

You can configure:

API URL

Observatory selection

  • A dropdown list shows the available observatories returned by the API.
  • Select your observatory from the list. The roof state of the selected observatory will determine the value of IsSafe.

Polling interval

  • Defines how often the driver polls the API.
  • Choose a value that balances responsiveness with network load.

Stale-data multiplier

  • Protects against using outdated information.
  • If the data is older than multiplier × polling interval, it can be treated as stale.

Fail-safe mode

  • Defines the default IsSafe value if:
  • The API is unreachable, or
  • Data is stale or invalid.
  • Typical setting:
    • Fail-safe to unsafe (IsSafe = False) for maximum safety.

Trace logging

  • When enabled, the driver logs detailed operations and any errors.

Trace logs are stored in:

  • Documents\ASCOM\Logs

Usage with automation software[edit]

Example workflow with N.I.N.A. or similar software:

  1. Open the application.
  2. For the Safety Monitor (or equivalent) device:
    • Open the ASCOM chooser.
    • Select Deep Sky Chile Safety Monitor.
    • Click Properties / Setup to configure API URL, observatory, polling, etc.
    • Connect to the driver.

Once connected:

  • The application can read IsSafe from the driver.
  • Roof open → IsSafe = True → automation may start or continue imaging (depending on your rules).
  • Roof closed → IsSafe = False → automation can park the mount, close sessions, etc.

Always configure your automation software so that IsSafe = False triggers protective actions.

Logging and troubleshooting[edit]

If something does not work as expected:

  1. Enable trace logging in the Setup dialog.
  2. Reproduce the issue (connection error, wrong safety state, etc.).
  3. Check the log files in:
    • Documents\ASCOM\Logs

Things to verify:

  • Is the correct observatory selected in the Setup dialog?
  • Is the polling interval reasonable?
  • Is the fail-safe mode set to the desired behaviour if the API is down?

Uninstallation[edit]

To uninstall the driver:

  1. Open Windows Settings → Apps (or Control Panel → Programs and Features).
  2. Find Deep Sky Chile Safety Monitor in the list.
  3. Click Uninstall.

The uninstaller removes all related files and registry entries.

Support[edit]

For help, contact:

Disclaimer[edit]

This driver depends entirely on the Deep Sky Chile API for the roof and safety information.

It must not be your only safety measure. Always implement additional, independent safety systems (hardware interlocks, local weather sensors, etc.).