Editing ASCOM SafetyMonitor

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 <code>SafetyMonitor</code> property <code>IsSafe</code>.

See also: [[ASCOM_ObservingConditions|Deep Sky Chile Observing Conditions (ASCOM driver)]]

== Overview ==

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 <code>IsSafe</code> value:

* '''Roof open'''  → <code>IsSafe = True</code>  
* '''Roof closed''' → <code>IsSafe = False</code>  

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 ==

* ASCOM <code>SafetyMonitor</code> 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 ==

The driver periodically queries the API endpoint:

* <code>http://api.deepskychile.com/observatories</code>

On each poll it:

# Retrieves the list of observatories from the API.
# Identifies the '''selected observatory''' (configured in the Setup dialog).
# Reads its <code>roofState</code> value (typically <code>open</code> or <code>closed</code>).
# Converts this into an ASCOM <code>IsSafe</code> boolean:
#* Roof open → safe  
#* Roof closed → unsafe
# Applies stale-data protection logic.
# Exposes <code>IsSafe</code> to any ASCOM client application.

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

== 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
#* Create the necessary ASCOM profile entries

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

== Configuration ==

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

You can configure:

'''API URL'''

* Default: <code>http://api.deepskychile.com/observatories</code>  
* Change this only if instructed by Deep Sky Chile.

'''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 <code>IsSafe</code>.

'''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 <code>multiplier × polling interval</code>, it can be treated as stale.

'''Fail-safe mode'''

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

'''Trace logging'''

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

Trace logs are stored in:

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

== Usage with automation software ==

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

# Open the application.
# 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 <code>IsSafe</code> from the driver.  
* Roof open → <code>IsSafe = True</code> → automation may start or continue imaging (depending on your rules).  
* Roof closed → <code>IsSafe = False</code> → automation can park the mount, close sessions, etc.

Always configure your automation software so that '''<code>IsSafe = False</code> triggers protective actions'''.

== Logging and troubleshooting ==

If something does not work as expected:

# Enable '''trace logging''' in the Setup dialog.
# Reproduce the issue (connection error, wrong safety state, etc.).
# Check the log files in:
#* <code>Documents\ASCOM\Logs</code>

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 ==

To uninstall the driver:

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

The uninstaller removes all related files and registry entries.

== Support ==

For help, contact:

* '''Cédric Thomas'''  
* E-mail: <code>cedric@deepskychile.com</code>

== Disclaimer ==

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


[[Category:User manuals]]